From 21badd069d202afc9161c9aa376a22b24eac9960 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Thu, 3 Oct 2024 07:48:54 +0000 Subject: [PATCH] chore(docs): Updated API Reference (v2) (#9437) 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> --- .../redocly/redocly-config.yaml | 24 + .../Bash/auth_user_{auth_provider}/post.sh | 1 + .../post.sh | 1 + .../post.sh | 2 + .../Shell/admin_shipping-options_{id}/get.sh | 2 + .../Shell/auth_user_{auth_provider}/post.sh | 7 +- .../post.sh | 2 +- ...ethod.yaml => AdminApplicationMethod.yaml} | 91 +- .../components/schemas/AdminArchiveOrder.yaml | 10 - .../admin/components/schemas/AdminClaim.yaml | 225 +- .../schemas/AdminClaimPreviewResponse.yaml | 2 +- .../schemas/AdminClaimRequestResponse.yaml | 2 +- .../AdminClaimReturnPreviewResponse.yaml | 2 +- .../schemas/AdminCreateFulfillment.yaml | 11 +- .../schemas/AdminCreatePriceList.yaml | 2 +- .../schemas/AdminCreateProductType.yaml | 13 + .../schemas/AdminCreateProductVariant.yaml | 5 + ...AdminCreateProductVariantInventoryKit.yaml | 20 + .../AdminCreateProductVariantPrice.yaml | 7 + .../schemas/AdminCreatePromotionRule.yaml | 6 +- .../schemas/AdminCreateReturnReason.yaml} | 8 +- .../schemas/AdminCreateShippingOption.yaml | 96 +- .../schemas/AdminCreateTaxRate.yaml | 1 + .../schemas/AdminCreateTaxRegion.yaml | 1 + .../AdminCreateVariantInventoryItem.yaml | 2 +- .../components/schemas/AdminCurrency.yaml | 1 - .../components/schemas/AdminCustomer.yaml | 4 +- .../schemas/AdminCustomerGroup.yaml | 4 +- .../schemas/AdminCustomerGroupResponse.yaml | 2 +- .../schemas/AdminCustomerResponse.yaml | 2 +- .../components/schemas/AdminExchange.yaml | 223 +- .../schemas/AdminExchangePreviewResponse.yaml | 2 +- .../schemas/AdminExchangeRequestResponse.yaml | 4 +- .../schemas/AdminExchangeReturnResponse.yaml | 2 +- .../components/schemas/AdminFulfillment.yaml | 2 - .../schemas/AdminFulfillmentProvider.yaml | 14 +- .../schemas/AdminFulfillmentSet.yaml | 16 +- .../schemas/AdminFulfillmentSetResponse.yaml | 2 +- .../components/schemas/AdminGeoZone.yaml | 8 +- .../schemas/AdminImportProductRequest.yaml | 7 +- .../schemas/AdminInventoryItem.yaml | 16 +- .../schemas/AdminInventoryLevel.yaml | 59 +- .../admin/components/schemas/AdminOrder.yaml | 19 +- .../components/schemas/AdminOrderChange.yaml | 142 + .../schemas/AdminOrderChangeAction.yaml | 104 + .../schemas/AdminOrderChangesResponse.yaml | 2 +- .../AdminOrderEditPreviewResponse.yaml | 2 +- .../schemas/AdminOrderEditResponse.yaml | 2 +- .../schemas/AdminOrderFulfillment.yaml | 79 + .../schemas/AdminOrderLineItem.yaml | 213 + .../components/schemas/AdminOrderPreview.yaml | 19 +- .../schemas/AdminOrderShippingMethod.yaml | 116 + .../components/schemas/AdminPayment.yaml | 6 +- .../schemas/AdminPaymentCollection.yaml | 8 +- .../schemas/AdminPaymentSession.yaml | 61 + .../components/schemas/AdminProduct.yaml | 13 +- .../components/schemas/AdminProductImage.yaml | 33 + .../schemas/AdminProductOption.yaml | 16 +- .../AdminProductOptionDeleteResponse.yaml | 7 +- .../schemas/AdminProductOptionResponse.yaml | 2 +- .../schemas/AdminProductOptionValue.yaml | 39 + .../schemas/AdminProductResponse.yaml | 2 +- .../components/schemas/AdminProductTag.yaml | 10 +- .../AdminProductTagDeleteResponse.yaml | 4 +- .../schemas/AdminProductTagListResponse.yaml | 10 +- .../schemas/AdminProductTagResponse.yaml | 2 +- .../components/schemas/AdminProductType.yaml | 10 +- .../AdminProductTypeDeleteResponse.yaml | 4 +- .../schemas/AdminProductTypeListResponse.yaml | 10 +- .../schemas/AdminProductTypeResponse.yaml | 2 +- .../schemas/AdminProductVariant.yaml | 62 +- .../AdminProductVariantDeleteResponse.yaml | 7 +- ...nProductVariantInventoryBatchResponse.yaml | 46 +- .../AdminProductVariantInventoryLink.yaml | 18 +- ...uctVariantInventoryLinkDeleteResponse.yaml | 7 +- .../schemas/AdminProductVariantParams.yaml | 872 - .../schemas/AdminProductVariantResponse.yaml | 2 +- .../components/schemas/AdminPromotion.yaml | 21 +- .../schemas/AdminPromotionResponse.yaml | 2 +- .../schemas/AdminPromotionRule.yaml | 15 +- .../admin/components/schemas/AdminRefund.yaml | 38 + .../components/schemas/AdminRefundReason.yaml | 6 +- .../admin/components/schemas/AdminRegion.yaml | 13 +- .../schemas/AdminRegionCountry.yaml | 32 +- .../schemas/AdminRegionResponse.yaml | 2 +- .../components/schemas/AdminReservation.yaml | 22 +- .../schemas/AdminReservationResponse.yaml | 2 +- .../admin/components/schemas/AdminReturn.yaml | 59 +- .../components/schemas/AdminReturnItem.yaml | 20 +- .../schemas/AdminReturnPreviewResponse.yaml | 2 +- .../components/schemas/AdminReturnReason.yaml | 6 +- .../AdminReturnReasonDeleteResponse.yaml | 4 +- .../AdminReturnReasonListResponse.yaml | 10 +- .../schemas/AdminReturnReasonResponse.yaml | 2 +- .../schemas/AdminReturnResponse.yaml | 2 +- .../components/schemas/AdminRevokeApiKey.yaml | 6 +- .../schemas/AdminRuleAttributeOption.yaml | 26 +- .../schemas/AdminRuleValueOption.yaml | 13 +- .../components/schemas/AdminSalesChannel.yaml | 12 +- .../AdminSalesChannelDeleteResponse.yaml | 4 +- .../schemas/AdminSalesChannelResponse.yaml | 2 +- .../components/schemas/AdminServiceZone.yaml | 2 +- .../AdminServiceZoneDeleteResponse.yaml | 7 +- .../schemas/AdminServiceZoneResponse.yaml | 2 +- .../schemas/AdminShippingOption.yaml | 104 +- .../AdminShippingOptionDeleteResponse.yaml | 4 +- .../schemas/AdminShippingOptionPrice.yaml | 76 + .../schemas/AdminShippingOptionPriceRule.yaml | 15 + .../schemas/AdminShippingOptionResponse.yaml | 2 +- .../schemas/AdminShippingOptionRule.yaml | 26 +- .../schemas/AdminShippingOptionType.yaml | 48 + .../schemas/AdminShippingProfile.yaml | 41 +- .../AdminShippingProfileDeleteResponse.yaml | 4 +- .../schemas/AdminShippingProfileResponse.yaml | 2 +- .../schemas/AdminStockLocation.yaml | 10 +- .../schemas/AdminStockLocationAddress.yaml | 50 +- .../AdminStockLocationDeleteResponse.yaml | 4 +- .../AdminStockLocationListResponse.yaml | 10 +- .../schemas/AdminStockLocationResponse.yaml | 2 +- .../admin/components/schemas/AdminStore.yaml | 12 +- .../schemas/AdminStoreCurrency.yaml | 17 +- .../schemas/AdminStoreListResponse.yaml | 10 +- .../schemas/AdminStoreResponse.yaml | 2 +- .../components/schemas/AdminTaxRate.yaml | 32 +- .../schemas/AdminTaxRateDeleteResponse.yaml | 4 +- .../schemas/AdminTaxRateResponse.yaml | 2 +- .../components/schemas/AdminTaxRateRule.yaml | 8 +- .../components/schemas/AdminTaxRegion.yaml | 47 +- .../schemas/AdminTaxRegionDeleteResponse.yaml | 4 +- .../schemas/AdminTaxRegionResponse.yaml | 2 +- .../components/schemas/AdminUpdateApiKey.yaml | 4 +- .../schemas/AdminUpdateCollection.yaml | 4 +- .../schemas/AdminUpdateCustomerGroup.yaml | 4 +- .../schemas/AdminUpdatePriceList.yaml | 9 +- .../schemas/AdminUpdatePricePreference.yaml | 6 +- .../schemas/AdminUpdateProduct.yaml | 227 +- .../schemas/AdminUpdateProductOption.yaml | 8 +- .../schemas/AdminUpdateProductVariant.yaml | 42 +- .../schemas/AdminUpdatePromotionRule.yaml | 49 + .../schemas/AdminUpdateReturnReason.yaml} | 13 +- .../schemas/AdminUpdateSalesChannel.yaml | 6 +- .../AdminUpdateShippingOptionRule.yaml | 43 + .../schemas/AdminUpdateStockLocation.yaml | 17 +- .../components/schemas/AdminUpdateStore.yaml | 19 +- .../schemas/AdminUpdateTaxRate.yaml | 23 +- .../components/schemas/AdminUpdateUser.yaml | 4 +- .../AdminUpdateVariantInventoryItem.yaml | 10 +- .../AdminUpsertStockLocationAddress.yaml | 7 +- .../admin/components/schemas/AdminUser.yaml | 10 +- .../schemas/AdminUserDeleteResponse.yaml | 4 +- .../schemas/AdminUserListResponse.yaml | 10 +- .../components/schemas/AdminUserResponse.yaml | 2 +- .../schemas/AdminWorkflowExecution.yaml | 12 +- .../AdminWorkflowExecutionExecution.yaml | 147 +- .../AdminWorkflowExecutionResponse.yaml | 2 +- .../components/schemas/ApiKeyResponse.yaml | 26 +- .../schemas/AuthCallbackResponse.yaml | 2 +- .../schemas/BaseApplicationMethod.yaml | 61 - .../schemas/BaseCalculatedPriceSet.yaml | 80 +- .../admin/components/schemas/BaseCapture.yaml | 27 +- .../admin/components/schemas/BaseCart.yaml | 170 + .../components/schemas/BaseCartAddress.yaml | 68 +- .../components/schemas/BaseCartLineItem.yaml | 200 +- .../schemas/BaseCartShippingMethod.yaml | 153 +- .../admin/components/schemas/BaseClaim.yaml | 3 - .../components/schemas/BaseClaimItem.yaml | 31 +- .../components/schemas/BaseCollection.yaml | 2 +- .../components/schemas/BaseCustomer.yaml | 73 - .../schemas/BaseCustomerAddress.yaml | 96 +- .../components/schemas/BaseExchangeItem.yaml | 18 +- .../schemas/BaseFulfillmentProvider.yaml | 4 +- .../schemas/BaseLineItemAdjustment.yaml | 55 +- .../schemas/BaseLineItemTaxLine.yaml | 61 +- .../admin/components/schemas/BaseOrder.yaml | 237 +- .../components/schemas/BaseOrderAddress.yaml | 35 +- .../components/schemas/BaseOrderChange.yaml | 146 - .../schemas/BaseOrderChangeAction.yaml | 82 + .../schemas/BaseOrderFulfillment.yaml | 27 +- .../schemas/BaseOrderItemDetail.yaml | 76 + .../components/schemas/BaseOrderLineItem.yaml | 54 +- .../schemas/BaseOrderLineItemAdjustment.yaml | 55 +- .../schemas/BaseOrderLineItemTaxLine.yaml | 59 + .../schemas/BaseOrderShippingDetail.yaml | 42 + .../schemas/BaseOrderShippingMethod.yaml | 135 +- .../BaseOrderShippingMethodAdjustment.yaml | 53 + .../BaseOrderShippingMethodTaxLine.yaml | 61 +- .../components/schemas/BaseOrderSummary.yaml | 47 +- .../schemas/BaseOrderTransaction.yaml | 21 +- .../admin/components/schemas/BasePayment.yaml | 92 +- .../schemas/BasePaymentCollection.yaml | 82 +- .../schemas/BasePaymentProvider.yaml | 7 + .../schemas/BasePaymentSession.yaml | 60 +- .../admin/components/schemas/BaseProduct.yaml | 2 +- .../components/schemas/BaseProductImage.yaml | 32 +- .../components/schemas/BaseProductOption.yaml | 43 +- .../schemas/BaseProductOptionValue.yaml | 18 +- .../schemas/BaseProductVariant.yaml | 131 +- .../schemas/BasePromotionRuleValue.yaml | 4 +- .../admin/components/schemas/BaseRefund.yaml | 37 +- .../admin/components/schemas/BaseRegion.yaml | 2 +- .../components/schemas/BaseRegionCountry.yaml | 32 +- .../components/schemas/BaseReturnItem.yaml | 3 - .../schemas/BaseRuleOperatorOptions.yaml | 5 +- .../schemas/BaseShippingMethodAdjustment.yaml | 55 +- .../schemas/BaseShippingMethodTaxLine.yaml | 61 +- .../components/schemas/CreateAddress.yaml | 27 +- .../components/schemas/CreateCartAddress.yaml | 47 - .../schemas/CreateCartCreateLineItem.yaml | 97 - .../schemas/CreateCartWorkflowInput.yaml | 60 - .../CustomerGroupInCustomerFilters.yaml | 26 +- .../specs/admin/components/schemas/File.yaml | 45 - .../admin/components/schemas/FileList.yaml | 18 - .../components/schemas/InventoryLevel.yaml | 8 +- .../specs/admin/components/schemas/Order.yaml | 295 +- .../components/schemas/OrderAddress.yaml | 33 +- .../admin/components/schemas/OrderChange.yaml | 89 +- .../components/schemas/OrderChangeAction.yaml | 99 +- .../admin/components/schemas/OrderClaim.yaml | 254 + .../components/schemas/OrderExchange.yaml | 260 + .../admin/components/schemas/OrderItem.yaml | 105 +- .../components/schemas/OrderLineItem.yaml | 435 + .../schemas/OrderLineItemAdjustment.yaml | 55 +- .../schemas/OrderLineItemTaxLine.yaml | 69 +- .../components/schemas/OrderPreview.yaml | 1550 -- .../components/schemas/OrderReturnItem.yaml | 50 + .../schemas/OrderShippingMethod.yaml | 246 + .../OrderShippingMethodAdjustment.yaml | 55 +- .../schemas/OrderShippingMethodTaxLine.yaml | 69 +- .../components/schemas/OrderTransaction.yaml | 48 +- .../components/schemas/RefundReason.yaml | 35 + .../schemas/RefundReasonResponse.yaml | 2 +- .../schemas/ReservationResponse.yaml | 66 - .../admin/components/schemas/Return.yaml | 298 +- .../schemas/StoreAddCartLineItem.yaml | 8 +- .../schemas/StoreCalculateCartTaxes.yaml | 8 - .../admin/components/schemas/StoreCart.yaml | 350 +- .../components/schemas/StoreCartAddress.yaml | 53 +- .../components/schemas/StoreCartLineItem.yaml | 404 +- .../components/schemas/StoreCartResponse.yaml | 2 +- .../schemas/StoreCartShippingMethod.yaml | 253 + .../components/schemas/StoreCollection.yaml | 14 +- .../schemas/StoreCollectionResponse.yaml | 2 +- .../components/schemas/StoreCreateCart.yaml | 20 +- .../schemas/StoreCreateCustomer.yaml | 4 +- .../schemas/StoreCreatePaymentCollection.yaml | 4 +- .../components/schemas/StoreCreateReturn.yaml | 10 +- .../schemas/StoreCreateReturnItem.yaml | 6 +- .../schemas/StoreCreateReturnShipping.yaml | 6 +- .../components/schemas/StoreCurrency.yaml | 23 +- .../schemas/StoreCurrencyListResponse.yaml | 10 +- .../schemas/StoreCurrencyResponse.yaml | 2 +- .../components/schemas/StoreCustomer.yaml | 48 +- .../schemas/StoreCustomerAddress.yaml | 21 +- .../StoreCustomerAddressListResponse.yaml | 10 +- .../schemas/StoreCustomerAddressResponse.yaml | 2 +- .../schemas/StoreCustomerResponse.yaml | 2 +- .../admin/components/schemas/StoreOrder.yaml | 64 +- .../schemas/StoreOrderResponse.yaml | 2 +- .../schemas/StorePaymentCollection.yaml | 86 +- .../StorePaymentCollectionResponse.yaml | 2 +- .../schemas/StorePaymentProvider.yaml | 2 +- .../schemas/StorePaymentSession.yaml | 61 + .../components/schemas/StoreProduct.yaml | 44 +- .../schemas/StoreProductCategory.yaml | 28 +- .../StoreProductCategoryListResponse.yaml | 10 +- .../schemas/StoreProductCategoryResponse.yaml | 2 +- .../components/schemas/StoreProductImage.yaml | 33 + .../schemas/StoreProductOption.yaml | 44 + .../schemas/StoreProductOptionValue.yaml | 39 + .../schemas/StoreProductResponse.yaml | 2 +- .../components/schemas/StoreProductTag.yaml | 35 + .../schemas/StoreProductVariant.yaml | 140 + .../schemas/StoreProductVariantParams.yaml | 76 - .../admin/components/schemas/StoreRegion.yaml | 11 +- .../schemas/StoreRegionCountry.yaml | 32 + .../admin/components/schemas/StoreReturn.yaml | 37 +- .../components/schemas/StoreReturnItem.yaml | 46 + .../components/schemas/StoreReturnReason.yaml | 6 +- .../schemas/StoreReturnReasonResponse.yaml | 2 +- .../schemas/StoreReturnResponse.yaml | 2 +- .../schemas/StoreShippingOption.yaml | 26 +- .../StoreShippingOptionListResponse.yaml | 2 +- .../schemas/StoreShippingOptionType.yaml | 48 + .../schemas/StoreUpdateCartLineItem.yaml | 6 +- .../schemas/StoreUpdateCustomer.yaml | 2 +- .../components/schemas/UpdateAddress.yaml | 29 +- .../components/schemas/UpdateCartData.yaml | 21 +- .../schemas/WorkflowExecutionContext.yaml | 42 +- .../specs/admin/openapi.full.yaml | 15311 +++++++++------- .../api-reference/specs/admin/openapi.yaml | 3 + .../specs/admin/paths/admin_api-keys.yaml | 8 + .../admin/paths/admin_api-keys_{id}.yaml | 6 +- .../paths/admin_api-keys_{id}_revoke.yaml | 2 + .../admin_api-keys_{id}_sales-channels.yaml | 2 + .../specs/admin/paths/admin_campaigns.yaml | 8 + .../admin/paths/admin_campaigns_{id}.yaml | 6 +- .../admin_campaigns_{id}_promotions.yaml | 2 + .../specs/admin/paths/admin_claims.yaml | 8 + .../specs/admin/paths/admin_claims_{id}.yaml | 2 + .../paths/admin_claims_{id}_claim-items.yaml | 2 + ...n_claims_{id}_claim-items_{action_id}.yaml | 4 + ...}_inbound_shipping-method_{action_id}.yaml | 2 + .../admin_claims_{id}_outbound_items.yaml | 2 + ...laims_{id}_outbound_items_{action_id}.yaml | 4 + ..._claims_{id}_outbound_shipping-method.yaml | 2 + ..._outbound_shipping-method_{action_id}.yaml | 4 + .../paths/admin_claims_{id}_request.yaml | 6 +- .../specs/admin/paths/admin_collections.yaml | 8 + .../admin/paths/admin_collections_{id}.yaml | 4 + .../admin_collections_{id}_products.yaml | 2 + .../specs/admin/paths/admin_currencies.yaml | 6 + .../admin/paths/admin_currencies_{code}.yaml | 2 + .../admin/paths/admin_customer-groups.yaml | 22 +- .../paths/admin_customer-groups_{id}.yaml | 6 +- .../admin_customer-groups_{id}_customers.yaml | 2 + .../specs/admin/paths/admin_customers.yaml | 8 + .../admin/paths/admin_customers_{id}.yaml | 8 +- .../paths/admin_customers_{id}_addresses.yaml | 8 + ...customers_{id}_addresses_{address_id}.yaml | 12 +- .../specs/admin/paths/admin_draft-orders.yaml | 20 +- .../specs/admin/paths/admin_exchanges.yaml | 25 +- .../admin/paths/admin_exchanges_{id}.yaml | 2 + ...hanges_{id}_inbound_items_{action_id}.yaml | 26 - ...}_inbound_shipping-method_{action_id}.yaml | 2 + .../admin_exchanges_{id}_outbound_items.yaml | 2 + ...anges_{id}_outbound_items_{action_id}.yaml | 4 + ...changes_{id}_outbound_shipping-method.yaml | 2 + ..._outbound_shipping-method_{action_id}.yaml | 4 + .../paths/admin_exchanges_{id}_request.yaml | 6 +- .../paths/admin_fulfillment-providers.yaml | 6 + ...n_fulfillment-sets_{id}_service-zones.yaml | 2 + ...ent-sets_{id}_service-zones_{zone_id}.yaml | 4 + .../specs/admin/paths/admin_fulfillments.yaml | 2 + .../paths/admin_fulfillments_{id}_cancel.yaml | 2 + .../admin_fulfillments_{id}_shipment.yaml | 2 + .../admin/paths/admin_inventory-items.yaml | 20 +- .../paths/admin_inventory-items_{id}.yaml | 6 +- ..._inventory-items_{id}_location-levels.yaml | 20 +- ...ms_{id}_location-levels_{location_id}.yaml | 10 +- .../specs/admin/paths/admin_invites.yaml | 8 + .../specs/admin/paths/admin_invites_{id}.yaml | 4 +- .../paths/admin_invites_{id}_resend.yaml | 6 +- .../admin/paths/admin_notifications.yaml | 6 + .../admin/paths/admin_notifications_{id}.yaml | 2 + .../admin/paths/admin_order-edits_{id}.yaml | 2 +- .../specs/admin/paths/admin_orders.yaml | 6 + .../specs/admin/paths/admin_orders_{id}.yaml | 8 +- .../paths/admin_orders_{id}_archive.yaml | 7 +- .../admin/paths/admin_orders_{id}_cancel.yaml | 6 +- .../paths/admin_orders_{id}_complete.yaml | 2 + .../paths/admin_orders_{id}_fulfillments.yaml | 2 + ..._fulfillments_{fulfillment_id}_cancel.yaml | 2 + ...ts_{fulfillment_id}_mark-as-delivered.yaml | 79 + ...lfillments_{fulfillment_id}_shipments.yaml | 2 + .../paths/admin_payment-collections.yaml | 2 + ...payment-collections_{id}_mark-as-paid.yaml | 2 + .../specs/admin/paths/admin_payments.yaml | 6 + .../admin_payments_payment-providers.yaml | 6 + .../admin/paths/admin_payments_{id}.yaml | 2 + .../paths/admin_payments_{id}_capture.yaml | 2 + .../paths/admin_payments_{id}_refund.yaml | 2 + .../specs/admin/paths/admin_price-lists.yaml | 8 + .../admin/paths/admin_price-lists_{id}.yaml | 4 + .../admin_price-lists_{id}_prices_batch.yaml | 2 +- .../admin_price-lists_{id}_products.yaml | 2 + .../admin/paths/admin_price-preferences.yaml | 8 + .../paths/admin_price-preferences_{id}.yaml | 4 + .../admin/paths/admin_product-categories.yaml | 8 + .../paths/admin_product-categories_{id}.yaml | 4 + ...dmin_product-categories_{id}_products.yaml | 2 + .../specs/admin/paths/admin_product-tags.yaml | 8 + .../admin/paths/admin_product-tags_{id}.yaml | 4 + .../admin/paths/admin_product-types.yaml | 10 +- .../admin/paths/admin_product-types_{id}.yaml | 4 + .../admin/paths/admin_product-variants.yaml | 18 +- .../specs/admin/paths/admin_products.yaml | 522 + .../admin/paths/admin_products_batch.yaml | 2 + .../admin/paths/admin_products_export.yaml | 2 + .../admin/paths/admin_products_{id}.yaml | 4 + .../paths/admin_products_{id}_options.yaml | 8 + ...min_products_{id}_options_{option_id}.yaml | 6 + .../paths/admin_products_{id}_variants.yaml | 8 + .../admin_products_{id}_variants_batch.yaml | 2 + ...s_{id}_variants_inventory-items_batch.yaml | 10 +- ...n_products_{id}_variants_{variant_id}.yaml | 6 + ...variants_{variant_id}_inventory-items.yaml | 2 + ...}_inventory-items_{inventory_item_id}.yaml | 4 + .../specs/admin/paths/admin_promotions.yaml | 8 + ...ns_rule-attribute-options_{rule_type}.yaml | 13 +- ...tions_{rule_type}_{rule_attribute_id}.yaml | 4 + .../admin/paths/admin_promotions_{id}.yaml | 6 +- ...admin_promotions_{id}_buy-rules_batch.yaml | 97 +- .../admin_promotions_{id}_rules_batch.yaml | 97 +- ...in_promotions_{id}_target-rules_batch.yaml | 99 +- .../admin_promotions_{id}_{rule_type}.yaml | 2 + .../admin/paths/admin_refund-reasons.yaml | 20 +- .../paths/admin_refund-reasons_{id}.yaml | 6 +- .../specs/admin/paths/admin_regions.yaml | 8 + .../specs/admin/paths/admin_regions_{id}.yaml | 6 +- .../specs/admin/paths/admin_reservations.yaml | 12 +- .../admin/paths/admin_reservations_{id}.yaml | 6 +- .../admin/paths/admin_return-reasons.yaml | 10 +- .../paths/admin_return-reasons_{id}.yaml | 6 +- .../specs/admin/paths/admin_returns.yaml | 20 +- .../specs/admin/paths/admin_returns_{id}.yaml | 4 + .../admin_returns_{id}_dismiss-items.yaml | 2 + ...eturns_{id}_dismiss-items_{action_id}.yaml | 4 + .../admin_returns_{id}_receive-items.yaml | 2 + ...eturns_{id}_receive-items_{action_id}.yaml | 4 + .../paths/admin_returns_{id}_receive.yaml | 4 +- .../admin_returns_{id}_receive_confirm.yaml | 2 + .../admin_returns_{id}_request-items.yaml | 2 + ...eturns_{id}_request-items_{action_id}.yaml | 4 + .../paths/admin_returns_{id}_request.yaml | 4 +- .../admin_returns_{id}_shipping-method.yaml | 2 + ...urns_{id}_shipping-method_{action_id}.yaml | 4 + .../admin/paths/admin_sales-channels.yaml | 8 + .../paths/admin_sales-channels_{id}.yaml | 4 + .../admin_sales-channels_{id}_products.yaml | 2 + .../admin/paths/admin_shipping-options.yaml | 10 +- .../paths/admin_shipping-options_{id}.yaml | 77 +- ...min_shipping-options_{id}_rules_batch.yaml | 83 +- .../admin/paths/admin_shipping-profiles.yaml | 8 + .../paths/admin_shipping-profiles_{id}.yaml | 4 + .../admin/paths/admin_stock-locations.yaml | 8 + .../paths/admin_stock-locations_{id}.yaml | 4 + ...-locations_{id}_fulfillment-providers.yaml | 2 + ...stock-locations_{id}_fulfillment-sets.yaml | 4 +- ...n_stock-locations_{id}_sales-channels.yaml | 2 + .../specs/admin/paths/admin_stores.yaml | 6 + .../specs/admin/paths/admin_stores_{id}.yaml | 4 + .../specs/admin/paths/admin_tax-rates.yaml | 8 + .../admin/paths/admin_tax-rates_{id}.yaml | 4 + .../paths/admin_tax-rates_{id}_rules.yaml | 2 + .../admin_tax-rates_{id}_rules_{rule_id}.yaml | 8 +- .../specs/admin/paths/admin_tax-regions.yaml | 8 + .../admin/paths/admin_tax-regions_{id}.yaml | 2 + .../specs/admin/paths/admin_uploads.yaml | 26 +- .../specs/admin/paths/admin_uploads_{id}.yaml | 4 +- .../specs/admin/paths/admin_users.yaml | 6 + .../specs/admin/paths/admin_users_me.yaml | 2 + .../specs/admin/paths/admin_users_{id}.yaml | 6 +- .../paths/admin_workflows-executions.yaml | 6 + .../admin_workflows-executions_{id}.yaml | 2 + ...orkflows-executions_{workflow_id}_run.yaml | 14 + ...utions_{workflow_id}_{transaction_id}.yaml | 2 + .../specs/admin/paths/auth_session.yaml | 2 +- .../paths/auth_user_{auth_provider}.yaml | 8 +- .../auth_user_{auth_provider}_callback.yaml | 4 +- .../auth_customer_{auth_provider}/post.sh | 1 + .../post.sh | 1 + .../auth_customer_{auth_provider}/post.sh | 7 +- .../post.sh | 2 +- ...ethod.yaml => AdminApplicationMethod.yaml} | 91 +- .../components/schemas/AdminArchiveOrder.yaml | 10 - .../store/components/schemas/AdminClaim.yaml | 225 +- .../schemas/AdminClaimPreviewResponse.yaml | 2 +- .../schemas/AdminClaimRequestResponse.yaml | 2 +- .../AdminClaimReturnPreviewResponse.yaml | 2 +- .../schemas/AdminCreateFulfillment.yaml | 11 +- .../schemas/AdminCreatePriceList.yaml | 2 +- .../schemas/AdminCreateProductType.yaml | 13 + .../schemas/AdminCreateProductVariant.yaml | 5 + ...AdminCreateProductVariantInventoryKit.yaml | 20 + .../AdminCreateProductVariantPrice.yaml | 7 + .../schemas/AdminCreatePromotionRule.yaml | 6 +- .../schemas/AdminCreateReturnReason.yaml} | 8 +- .../schemas/AdminCreateShippingOption.yaml | 96 +- .../schemas/AdminCreateTaxRate.yaml | 1 + .../schemas/AdminCreateTaxRegion.yaml | 1 + .../AdminCreateVariantInventoryItem.yaml | 2 +- .../components/schemas/AdminCurrency.yaml | 1 - .../components/schemas/AdminCustomer.yaml | 4 +- .../schemas/AdminCustomerGroup.yaml | 4 +- .../schemas/AdminCustomerGroupResponse.yaml | 2 +- .../schemas/AdminCustomerResponse.yaml | 2 +- .../components/schemas/AdminExchange.yaml | 223 +- .../schemas/AdminExchangePreviewResponse.yaml | 2 +- .../schemas/AdminExchangeRequestResponse.yaml | 4 +- .../schemas/AdminExchangeReturnResponse.yaml | 2 +- .../components/schemas/AdminFulfillment.yaml | 2 - .../schemas/AdminFulfillmentProvider.yaml | 14 +- .../schemas/AdminFulfillmentSet.yaml | 16 +- .../schemas/AdminFulfillmentSetResponse.yaml | 2 +- .../components/schemas/AdminGeoZone.yaml | 8 +- .../schemas/AdminImportProductRequest.yaml | 7 +- .../schemas/AdminInventoryItem.yaml | 16 +- .../schemas/AdminInventoryLevel.yaml | 79 +- .../store/components/schemas/AdminOrder.yaml | 19 +- .../components/schemas/AdminOrderChange.yaml | 142 + .../schemas/AdminOrderChangeAction.yaml | 104 + .../schemas/AdminOrderChangesResponse.yaml | 2 +- .../AdminOrderEditPreviewResponse.yaml | 2 +- .../schemas/AdminOrderEditResponse.yaml | 2 +- .../schemas/AdminOrderFulfillment.yaml | 79 + .../schemas/AdminOrderLineItem.yaml | 213 + .../components/schemas/AdminOrderPreview.yaml | 19 +- .../schemas/AdminOrderShippingMethod.yaml | 116 + .../components/schemas/AdminPayment.yaml | 6 +- .../schemas/AdminPaymentCollection.yaml | 8 +- .../schemas/AdminPaymentSession.yaml | 61 + .../components/schemas/AdminProduct.yaml | 13 +- .../components/schemas/AdminProductImage.yaml | 33 + .../schemas/AdminProductOption.yaml | 16 +- .../AdminProductOptionDeleteResponse.yaml | 7 +- .../schemas/AdminProductOptionResponse.yaml | 2 +- .../schemas/AdminProductOptionValue.yaml | 39 + .../schemas/AdminProductResponse.yaml | 2 +- .../components/schemas/AdminProductTag.yaml | 10 +- .../AdminProductTagDeleteResponse.yaml | 4 +- .../schemas/AdminProductTagListResponse.yaml | 10 +- .../schemas/AdminProductTagResponse.yaml | 2 +- .../components/schemas/AdminProductType.yaml | 10 +- .../AdminProductTypeDeleteResponse.yaml | 4 +- .../schemas/AdminProductTypeListResponse.yaml | 10 +- .../schemas/AdminProductTypeResponse.yaml | 2 +- .../schemas/AdminProductVariant.yaml | 62 +- .../AdminProductVariantDeleteResponse.yaml | 7 +- ...nProductVariantInventoryBatchResponse.yaml | 46 +- .../AdminProductVariantInventoryLink.yaml | 18 +- ...uctVariantInventoryLinkDeleteResponse.yaml | 7 +- .../schemas/AdminProductVariantParams.yaml | 872 - .../schemas/AdminProductVariantResponse.yaml | 2 +- .../components/schemas/AdminPromotion.yaml | 21 +- .../schemas/AdminPromotionResponse.yaml | 2 +- .../schemas/AdminPromotionRule.yaml | 15 +- .../store/components/schemas/AdminRefund.yaml | 38 + .../components/schemas/AdminRefundReason.yaml | 6 +- .../store/components/schemas/AdminRegion.yaml | 13 +- .../schemas/AdminRegionCountry.yaml | 32 +- .../schemas/AdminRegionResponse.yaml | 2 +- .../components/schemas/AdminReservation.yaml | 22 +- .../schemas/AdminReservationResponse.yaml | 2 +- .../store/components/schemas/AdminReturn.yaml | 59 +- .../components/schemas/AdminReturnItem.yaml | 20 +- .../schemas/AdminReturnPreviewResponse.yaml | 2 +- .../components/schemas/AdminReturnReason.yaml | 6 +- .../AdminReturnReasonDeleteResponse.yaml | 4 +- .../AdminReturnReasonListResponse.yaml | 10 +- .../schemas/AdminReturnReasonResponse.yaml | 2 +- .../schemas/AdminReturnResponse.yaml | 2 +- .../components/schemas/AdminRevokeApiKey.yaml | 6 +- .../schemas/AdminRuleAttributeOption.yaml | 26 +- .../schemas/AdminRuleValueOption.yaml | 13 +- .../components/schemas/AdminSalesChannel.yaml | 12 +- .../AdminSalesChannelDeleteResponse.yaml | 4 +- .../schemas/AdminSalesChannelResponse.yaml | 2 +- .../components/schemas/AdminServiceZone.yaml | 2 +- .../AdminServiceZoneDeleteResponse.yaml | 7 +- .../schemas/AdminServiceZoneResponse.yaml | 2 +- .../schemas/AdminShippingOption.yaml | 104 +- .../AdminShippingOptionDeleteResponse.yaml | 4 +- .../schemas/AdminShippingOptionPrice.yaml | 76 + .../schemas/AdminShippingOptionPriceRule.yaml | 15 + .../schemas/AdminShippingOptionResponse.yaml | 2 +- .../schemas/AdminShippingOptionRule.yaml | 26 +- .../schemas/AdminShippingOptionType.yaml | 48 + .../schemas/AdminShippingProfile.yaml | 41 +- .../AdminShippingProfileDeleteResponse.yaml | 4 +- .../schemas/AdminShippingProfileResponse.yaml | 2 +- .../schemas/AdminStockLocation.yaml | 10 +- .../schemas/AdminStockLocationAddress.yaml | 50 +- .../AdminStockLocationDeleteResponse.yaml | 4 +- .../AdminStockLocationListResponse.yaml | 10 +- .../schemas/AdminStockLocationResponse.yaml | 2 +- .../store/components/schemas/AdminStore.yaml | 12 +- .../schemas/AdminStoreCurrency.yaml | 17 +- .../schemas/AdminStoreListResponse.yaml | 10 +- .../schemas/AdminStoreResponse.yaml | 2 +- .../components/schemas/AdminTaxRate.yaml | 32 +- .../schemas/AdminTaxRateDeleteResponse.yaml | 4 +- .../schemas/AdminTaxRateResponse.yaml | 2 +- .../components/schemas/AdminTaxRateRule.yaml | 8 +- .../components/schemas/AdminTaxRegion.yaml | 47 +- .../schemas/AdminTaxRegionDeleteResponse.yaml | 4 +- .../schemas/AdminTaxRegionResponse.yaml | 2 +- .../components/schemas/AdminUpdateApiKey.yaml | 4 +- .../schemas/AdminUpdateCollection.yaml | 4 +- .../schemas/AdminUpdateCustomerGroup.yaml | 4 +- .../schemas/AdminUpdatePriceList.yaml | 9 +- .../schemas/AdminUpdatePricePreference.yaml | 6 +- .../schemas/AdminUpdateProduct.yaml | 227 +- .../schemas/AdminUpdateProductOption.yaml | 8 +- .../schemas/AdminUpdateProductVariant.yaml | 42 +- .../schemas/AdminUpdatePromotionRule.yaml | 49 + .../schemas/AdminUpdateReturnReason.yaml} | 13 +- .../schemas/AdminUpdateSalesChannel.yaml | 6 +- .../AdminUpdateShippingOptionRule.yaml | 43 + .../schemas/AdminUpdateStockLocation.yaml | 17 +- .../components/schemas/AdminUpdateStore.yaml | 19 +- .../schemas/AdminUpdateTaxRate.yaml | 23 +- .../components/schemas/AdminUpdateUser.yaml | 4 +- .../AdminUpdateVariantInventoryItem.yaml | 10 +- .../AdminUpsertStockLocationAddress.yaml | 7 +- .../store/components/schemas/AdminUser.yaml | 10 +- .../schemas/AdminUserDeleteResponse.yaml | 4 +- .../schemas/AdminUserListResponse.yaml | 10 +- .../components/schemas/AdminUserResponse.yaml | 2 +- .../schemas/AdminWorkflowExecution.yaml | 12 +- .../AdminWorkflowExecutionExecution.yaml | 147 +- .../AdminWorkflowExecutionResponse.yaml | 2 +- .../components/schemas/ApiKeyResponse.yaml | 26 +- .../schemas/AuthCallbackResponse.yaml | 2 +- .../schemas/BaseApplicationMethod.yaml | 61 - .../schemas/BaseCalculatedPriceSet.yaml | 80 +- .../store/components/schemas/BaseCapture.yaml | 27 +- .../store/components/schemas/BaseCart.yaml | 170 + .../components/schemas/BaseCartAddress.yaml | 68 +- .../components/schemas/BaseCartLineItem.yaml | 200 +- .../schemas/BaseCartShippingMethod.yaml | 153 +- .../store/components/schemas/BaseClaim.yaml | 3 - .../components/schemas/BaseClaimItem.yaml | 31 +- .../components/schemas/BaseCollection.yaml | 2 +- .../components/schemas/BaseCustomer.yaml | 73 - .../schemas/BaseCustomerAddress.yaml | 96 +- .../components/schemas/BaseExchangeItem.yaml | 18 +- .../schemas/BaseFulfillmentProvider.yaml | 4 +- .../schemas/BaseLineItemAdjustment.yaml | 55 +- .../schemas/BaseLineItemTaxLine.yaml | 61 +- .../store/components/schemas/BaseOrder.yaml | 237 +- .../components/schemas/BaseOrderAddress.yaml | 35 +- .../components/schemas/BaseOrderChange.yaml | 146 - .../schemas/BaseOrderChangeAction.yaml | 82 + .../schemas/BaseOrderFulfillment.yaml | 27 +- .../schemas/BaseOrderItemDetail.yaml | 76 + .../components/schemas/BaseOrderLineItem.yaml | 54 +- .../schemas/BaseOrderLineItemAdjustment.yaml | 55 +- .../schemas/BaseOrderLineItemTaxLine.yaml | 59 + .../schemas/BaseOrderShippingDetail.yaml | 42 + .../schemas/BaseOrderShippingMethod.yaml | 135 +- .../BaseOrderShippingMethodAdjustment.yaml | 53 + .../BaseOrderShippingMethodTaxLine.yaml | 61 +- .../components/schemas/BaseOrderSummary.yaml | 47 +- .../schemas/BaseOrderTransaction.yaml | 21 +- .../store/components/schemas/BasePayment.yaml | 92 +- .../schemas/BasePaymentCollection.yaml | 82 +- .../schemas/BasePaymentProvider.yaml | 7 + .../schemas/BasePaymentSession.yaml | 60 +- .../store/components/schemas/BaseProduct.yaml | 2 +- .../components/schemas/BaseProductImage.yaml | 32 +- .../components/schemas/BaseProductOption.yaml | 43 +- .../schemas/BaseProductOptionValue.yaml | 18 +- .../schemas/BaseProductVariant.yaml | 131 +- .../schemas/BasePromotionRuleValue.yaml | 4 +- .../store/components/schemas/BaseRefund.yaml | 37 +- .../store/components/schemas/BaseRegion.yaml | 2 +- .../components/schemas/BaseRegionCountry.yaml | 32 +- .../components/schemas/BaseReturnItem.yaml | 3 - .../schemas/BaseRuleOperatorOptions.yaml | 5 +- .../schemas/BaseShippingMethodAdjustment.yaml | 55 +- .../schemas/BaseShippingMethodTaxLine.yaml | 61 +- .../components/schemas/CreateAddress.yaml | 27 +- .../components/schemas/CreateCartAddress.yaml | 47 - .../schemas/CreateCartCreateLineItem.yaml | 97 - .../schemas/CreateCartWorkflowInput.yaml | 60 - .../CustomerGroupInCustomerFilters.yaml | 26 +- .../specs/store/components/schemas/File.yaml | 45 - .../store/components/schemas/FileList.yaml | 18 - .../components/schemas/InventoryLevel.yaml | 8 +- .../specs/store/components/schemas/Order.yaml | 295 +- .../components/schemas/OrderAddress.yaml | 33 +- .../store/components/schemas/OrderChange.yaml | 89 +- .../components/schemas/OrderChangeAction.yaml | 99 +- .../store/components/schemas/OrderClaim.yaml | 254 + .../components/schemas/OrderExchange.yaml | 260 + .../store/components/schemas/OrderItem.yaml | 105 +- .../components/schemas/OrderLineItem.yaml | 435 + .../schemas/OrderLineItemAdjustment.yaml | 55 +- .../schemas/OrderLineItemTaxLine.yaml | 69 +- .../components/schemas/OrderPreview.yaml | 1550 -- .../components/schemas/OrderReturnItem.yaml | 50 + .../schemas/OrderShippingMethod.yaml | 246 + .../OrderShippingMethodAdjustment.yaml | 55 +- .../schemas/OrderShippingMethodTaxLine.yaml | 69 +- .../components/schemas/OrderTransaction.yaml | 48 +- .../components/schemas/RefundReason.yaml | 35 + .../schemas/RefundReasonResponse.yaml | 2 +- .../schemas/ReservationResponse.yaml | 66 - .../store/components/schemas/Return.yaml | 298 +- .../schemas/StoreAddCartLineItem.yaml | 8 +- .../schemas/StoreCalculateCartTaxes.yaml | 8 - .../store/components/schemas/StoreCart.yaml | 350 +- .../components/schemas/StoreCartAddress.yaml | 53 +- .../components/schemas/StoreCartLineItem.yaml | 404 +- .../components/schemas/StoreCartResponse.yaml | 2 +- .../schemas/StoreCartShippingMethod.yaml | 253 + .../components/schemas/StoreCollection.yaml | 14 +- .../schemas/StoreCollectionResponse.yaml | 2 +- .../components/schemas/StoreCreateCart.yaml | 20 +- .../schemas/StoreCreateCustomer.yaml | 4 +- .../schemas/StoreCreatePaymentCollection.yaml | 4 +- .../components/schemas/StoreCreateReturn.yaml | 10 +- .../schemas/StoreCreateReturnItem.yaml | 6 +- .../schemas/StoreCreateReturnShipping.yaml | 6 +- .../components/schemas/StoreCurrency.yaml | 23 +- .../schemas/StoreCurrencyListResponse.yaml | 10 +- .../schemas/StoreCurrencyResponse.yaml | 2 +- .../components/schemas/StoreCustomer.yaml | 48 +- .../schemas/StoreCustomerAddress.yaml | 21 +- .../StoreCustomerAddressListResponse.yaml | 10 +- .../schemas/StoreCustomerAddressResponse.yaml | 2 +- .../schemas/StoreCustomerResponse.yaml | 2 +- .../store/components/schemas/StoreOrder.yaml | 64 +- .../schemas/StoreOrderResponse.yaml | 2 +- .../schemas/StorePaymentCollection.yaml | 86 +- .../StorePaymentCollectionResponse.yaml | 2 +- .../schemas/StorePaymentProvider.yaml | 2 +- .../schemas/StorePaymentSession.yaml | 61 + .../components/schemas/StoreProduct.yaml | 44 +- .../schemas/StoreProductCategory.yaml | 28 +- .../StoreProductCategoryListResponse.yaml | 10 +- .../schemas/StoreProductCategoryResponse.yaml | 2 +- .../components/schemas/StoreProductImage.yaml | 33 + .../schemas/StoreProductOption.yaml | 44 + .../schemas/StoreProductOptionValue.yaml | 39 + .../schemas/StoreProductResponse.yaml | 2 +- .../components/schemas/StoreProductTag.yaml | 35 + .../schemas/StoreProductVariant.yaml | 140 + .../schemas/StoreProductVariantParams.yaml | 76 - .../store/components/schemas/StoreRegion.yaml | 11 +- .../schemas/StoreRegionCountry.yaml | 32 + .../store/components/schemas/StoreReturn.yaml | 37 +- .../components/schemas/StoreReturnItem.yaml | 46 + .../components/schemas/StoreReturnReason.yaml | 6 +- .../schemas/StoreReturnReasonResponse.yaml | 2 +- .../schemas/StoreReturnResponse.yaml | 2 +- .../schemas/StoreShippingOption.yaml | 26 +- .../StoreShippingOptionListResponse.yaml | 2 +- .../schemas/StoreShippingOptionType.yaml | 48 + .../schemas/StoreUpdateCartLineItem.yaml | 6 +- .../schemas/StoreUpdateCustomer.yaml | 2 +- .../components/schemas/UpdateAddress.yaml | 29 +- .../components/schemas/UpdateCartData.yaml | 21 +- .../schemas/WorkflowExecutionContext.yaml | 42 +- .../specs/store/openapi.full.yaml | 13823 ++++++++------ .../paths/auth_customer_{auth_provider}.yaml | 8 +- ...uth_customer_{auth_provider}_callback.yaml | 4 +- .../specs/store/paths/auth_session.yaml | 2 +- .../specs/store/paths/store_carts.yaml | 2 + .../specs/store/paths/store_carts_{id}.yaml | 4 + .../paths/store_carts_{id}_complete.yaml | 10 +- .../paths/store_carts_{id}_line-items.yaml | 2 + ...store_carts_{id}_line-items_{line_id}.yaml | 4 + .../paths/store_carts_{id}_promotions.yaml | 4 + .../store_carts_{id}_shipping-methods.yaml | 4 +- .../store/paths/store_carts_{id}_taxes.yaml | 7 +- .../specs/store/paths/store_collections.yaml | 18 +- .../store/paths/store_collections_{id}.yaml | 2 + .../specs/store/paths/store_currencies.yaml | 6 + .../store/paths/store_currencies_{code}.yaml | 2 + .../specs/store/paths/store_customers.yaml | 5 + .../specs/store/paths/store_customers_me.yaml | 4 + .../paths/store_customers_me_addresses.yaml | 55 +- ...e_customers_me_addresses_{address_id}.yaml | 6 + .../specs/store/paths/store_orders.yaml | 18 +- .../specs/store/paths/store_orders_{id}.yaml | 2 + .../paths/store_payment-collections.yaml | 2 + ...ent-collections_{id}_payment-sessions.yaml | 2 + .../store/paths/store_payment-providers.yaml | 6 + .../store/paths/store_product-categories.yaml | 6 + .../paths/store_product-categories_{id}.yaml | 2 + .../specs/store/paths/store_products.yaml | 64 +- .../store/paths/store_products_{id}.yaml | 2 + .../specs/store/paths/store_regions.yaml | 20 +- .../specs/store/paths/store_regions_{id}.yaml | 4 +- .../store/paths/store_return-reasons.yaml | 6 + .../paths/store_return-reasons_{id}.yaml | 2 + .../store/paths/store_shipping-options.yaml | 6 + .../admin/delete_admin_customers_[id].ts | 2 +- ...xchanges_[id]_inbound_items_[action_id].ts | 20 - .../admin/delete_admin_users_[id].ts | 2 +- .../get_admin_promotions_[id]_[rule_type].ts | 4 +- .../admin/get_admin_shipping-options_[id].ts | 69 + .../admin/post_admin_claims_[id]_request.ts | 4 - .../post_admin_exchanges_[id]_request.ts | 4 - .../admin/post_admin_invites_[id]_resend.ts | 4 - .../admin/post_admin_orders_[id].ts | 4 - .../admin/post_admin_orders_[id]_archive.ts | 5 - .../admin/post_admin_orders_[id]_cancel.ts | 4 - ...ents_[fulfillment_id]_mark-as-delivered.ts | 5 - ...ost_admin_price-lists_[id]_prices_batch.ts | 2 +- .../admin/post_admin_product-types.ts | 2 +- ...cts_[id]_variants_inventory-items_batch.ts | 10 +- ...t_admin_promotions_[id]_buy-rules_batch.ts | 85 +- .../post_admin_promotions_[id]_rules_batch.ts | 85 +- ...dmin_promotions_[id]_target-rules_batch.ts | 85 +- .../admin/post_admin_return-reasons.ts | 2 +- .../admin/post_admin_return-reasons_[id].ts | 2 +- .../admin/post_admin_shipping-options_[id].ts | 4 +- ...admin_shipping-options_[id]_rules_batch.ts | 81 +- ...n_stock-locations_[id]_fulfillment-sets.ts | 2 +- .../post_auth_[actor_type]_[auth_provider].ts | 4 - ...h_[actor_type]_[auth_provider]_callback.ts | 4 - ...h_[actor_type]_[auth_provider]_register.ts | 4 - ...or_type]_[auth_provider]_reset-password.ts | 7 +- ...uth_[actor_type]_[auth_provider]_update.ts | 2 - .../operations/auth/post_auth_session.ts | 4 - .../auth/post_auth_token_refresh.ts | 3 - .../hooks/post_hooks_payment_[provider].ts | 4 - ...e_store_carts_[id]_line-items_[line_id].ts | 2 +- ...ore_customers_me_addresses_[address_id].ts | 2 +- .../operations/store/get_store_products.ts | 48 +- .../store/get_store_regions_[id].ts | 3 +- .../store/get_store_shipping-options.ts | 3 +- .../store/post_store_carts_[id]_complete.ts | 4 +- .../operations/store/post_store_customers.ts | 3 + ...yment-collections_[id]_payment-sessions.ts | 3 +- .../oas-output/schemas/AdminArchiveOrder.ts | 15 - .../oas-output/schemas/AdminCampaign.ts | 8 +- .../schemas/AdminClaimPreviewResponse.ts | 2 +- .../schemas/AdminClaimRequestResponse.ts | 2 +- .../AdminClaimReturnPreviewResponse.ts | 2 +- .../schemas/AdminCreateApplicationMethod.ts | 66 - .../schemas/AdminCreateFulfillment.ts | 11 +- .../schemas/AdminCreatePriceList.ts | 2 +- .../schemas/AdminCreateProductVariant.ts | 6 + .../schemas/AdminCreatePromotionRule.ts | 6 +- .../schemas/AdminCreateReturnReason.ts | 2 +- .../oas-output/schemas/AdminCreateTaxRate.ts | 1 + .../schemas/AdminCreateTaxRegion.ts | 1 + .../AdminCreateVariantInventoryItem.ts | 2 +- .../oas-output/schemas/AdminCurrency.ts | 1 - .../oas-output/schemas/AdminCustomer.ts | 2 +- .../oas-output/schemas/AdminCustomerGroup.ts | 2 +- .../schemas/AdminExchangePreviewResponse.ts | 2 +- .../schemas/AdminExchangeRequestResponse.ts | 4 +- .../schemas/AdminExchangeReturnResponse.ts | 2 +- .../schemas/AdminExportProductRequest.ts | 8 - .../oas-output/schemas/AdminFulfillment.ts | 2 - .../AdminMarkOrderFulfillmentDelivered.ts | 8 - .../oas-output/schemas/AdminOrder.ts | 19 +- .../oas-output/schemas/AdminOrderChange.ts | 191 +- .../schemas/AdminOrderChangeAction.ts | 97 +- .../schemas/AdminOrderChangesResponse.ts | 2 +- .../schemas/AdminOrderEditPreviewResponse.ts | 2 +- .../schemas/AdminOrderEditResponse.ts | 2 +- .../oas-output/schemas/AdminOrderLineItem.ts | 32 +- .../oas-output/schemas/AdminPayment.ts | 6 +- .../schemas/AdminPaymentCollection.ts | 8 +- .../schemas/AdminPriceListBatchResponse.ts | 2 +- .../oas-output/schemas/AdminPriceListPrice.ts | 2 +- .../oas-output/schemas/AdminProduct.ts | 13 +- .../oas-output/schemas/AdminProductOption.ts | 2 +- .../AdminProductOptionDeleteResponse.ts | 2 +- .../oas-output/schemas/AdminProductVariant.ts | 4 +- .../AdminProductVariantDeleteResponse.ts | 2 +- ...oductVariantInventoryLinkDeleteResponse.ts | 2 +- .../oas-output/schemas/AdminPromotion.ts | 14 +- .../oas-output/schemas/AdminPromotionRule.ts | 4 +- .../oas-output/schemas/AdminRegion.ts | 2 +- .../oas-output/schemas/AdminReservation.ts | 4 +- .../schemas/AdminRuleAttributeOption.ts | 8 +- .../schemas/AdminRuleValueOption.ts | 4 +- .../schemas/AdminServiceZoneDeleteResponse.ts | 2 +- .../oas-output/schemas/AdminShippingOption.ts | 5 +- .../schemas/AdminShippingOptionType.ts | 53 + .../schemas/AdminUpdatePriceList.ts | 3 +- .../schemas/AdminUpdatePromotionRule.ts | 49 + .../schemas/AdminUpdateShippingOptionRule.ts | 48 + .../AdminUpdateVariantInventoryItem.ts | 3 +- .../schemas/BaseApplicationMethod.ts | 67 - .../schemas/BaseCalculatedPriceSet.ts | 2 +- .../generated/oas-output/schemas/BaseClaim.ts | 103 - .../oas-output/schemas/BaseClaimItem.ts | 11 + .../oas-output/schemas/BaseCollection.ts | 44 - .../oas-output/schemas/BaseCustomer.ts | 78 - .../oas-output/schemas/BaseOrderChange.ts | 154 - .../oas-output/schemas/BaseOrderItemDetail.ts | 4 +- .../oas-output/schemas/BaseOrderLineItem.ts | 3 +- .../schemas/BaseOrderShippingDetail.ts | 3 - .../schemas/BaseOrderShippingMethod.ts | 2 + .../oas-output/schemas/BaseOrderSummary.ts | 25 - .../oas-output/schemas/BasePaymentProvider.ts | 5 - .../oas-output/schemas/BaseRefund.ts | 2 + .../oas-output/schemas/BaseReturnItem.ts | 8 - .../schemas/BaseRuleOperatorOptions.ts | 6 +- .../schemas/CreateOrderReturnReason.ts | 31 - .../oas-output/schemas/OrderPreview.ts | 1555 -- .../oas-output/schemas/ReservationResponse.ts | 71 - .../schemas/StoreCalculateCartTaxes.ts | 13 - .../generated/oas-output/schemas/StoreCart.ts | 8 +- .../oas-output/schemas/StoreCartLineItem.ts | 170 +- .../schemas/StoreCartShippingMethod.ts | 142 +- .../oas-output/schemas/StoreCollection.ts | 4 +- .../oas-output/schemas/StoreCurrency.ts | 1 - .../oas-output/schemas/StoreCustomer.ts | 6 +- .../schemas/StoreCustomerAddress.ts | 2 +- .../oas-output/schemas/StoreOrderAddress.ts | 78 - .../schemas/StoreOrderFulfillment.ts | 81 - .../oas-output/schemas/StoreOrderLineItem.ts | 218 - .../schemas/StoreOrderShippingMethod.ts | 118 - .../oas-output/schemas/StoreReturn.ts | 19 +- .../oas-output/schemas/StoreShippingOption.ts | 5 +- .../schemas/UpdateOrderReturnReason.ts | 28 - 894 files changed, 35649 insertions(+), 28168 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}_callback/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/get.sh rename www/apps/api-reference/specs/admin/components/schemas/{AdminCreateApplicationMethod.yaml => AdminApplicationMethod.yaml} (59%) delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantInventoryKit.yaml rename www/apps/api-reference/specs/{store/components/schemas/CreateOrderReturnReason.yaml => admin/components/schemas/AdminCreateReturnReason.yaml} (65%) create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminPaymentSession.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminRefund.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPrice.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPriceRule.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionType.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePromotionRule.yaml rename www/apps/api-reference/specs/{store/components/schemas/UpdateOrderReturnReason.yaml => admin/components/schemas/AdminUpdateReturnReason.yaml} (62%) create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOptionRule.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingDetail.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/CreateCartWorkflowInput.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/File.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/FileList.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.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/RefundReason.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StorePaymentSession.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml delete mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionType.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml create mode 100644 www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}/post.sh create mode 100644 www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh rename www/apps/api-reference/specs/store/components/schemas/{AdminCreateApplicationMethod.yaml => AdminApplicationMethod.yaml} (59%) delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantInventoryKit.yaml rename www/apps/api-reference/specs/{admin/components/schemas/CreateOrderReturnReason.yaml => store/components/schemas/AdminCreateReturnReason.yaml} (65%) create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminPaymentSession.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminRefund.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPrice.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPriceRule.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionType.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUpdatePromotionRule.yaml rename www/apps/api-reference/specs/{admin/components/schemas/UpdateOrderReturnReason.yaml => store/components/schemas/AdminUpdateReturnReason.yaml} (62%) create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOptionRule.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingDetail.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/CreateCartWorkflowInput.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/File.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/FileList.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.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/RefundReason.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StorePaymentSession.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml delete mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionType.yaml create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts delete mode 100644 www/utils/generated/oas-output/schemas/AdminMarkOrderFulfillmentDelivered.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminShippingOptionType.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUpdatePromotionRule.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUpdateShippingOptionRule.ts delete mode 100644 www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts delete mode 100644 www/utils/generated/oas-output/schemas/BaseClaim.ts delete mode 100644 www/utils/generated/oas-output/schemas/BaseCustomer.ts delete mode 100644 www/utils/generated/oas-output/schemas/BaseOrderChange.ts delete mode 100644 www/utils/generated/oas-output/schemas/BaseReturnItem.ts delete mode 100644 www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts delete mode 100644 www/utils/generated/oas-output/schemas/OrderPreview.ts delete mode 100644 www/utils/generated/oas-output/schemas/ReservationResponse.ts delete mode 100644 www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts delete mode 100644 www/utils/generated/oas-output/schemas/StoreOrderAddress.ts delete mode 100644 www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts delete mode 100644 www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts delete mode 100644 www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts delete mode 100644 www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts diff --git a/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml b/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml index f30a7e8999..5a0bb47d67 100644 --- a/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml +++ b/packages/cli/oas/medusa-oas-cli/redocly/redocly-config.yaml @@ -22,6 +22,7 @@ decorators: - AdminProduct BaseProduct: - BaseProduct + - BaseProductVariant StoreProduct: - StoreProductCategory - StoreProduct @@ -107,6 +108,29 @@ decorators: - BaseProduct OrderItem: - OrderLineItem + AdminOrderChangeAction: + - AdminOrderChange + AdminPaymentSession: + - AdminPaymentCollection + AdminProductOption: + - AdminProduct + - AdminProductOptionValue + AdminPromotion: + - AdminApplicationMethod + BaseOrderItemDetail: + - BaseOrderLineItem + BaseOrderShippingDetail: + - BaseOrderShippingMethod + StorePaymentSession: + - StorePaymentCollection + StoreProductOption: + - StoreProduct + StoreProductOptionValue: + - StoreProductOption + AdminPayment: + - AdminPaymentCollection + StoreProductVariant: + - StoreProduct theme: openapi: theme: diff --git a/www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}/post.sh new file mode 100644 index 0000000000..ebac056842 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}/post.sh @@ -0,0 +1 @@ +curl -X POST '{backend_url}/auth/user/google' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}_callback/post.sh b/www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}_callback/post.sh new file mode 100644 index 0000000000..c4a07555a3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Bash/auth_user_{auth_provider}_callback/post.sh @@ -0,0 +1 @@ +curl -X POST '{backend_url}/auth/user/github/callback?code=123' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.sh new file mode 100644 index 0000000000..7f597b2ef3 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/mark-as-delivered' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/get.sh new file mode 100644 index 0000000000..985b9d8b43 --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_shipping-options_{id}/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/shipping-options/{id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}/post.sh index 0e2617e18e..684dcc3cba 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}/post.sh @@ -1 +1,6 @@ -curl -X POST '{backend_url}/auth/user/github' \ No newline at end of file +curl -X POST '{backend_url}/auth/user/emailpass' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "admin@medusa-test.com", + "password": "supersecret" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_callback/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_callback/post.sh index c4a07555a3..eacb071a60 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_callback/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/auth_user_{auth_provider}_callback/post.sh @@ -1 +1 @@ -curl -X POST '{backend_url}/auth/user/github/callback?code=123' \ No newline at end of file +curl -X POST '{backend_url}/auth/user/google/callback?code=123' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminApplicationMethod.yaml similarity index 59% rename from www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminApplicationMethod.yaml index 5cbb99276e..14f4f8992f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateApplicationMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminApplicationMethod.yaml @@ -1,45 +1,40 @@ type: object description: The application method's details. -x-schemaName: AdminCreateApplicationMethod +x-schemaName: AdminApplicationMethod required: - - value - - type - - target_type + - id properties: - description: + promotion: + $ref: ./AdminPromotion.yaml + target_rules: + type: array + description: The application method's target rules. + items: + $ref: ./AdminPromotionRule.yaml + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: ./AdminPromotionRule.yaml + id: type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: >- - The discounted amount applied by the associated promotion based on the - `type`. - currency_code: - type: string - title: currency_code - description: The application method's currency code. - max_quantity: - type: number - title: max_quantity - description: >- - The max quantity allowed in the cart for the associated promotion to be - applied. + title: id + description: The application method's ID. type: type: string description: >- - The type of the application method indicating how the associated promotion - is applied. + The application method's type. If it's `fixed`, the promotion discounts a + fixed amount. If it's `percentage`, the promotion discounts a percentage. enum: - fixed - percentage target_type: type: string description: >- - The target type of the application method indicating whether the - associated promotion is applied to the cart's items, shipping methods, or - the whole order. + Which item does the promotion apply to. `items` mean the promotion applies + to the cart's items; `shipping_methods` means the promotion applies to the + cart's shipping methods; `order` means the promotion applies on the entire + order. enum: - items - shipping_methods @@ -47,28 +42,27 @@ properties: allocation: type: string description: >- - The allocation value that indicates whether the associated promotion is - applied on each item in a cart or split between the items in the cart. + How is the promotion amount discounted. `each` means the discounted amount + is applied on each applicable item; `across` means the discounted amount + is split accross the applicable items. enum: - each - across - target_rules: - type: array - description: The application method's target rules. - items: - $ref: ./AdminCreatePromotionRule.yaml - buy_rules: - type: array - description: The application method's buy rules. - items: - $ref: ./AdminCreatePromotionRule.yaml - apply_to_quantity: + value: type: number - title: apply_to_quantity + title: value + description: The amount to be discounted. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + example: usd + max_quantity: + type: number + title: max_quantity description: >- - The quantity that results from matching the `buyget` promotion's - condition. For example, if the promotion is a "Buy 2 shirts get 1 free", - the value f this attribute is `1`. + The max quantity allowed in the cart for the associated promotion to be + applied. buy_rules_min_quantity: type: number title: buy_rules_min_quantity @@ -76,3 +70,10 @@ properties: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. + apply_to_quantity: + type: number + title: apply_to_quantity + description: >- + The quantity that results from matching the `buyget` promotion's + condition. For example, if the promotion is a "Buy 2 shirts get 1 free", + the value of this attribute is `1`. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml deleted file mode 100644 index 72b7d36198..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminArchiveOrder.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminArchiveOrder -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/AdminClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml index 21f60500a4..d6104bdceb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaim.yaml @@ -2,44 +2,18 @@ type: object description: The claim's details. x-schemaName: AdminClaim required: - - order_id - - claim_items - - additional_items - - currency_code + - order + - return - id - - region_id - - customer_id - - sales_channel_id - - email - - shipping_methods - - payment_status - - fulfillment_status - - summary - - metadata + - type + - order_id + - display_id + - order_version - 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 + - canceled_at + - additional_items + - claim_items properties: id: type: string @@ -60,7 +34,7 @@ properties: items: $ref: ./BaseClaimItem.yaml return: - $ref: ./Return.yaml + $ref: ./AdminReturn.yaml return_id: type: string title: return_id @@ -73,76 +47,15 @@ properties: type: number title: refund_amount description: The amount to be refunded. - currency_code: - type: string - title: currency_code - description: The claim's currency code. - region_id: - type: string - title: region_id - description: The ID of the region associated with the claim. - customer_id: - type: string - title: customer_id - description: The ID of the customer associated with the claim's order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the claim's order is created in. - email: - type: string - title: email - description: The email associated with the claim's order. - format: email display_id: type: number 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 - description: The claim's payment status. - 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 - description: The claim's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered + $ref: ./AdminOrderShippingMethod.yaml transactions: type: array description: The claim's transactions. @@ -152,8 +65,6 @@ properties: description: Learn more about transactions of orders and associated models. items: $ref: ./BaseOrderTransaction.yaml - summary: - $ref: ./BaseOrderSummary.yaml metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -167,91 +78,29 @@ properties: format: date-time title: updated_at description: The claim's update date. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the associated order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the associated order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The tax total of the original items in the associated order. - item_total: - type: number - title: item_total - description: The total of the claim's items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the claim's items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the claim's items. - original_total: - type: number - title: original_total - description: The associated order's original total. - original_subtotal: - type: number - title: original_subtotal - description: The associated order's original subtotal. - original_tax_total: - type: number - title: original_tax_total - description: The associated order's original tax total. - total: - type: number - title: total - description: The associated order'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 associated order's original shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The associated order's original shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The associated order's original shipping tax total. + order: + $ref: ./AdminOrder.yaml + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order_version: + type: string + title: order_version + description: The version of the order when the claim is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml index d3d5cf085c..8fdefc6818 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimPreviewResponse.yaml @@ -8,6 +8,6 @@ required: - claim properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.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 index eb463459db..c49a9d5d9e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimRequestResponse.yaml @@ -11,6 +11,6 @@ properties: return: $ref: ./AdminReturn.yaml order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml 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 index f91f77fa23..9688761b29 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminClaimReturnPreviewResponse.yaml @@ -8,6 +8,6 @@ required: - return properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml index 0dd456e29b..79e31f7d86 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -2,15 +2,14 @@ type: object description: The filfillment's details. x-schemaName: AdminCreateFulfillment required: + - data + - order_id + - metadata + - items - location_id - provider_id - delivery_address - - items - labels - - order - - order_id - - data - - metadata properties: location_id: type: string @@ -75,8 +74,8 @@ properties: description: An item to fulfill. required: - title - - sku - quantity + - sku - barcode properties: title: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml index ff78bb5483..8ff435ab5c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml @@ -48,8 +48,8 @@ properties: description: A price's details. required: - currency_code - - amount - variant_id + - amount properties: currency_code: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml new file mode 100644 index 0000000000..92179c7066 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductType.yaml @@ -0,0 +1,13 @@ +type: object +description: The details of the product type to create. +x-schemaName: AdminCreateProductType +required: + - value +properties: + metadata: + type: object + description: The product's metadata, used to store custom key-value pairs. + value: + type: string + title: value + description: The product type's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml index 874a1015bb..5cbbf93868 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariant.yaml @@ -86,3 +86,8 @@ properties: the option's value. example: Color: Black + inventory_items: + type: array + description: The variant's inventory items to create. + items: + $ref: ./AdminCreateProductVariantInventoryKit.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantInventoryKit.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantInventoryKit.yaml new file mode 100644 index 0000000000..89c326e80c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantInventoryKit.yaml @@ -0,0 +1,20 @@ +type: object +description: The details of a variant's inventory item. +x-schemaName: AdminCreateProductVariantInventoryKit +required: + - inventory_item_id +properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory item's ID. + required_quantity: + type: number + title: required_quantity + description: >- + The number of units a single quantity is equivalent to. For example, if a + customer orders one quantity of the variant, Medusa checks the + availability of the quantity multiplied by the value set for + `required_quantity`. When the customer orders the quantity, Medusa + reserves the ordered quantity multiplied by the value set for + `required_quantity`. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml index e543b4f377..7209d597f8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProductVariantPrice.yaml @@ -30,3 +30,10 @@ properties: description: The price's rules. example: region_id: reg_123 + properties: + region_id: + type: string + title: region_id + description: The ID of a region. + required: + - region_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml index 93373ce220..d8ddd80848 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePromotionRule.yaml @@ -13,13 +13,13 @@ properties: example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: + - gte + - lte - gt - lt - eq - ne - in - - lte - - gte description: type: string title: description @@ -30,7 +30,7 @@ properties: description: >- The attribute to compare against when checking whether a promotion can be applied on a cart. - example: item.product.id + example: items.product.id values: oneOf: - type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateOrderReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml similarity index 65% rename from www/apps/api-reference/specs/store/components/schemas/CreateOrderReturnReason.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml index efbb641c2f..adac302423 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateOrderReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateReturnReason.yaml @@ -1,6 +1,6 @@ type: object -description: SUMMARY -x-schemaName: CreateOrderReturnReason +description: The details of the return reason to create. +x-schemaName: AdminCreateReturnReason required: - value - label @@ -20,7 +20,7 @@ properties: parent_return_reason_id: type: string title: parent_return_reason_id - description: The return reason's parent return reason id. + description: The ID of the parent return reason. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml index ea6b78201e..2477095764 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml @@ -2,91 +2,19 @@ type: object description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - name - - service_zone_id - - shipping_profile_id - - price_type - - provider_id - - type - - prices + - label + - description + - code properties: - name: + label: type: string - title: name - description: The shipping option's name. - service_zone_id: + title: label + description: The type's label. + description: type: string - title: service_zone_id - description: The ID of the service zone this shipping option belongs to. - shipping_profile_id: + title: description + description: The type's description. + code: type: string - title: shipping_profile_id - description: The ID of the shipping profile this shipping option belongs to. - data: - type: object - description: >- - Any data necessary for fulfillment providers to handle shipping methods - and fulfillments of this shipping option. - externalDocs: - url: >- - https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property - description: Learn more about the data property. - price_type: - type: string - description: > - The shipping option price's type. If `flat`, it means the option has a - fixed price set in the `prices` property. `calculated` means that the - shipping option's price is calculated during checkout. - enum: - - flat - - calculated - provider_id: - type: string - title: provider_id - description: >- - The ID of the fulfillment provider used to handle this shipping option and - its associated methods and fulfillments. - type: - type: object - prices: - type: array - description: >- - The shipping option's prices. If `price_type` is `calculated`, pass an - empty array for this property. - items: - oneOf: - - type: object - description: The price for a currency code. - x-schemaName: AdminCreateShippingOptionPriceWithCurrency - required: - - currency_code - - amount - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - - type: object - description: The price in a region. - x-schemaName: AdminCreateShippingOptionPriceWithRegion - required: - - region_id - - amount - properties: - region_id: - type: string - title: region_id - description: The ID of the region this price is used in. - amount: - type: number - title: amount - description: The price's amount. - rules: - type: array - description: The shipping option's rules. - items: - $ref: ./AdminCreateShippingOptionRule.yaml + title: code + description: The type's code. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml index 065c81d06b..8aa3b751de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRate.yaml @@ -4,6 +4,7 @@ x-schemaName: AdminCreateTaxRate required: - name - tax_region_id + - code properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml index f0cdf7c039..261472a2de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateTaxRegion.yaml @@ -21,6 +21,7 @@ properties: type: object description: The tax region's default tax rate. required: + - code - name properties: rate: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml index 23e84a8328..2de3fc7b23 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateVariantInventoryItem.yaml @@ -2,8 +2,8 @@ type: object description: The details of the variant-inventory item association. x-schemaName: AdminCreateVariantInventoryItem required: - - required_quantity - inventory_item_id + - required_quantity properties: required_quantity: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml index 984e1d51cf..887204ea4d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCurrency.yaml @@ -8,7 +8,6 @@ required: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml index af16ad0bf7..7a8ef94f4f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomer.yaml @@ -3,6 +3,7 @@ description: The customer's details. x-schemaName: AdminCustomer required: - has_account + - addresses - id - email - default_billing_address_id @@ -10,7 +11,6 @@ required: - company_name - first_name - last_name - - addresses properties: id: type: string @@ -54,7 +54,7 @@ properties: type: array description: The customer's addresses. items: - $ref: ./BaseCustomerAddress.yaml + $ref: ./AdminCustomerAddress.yaml phone: type: string title: phone diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml index 3984d6eb28..ddef197fa0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroup.yaml @@ -2,9 +2,9 @@ type: object description: The customer group's details. x-schemaName: AdminCustomerGroup required: + - customers - id - name - - customers - metadata - created_at - updated_at @@ -21,7 +21,7 @@ properties: type: array description: The customer group's customers. items: - $ref: ./BaseCustomer.yaml + type: object metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml index 4ddc2deae1..85fb2eeff2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerGroupResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The customer group's details. x-schemaName: AdminCustomerGroupResponse required: - customer_group diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml index 06cde895cd..d53387f56f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCustomerResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The customer's details. x-schemaName: AdminCustomerResponse required: - customer diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml index e66c9d6ec8..31e20a4158 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -2,44 +2,14 @@ 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 + - order_id - 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 + - canceled_at + - deleted_at + - additional_items + - return_items properties: order_id: type: string @@ -67,88 +37,24 @@ properties: be refunded. If positive, additional payment is required from the customer. return: - description: the return associated with the exchange. $ref: ./AdminReturn.yaml return_id: type: string title: return_id description: The ID of the associated exchange. - 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 ID of the associated order's region. - customer_id: - type: string - title: customer_id - description: The ID of the customer that placed the order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the associated order belongs to. - email: - type: string - title: email - description: The email used when placing the order. - format: email display_id: - type: number + type: string title: display_id description: The exchange's display ID. - shipping_address: - description: The shipping address to send new items to. - $ref: ./BaseOrderAddress.yaml - billing_address: - description: The customer's billing address. - $ref: ./BaseOrderAddress.yaml shipping_methods: type: array description: The shipping methods used to send the new (outbound) items. items: $ref: ./BaseOrderShippingMethod.yaml - payment_collections: - type: array - description: The exchange's payment collections. - items: - $ref: ./BasePaymentCollection.yaml - payment_status: - type: string - description: The exchange's payment status. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - fulfillments: - type: array - description: The exchange's fulfillments of new (outbound) items. - items: - $ref: ./BaseOrderFulfillment.yaml - fulfillment_status: - type: string - description: The exchange's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered transactions: type: array description: The exchange's transactions. @@ -157,9 +63,6 @@ properties: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions items: $ref: ./BaseOrderTransaction.yaml - summary: - description: The totals summary of the exchange. - $ref: ./BaseOrderSummary.yaml metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -173,91 +76,29 @@ properties: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The total tax of the original items in the order. - item_total: - type: number - title: item_total - description: The total of the exchange's new items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the exchange's new items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the exchange's new items. - original_total: - type: number - title: original_total - description: The total of the order. - original_subtotal: - type: number - title: original_subtotal - description: The subtotal of the order. - original_tax_total: - type: number - title: original_tax_total - description: The tax total of the order. - total: - type: number - title: total - description: The total of the exchange. - subtotal: - type: number - title: subtotal - description: The subtotal of the exchange. - tax_total: - type: number - title: tax_total - description: The tax total of the exchange. - discount_total: - type: number - title: discount_total - description: The discount total of the exchange. - discount_tax_total: - type: number - title: discount_tax_total - description: The total taxes on discount of the exchange. - gift_card_total: - type: number - title: gift_card_total - description: The gift cards total of the exchange. - gift_card_tax_total: - type: number - title: gift_card_tax_total - description: The total taxes on the gift card of the exchange. - 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 order's shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The order's shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The order's shipping tax total. + order_version: + type: string + title: order_version + description: The version of the order once the exchange is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + order: + $ref: ./AdminOrder.yaml + allow_backorder: + type: boolean + title: allow_backorder + description: >- + Whether variants that are out-of-stock can still be added as additional or + outbound items. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml index 43b16c6438..2ada4ad0d5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangePreviewResponse.yaml @@ -6,6 +6,6 @@ required: - exchange properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.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 index 8c908c82e0..285bbc8842 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeRequestResponse.yaml @@ -7,10 +7,8 @@ required: - exchange properties: return: - description: The associated return's details. $ref: ./AdminReturn.yaml order_preview: - description: A preview of the order once the exchange is applied. - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml 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 index abe845366f..d8ab001ca0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeReturnResponse.yaml @@ -6,6 +6,6 @@ required: - return properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml return: $ref: ./AdminReturn.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 index 80430cd6ad..a459be7817 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillment.yaml @@ -37,10 +37,8 @@ properties: title: shipping_option_id description: The ID of the shipping option this fulfillment is created for. provider: - description: The details of the fulfillment provider using to handle this fulfillment. $ref: ./AdminFulfillmentProvider.yaml delivery_address: - description: The address to deliver the item to. $ref: ./AdminFulfillmentAddress.yaml items: type: array 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..a60a87734e 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,15 @@ type: object -description: The shipping option's provider. +description: The fulfillment provider's details. x-schemaName: AdminFulfillmentProvider +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/AdminFulfillmentSet.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml index e9131c3f4a..ba5f3c0d07 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSet.yaml @@ -1,5 +1,5 @@ type: object -description: The fulfillment set's parent. +description: The service zone's fulfillment set. x-schemaName: AdminFulfillmentSet required: - id @@ -14,34 +14,34 @@ properties: id: type: string title: id - description: The parent's ID. + description: The fulfillment set's ID. name: type: string title: name - description: The parent's name. + description: The fulfillment set's name. type: type: string title: type - description: The parent's type. + description: The fulfillment set's type. location: $ref: ./AdminStockLocation.yaml service_zones: type: array - description: The parent's service zones. + description: The fulfillment set's service zones. items: $ref: ./AdminServiceZone.yaml created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The fulfillment set's created at. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The fulfillment set's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The fulfillment set's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml index b5f823157e..e455cca7a6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminFulfillmentSetResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The fulfillment set's details. x-schemaName: AdminFulfillmentSetResponse required: - fulfillment_set diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml index fcdcef3406..c7d0be5d77 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminGeoZone.yaml @@ -1,5 +1,5 @@ type: object -description: The geo zone's details. +description: The geo zone's geo zones. x-schemaName: AdminGeoZone required: - id @@ -43,14 +43,14 @@ properties: type: string format: date-time title: created_at - description: The date the geo zone was created. + description: The geo zone's created at. updated_at: type: string format: date-time title: updated_at - description: The date the geo zone was update. + description: The geo zone's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The date the geo zone was deleted. + description: The geo zone's deleted at. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductRequest.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductRequest.yaml index 94efb6c2bd..8aac0f128a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductRequest.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminImportProductRequest.yaml @@ -5,4 +5,9 @@ required: - file properties: file: - $ref: ./File.yaml + type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: file diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml index c2c758a65c..287a08bd99 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryItem.yaml @@ -1,5 +1,5 @@ type: object -description: The inventory item's details. +description: The reservation's inventory item. x-schemaName: AdminInventoryItem required: - id @@ -12,7 +12,7 @@ properties: sku: type: string title: sku - description: The inventory item's SKU. + description: The inventory item's sku. origin_country: type: string title: origin_country @@ -20,15 +20,15 @@ properties: hs_code: type: string title: hs_code - description: The inventory item's HS code. + description: The inventory item's hs code. requires_shipping: type: boolean title: requires_shipping - description: Whether the inventory item requires shipping. + description: The inventory item's requires shipping. mid_code: type: string title: mid_code - description: The inventory item's MID code. + description: The inventory item's mid code. material: type: string title: material @@ -60,12 +60,12 @@ properties: thumbnail: type: string title: thumbnail - description: The URL of the inventory item's thumbnail. + description: The inventory item's thumbnail. metadata: type: object - description: The inventory item's metadata, can hold custom key-value pairs. + description: The inventory item's metadata. location_levels: type: array - description: The inventory item's associated inventory levels. + description: The inventory item's location levels. items: $ref: ./AdminInventoryLevel.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml index 28850cf68c..d7802818c2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminInventoryLevel.yaml @@ -1,5 +1,5 @@ type: object -description: The inventory level's details. +description: The location level's location levels. x-schemaName: AdminInventoryLevel required: - id @@ -9,67 +9,56 @@ required: - inventory_item_id - location_id - stocked_quantity - - raw_stocked_quantity - reserved_quantity - - raw_reserved_quantity - incoming_quantity - - raw_incoming_quantity - metadata - available_quantity properties: id: type: string title: id - description: The inventory level's ID. + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. inventory_item_id: type: string title: inventory_item_id - description: The ID of the inventory item this level belongs to. + description: The location level's inventory item id. location_id: type: string title: location_id - description: The ID of the stock location this level belongs to. + description: The location level's location id. stocked_quantity: type: number title: stocked_quantity - description: >- - The quantity of the associated inventory item stocked in the associated - stock location. + description: The location level's stocked quantity. reserved_quantity: type: number title: reserved_quantity - description: >- - The reserved quantity of the associated inventory item stocked in the - associated stock location. + description: The location level's reserved quantity. incoming_quantity: type: number title: incoming_quantity - description: >- - The incoming quantity of the associated inventory item stocked in the - associated stock location. + description: The location level's incoming quantity. metadata: type: object - description: The location level's metadata, can hold custom key-value pairs. + description: The location level's metadata. inventory_item: type: object available_quantity: type: number title: available_quantity - description: >- - The quantity available for order of the associated inventory item in the - associated stock location. - created_at: - type: string - format: date-time - title: created_at - description: The date the inventory level was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the inventory level was updated. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The date the inventory level was deleted. + description: The location level's available quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index 4d56258b6e..e90b9b2d8f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -3,21 +3,20 @@ description: The order's details. x-schemaName: AdminOrder required: - payment_collections + - items + - shipping_methods + - currency_code - id + - created_at + - updated_at + - email - 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 @@ -50,7 +49,7 @@ properties: type: array description: The order's fulfillments. items: - $ref: ./BaseOrderFulfillment.yaml + $ref: ./AdminOrderFulfillment.yaml sales_channel: $ref: ./AdminSalesChannel.yaml customer: @@ -96,12 +95,12 @@ properties: type: array description: The order's items. items: - $ref: ./BaseOrderLineItem.yaml + $ref: ./AdminOrderLineItem.yaml shipping_methods: type: array description: The order's shipping methods. items: - $ref: ./BaseOrderShippingMethod.yaml + $ref: ./AdminOrderShippingMethod.yaml payment_status: type: string description: The order's payment status. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml new file mode 100644 index 0000000000..3297e8bcca --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml @@ -0,0 +1,142 @@ +type: object +description: The order change's details. +x-schemaName: AdminOrderChange +required: + - order + - claim + - return_order + - exchange + - actions + - status + - order_id + - metadata + - id + - created_at + - updated_at + - version + - canceled_at + - return_id + - exchange_id + - claim_id + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - declined_at + - canceled_by +properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: >- + The order change's version. This will be the order's version when the + change is applied. + change_type: + type: string + description: The order change's type. + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The ID of the order this change applies on. + return_id: + type: string + title: return_id + description: The ID of the associated return. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + return_order: + $ref: ./AdminReturn.yaml + exchange: + $ref: ./AdminExchange.yaml + claim: + $ref: ./AdminClaim.yaml + actions: + type: array + description: The order change's actions. + items: + $ref: ./AdminOrderChangeAction.yaml + status: + type: string + description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined + requested_by: + type: string + title: requested_by + description: The ID of the user that requested the change. + requested_at: + type: string + title: requested_at + description: The date the order change was requested. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The ID of the user that confirmed the order change. + confirmed_at: + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time + declined_by: + type: string + title: declined_by + description: The ID of the user that declined the order change. + declined_reason: + type: string + title: declined_reason + description: The reason the order change was declined. + metadata: + type: object + description: The order change's metadata, can hold custom key-value pairs. + declined_at: + type: string + title: declined_at + description: The date the order change was declined. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The ID of the user that canceled the order change. + canceled_at: + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The date the order change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml new file mode 100644 index 0000000000..3f93eb71ce --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml @@ -0,0 +1,104 @@ +type: object +description: The order change action's details. +x-schemaName: AdminOrderChangeAction +required: + - order_change + - order + - order_id + - internal_note + - id + - created_at + - updated_at + - return_id + - exchange_id + - claim_id + - order_change_id + - reference + - reference_id + - action + - details +properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml index 0126a1ad99..7e5bb2a7d5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangesResponse.yaml @@ -8,4 +8,4 @@ properties: type: array description: An order's changes. items: - $ref: ./BaseOrderChange.yaml + $ref: ./AdminOrderChange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml index ec43c247ff..02858b85ad 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditPreviewResponse.yaml @@ -5,4 +5,4 @@ required: - order_preview properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditResponse.yaml index db40b31387..9cbc0f6528 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderEditResponse.yaml @@ -5,4 +5,4 @@ required: - order_change properties: order_change: - $ref: ./OrderChange.yaml + $ref: ./AdminOrderChange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml new file mode 100644 index 0000000000..e1312673f4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderFulfillment.yaml @@ -0,0 +1,79 @@ +type: object +description: The fulfillment's details. +x-schemaName: AdminOrderFulfillment +required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - requires_shipping + - 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 ID of the location the items are fulfilled from. + packed_at: + type: string + title: packed_at + description: The date the items were packed. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The date the items were shipped. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The date the items were delivered. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The date the items were canceled. + format: date-time + data: + type: object + description: >- + Data useful for the fulfillment provider handling it. This is taken from + the associated shipping option. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider used to handle the fulfillment. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + metadata: + type: object + description: The fulfillment's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the fulfillment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the fulfillment was updated. + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the fulfillment requires shipping. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml new file mode 100644 index 0000000000..41d7121777 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml @@ -0,0 +1,213 @@ +type: object +description: The item's details. +x-schemaName: AdminOrderLineItem +required: + - title + - metadata + - id + - subtitle + - thumbnail + - created_at + - updated_at + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - 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 + - 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 URL of the item's thumbnail. + variant: + $ref: ./AdminProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: ./AdminProduct.yaml + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the collection the item's product belongs to. + 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 values of the item variant's options. + example: + Color: Blue + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + 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: + type: object + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item, excluding promotions. + item_total: + type: number + title: item_total + description: The total taxes of the item, including promotions. + item_subtotal: + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of the item, including promotions. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the item including promotions. + discount_total: + type: number + title: discount_total + description: The total discount amount of the item. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total refundable amount of the item's total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total refundable amount of the item's total for a single quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml index 1d24582bdf..fef57add5b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -7,19 +7,18 @@ required: - return_requested_total - order_change - currency_code - - version - id + - created_at + - updated_at + - email + - 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 @@ -48,7 +47,7 @@ properties: title: return_requested_total description: The total of the requested return. order_change: - $ref: ./BaseOrderChange.yaml + $ref: ./AdminOrderChange.yaml items: type: array description: The order's items. @@ -120,7 +119,7 @@ properties: title: variant_id description: The ID of the associated variant. product: - $ref: ./BaseProduct.yaml + $ref: ./AdminProduct.yaml product_id: type: string title: product_id @@ -181,8 +180,8 @@ properties: description: Whether the item's price includes taxes. compare_at_unit_price: type: number - title: The original price of the item before a promotion or sale. - description: The + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -519,7 +518,7 @@ properties: type: array description: The order's fulfillments. items: - $ref: ./BaseOrderFulfillment.yaml + $ref: ./AdminOrderFulfillment.yaml fulfillment_status: type: string description: The order's fulfillment status. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml new file mode 100644 index 0000000000..ab93242120 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderShippingMethod.yaml @@ -0,0 +1,116 @@ +type: object +description: The shipping method's details. +x-schemaName: AdminOrderShippingMethod +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 ID of the order the shipping method belongs to. + 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: Whether the shipping method's amount includes applied taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: >- + The shipping method's data, useful for fulfillment provider handling its + fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The shipping method's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The total discounts applied on the shipping method. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + detail: + $ref: ./BaseOrderShippingDetail.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 index c03bcea935..2549b218cb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPayment.yaml @@ -86,8 +86,8 @@ properties: type: array description: The details of payment refunds. items: - $ref: ./BaseRefund.yaml + $ref: ./AdminRefund.yaml payment_collection: - $ref: ./BasePaymentCollection.yaml + type: object payment_session: - $ref: ./BasePaymentSession.yaml + $ref: ./AdminPaymentSession.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 index c6fa1d3cac..75d1731804 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentCollection.yaml @@ -2,12 +2,12 @@ type: object description: The payment collection's details. x-schemaName: AdminPaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -70,14 +70,14 @@ properties: The payment provider used to process the collection's payments and sessions. items: - $ref: ./BasePaymentProvider.yaml + $ref: ./AdminPaymentProvider.yaml payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: ./BasePaymentSession.yaml + $ref: ./AdminPaymentSession.yaml payments: type: array description: The payment collection's payments. items: - $ref: ./BasePayment.yaml + $ref: ./AdminPayment.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentSession.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentSession.yaml new file mode 100644 index 0000000000..b87f3a855c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPaymentSession.yaml @@ -0,0 +1,61 @@ +type: object +description: The payment session's details. +x-schemaName: AdminPaymentSession +properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: >- + The payment session's data, useful for the payment provider processing the + payment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: ./BasePayment.yaml +required: + - id + - amount + - currency_code + - provider_id + - data + - status 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 f8bf5ad600..e197602dfa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -2,15 +2,15 @@ type: object description: The product's details. x-schemaName: AdminProduct required: + - variants - type + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - handle - subtitle - is_giftcard @@ -24,9 +24,10 @@ required: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: collection: @@ -73,7 +74,7 @@ properties: type: array description: The product's options. items: - $ref: ./BaseProductOption.yaml + $ref: ./AdminProductOption.yaml description: type: string title: description @@ -151,7 +152,7 @@ properties: type: array description: The product's images. items: - $ref: ./BaseProductImage.yaml + $ref: ./AdminProductImage.yaml discountable: type: boolean title: discountable diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml new file mode 100644 index 0000000000..050650545a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductImage.yaml @@ -0,0 +1,33 @@ +type: object +description: The image's details. +x-schemaName: AdminProductImage +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. +required: + - id + - url diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml index bb9c3717ae..415115c416 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOption.yaml @@ -1,5 +1,5 @@ type: object -description: The product's product option. +description: The product option's details. x-schemaName: AdminProductOption required: - id @@ -14,31 +14,31 @@ properties: title: title description: The product option's title. product: - $ref: ./BaseProduct.yaml + type: object product_id: type: string title: product_id - description: The product option's product id. + description: The ID of the product this option belongs to. values: type: array description: The product option's values. items: - $ref: ./BaseProductOptionValue.yaml + type: object metadata: type: object - description: The product option's metadata. + description: The product option's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The product option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The product option's deleted at. + description: The date the product option was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml index 0873a46f9a..0069070c06 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product option deletion. x-schemaName: AdminProductOptionDeleteResponse required: - id @@ -9,14 +9,15 @@ properties: id: type: string title: id - description: The product's ID. + description: The product option's ID. object: type: string title: object description: The name of the deleted object. + default: product_option deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product option was deleted. parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml index c609e7d1d8..79d305a5d3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product option's details. x-schemaName: AdminProductOptionResponse required: - product_option diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml new file mode 100644 index 0000000000..88175464a4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductOptionValue.yaml @@ -0,0 +1,39 @@ +type: object +description: The product option value's details. +x-schemaName: AdminProductOptionValue +required: + - id + - value +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + $ref: ./AdminProductOption.yaml + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml index 1c3d489857..5b4cd3889b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product's details. x-schemaName: AdminProductResponse required: - product diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml index c9dfaff0fb..7fc320de89 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTag.yaml @@ -1,5 +1,5 @@ type: object -description: The tag's tags. +description: The product tag's details. x-schemaName: AdminProductTag required: - id @@ -19,17 +19,17 @@ properties: type: string format: date-time title: created_at - description: The tag's created at. + description: The date the tag was created. updated_at: type: string format: date-time title: updated_at - description: The tag's updated at. + description: The date the tag was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tag's deleted at. + description: The date the tag was deleted. metadata: type: object - description: The tag's metadata. + description: The tag's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml index 33697dcfd2..b09f96dd0f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product tag deletion. x-schemaName: AdminProductTagDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product Tag was deleted. + description: Whether the product tag was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml index 40accb6692..72220d7041 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product tags. x-schemaName: AdminProductTagListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product tag's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product tag's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product tag's count. + description: The total number of items. product_tags: type: array - description: The product tag's product tags. + description: The list of 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 index 47fe1ad408..4ae92f3bef 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTagResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product tag's details. x-schemaName: AdminProductTagResponse required: - product_tag diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml index a8d58344ea..ef5f2ece56 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductType.yaml @@ -1,5 +1,5 @@ type: object -description: The parent's type. +description: The product type's details. x-schemaName: AdminProductType required: - id @@ -19,17 +19,17 @@ properties: type: string format: date-time title: created_at - description: The type's created at. + description: The date the type was created. updated_at: type: string format: date-time title: updated_at - description: The type's updated at. + description: The date the type was updated. deleted_at: type: string format: date-time title: deleted_at - description: The type's deleted at. + description: The date the type was deleted. metadata: type: object - description: The type's metadata. + description: The type's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml index 797b5fd754..4526de1ff6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product type deletion. x-schemaName: AdminProductTypeDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product Type was deleted. + description: Whether the product type was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml index 9bf9f9159f..19fa220fe9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product types. x-schemaName: AdminProductTypeListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product type's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product type's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product type's count. + description: The total number of items. product_types: type: array - description: The product type's product types. + description: The list of product types. items: $ref: ./AdminProductType.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 index 8daf16a292..d0907f2d65 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductTypeResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product type's details. x-schemaName: AdminProductTypeResponse required: - product_type 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 8e82d12e9d..702673830d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -1,8 +1,9 @@ type: object -description: The product's parent. +description: The product variant's details. x-schemaName: AdminProductVariant required: - prices + - options - id - title - sku @@ -19,116 +20,119 @@ required: - length - height - width - - options - created_at - updated_at - deleted_at properties: prices: type: array - description: The parent's prices. + description: The variant's prices. items: $ref: ./AdminPrice.yaml id: type: string title: id - description: The parent's ID. + description: The variant's ID. title: type: string title: title - description: The parent's title. + description: The variant's title. sku: type: string title: sku - description: The parent's sku. + description: The variant's SKU. barcode: type: string title: barcode - description: The parent's barcode. + description: The variant's barcode. ean: type: string title: ean - description: The parent's ean. + description: The variant's EAN code. upc: type: string title: upc - description: The parent's upc. + description: The variant's UPC. allow_backorder: type: boolean title: allow_backorder - description: The parent's allow backorder. + description: Whether the variant can be ordered even if it's out of stock. manage_inventory: type: boolean title: manage_inventory - description: The parent's manage inventory. + description: >- + Whether the Medusa application manages the variant's inventory quantity + and availablility. If disabled, the variant is always considered in stock. inventory_quantity: type: number title: inventory_quantity - description: The parent's inventory quantity. + description: >- + The variant's inventory quantity. This is only included if you pass in the + `fields` query parameter a `+variants.inventory_quantity` parameter. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The variant's HS code. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The variant's origin country. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The variant's MID code. material: type: string title: material - description: The parent's material. + description: The variant's material. weight: type: number title: weight - description: The parent's weight. + description: The variant's weight. length: type: number title: length - description: The parent's length. + description: The variant's length. height: type: number title: height - description: The parent's height. + description: The variant's height. width: type: number title: width - description: The parent's width. + description: The variant's width. variant_rank: type: number title: variant_rank - description: The parent's variant rank. + description: The variant's rank among its sibling variants. options: type: array - description: The parent's options. + description: The variant's option values. items: - $ref: ./BaseProductOptionValue.yaml + $ref: ./AdminProductOptionValue.yaml product: - $ref: ./BaseProduct.yaml + type: object product_id: type: string title: product_id - description: The parent's product id. + description: The ID of the product that the variant belongs to. calculated_price: $ref: ./BaseCalculatedPriceSet.yaml created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the variant was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the variant was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the variant was deleted. metadata: type: object - description: The parent's metadata. + description: The variant's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml index 52094f9db2..01b28d3e65 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product variant's deletion. x-schemaName: AdminProductVariantDeleteResponse required: - id @@ -9,7 +9,7 @@ properties: id: type: string title: id - description: The product's ID. + description: The product variant's ID. object: type: string title: object @@ -17,6 +17,7 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product variant was deleted. + default: variant parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml index 9cf2e1c985..bf33c4a708 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryBatchResponse.yaml @@ -1,5 +1,7 @@ type: object -description: SUMMARY +description: >- + The created, updated, and deleted associations between variants and inventory + items. x-schemaName: AdminProductVariantInventoryBatchResponse required: - created @@ -10,10 +12,12 @@ properties: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: The product's created. + description: The created associations between product variants and inventory items. items: type: object - description: The created's details. + description: >- + A created association between a product variant and an inventory + item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -21,32 +25,34 @@ properties: properties: productService: type: object - description: The created's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The created's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. updated: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: The product's updated. + description: The updated associations between product variants and inventory items. items: type: object - description: The updated's details. + description: >- + An updated association between a product variant and an inventory + item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -54,32 +60,34 @@ properties: properties: productService: type: object - description: The updated's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The updated's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. deleted: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: SUMMARY + description: The deleted associations between product variants and inventory items. items: type: object - description: SUMMARY + description: >- + An deleted association between a product variant and an inventory + item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -87,21 +95,21 @@ properties: properties: productService: type: object - description: The deleted's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The deleted's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml index e5938e984d..d3aa5709dc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLink.yaml @@ -1,27 +1,27 @@ type: object -description: The product's ID. +description: The details of an association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - - productService - - inventoryService + - Product + - Inventory properties: - productService: + Product: type: object - description: The id's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. - inventoryService: + description: The ID of the product variant. + Inventory: type: object - description: The id's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml index ba2ab976f9..377a954ac4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml @@ -1,5 +1,7 @@ type: object -description: SUMMARY +description: >- + The details of the deleted associated between a product variant and an + inventory item. x-schemaName: AdminProductVariantInventoryLinkDeleteResponse required: - id @@ -13,9 +15,10 @@ properties: type: string title: object description: The name of the deleted object. + default: variant-inventory-item-link deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the association was 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 deleted file mode 100644 index 6ea415b06d..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantParams.yaml +++ /dev/null @@ -1,872 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminProductVariantParams -properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. - items: - type: string - title: id - description: The id's ID. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - created_at: - type: object - description: The product's created at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers - and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful - for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers and - dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful for - numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - updated_at: - type: object - description: The product's updated at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers - and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful - for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers and - dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful for - numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - deleted_at: - type: object - description: The product's deleted at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers - and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful - for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers and - dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful for - numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - limit: - type: number - title: limit - description: The product's limit. - offset: - type: number - title: offset - description: The product's offset. - order: - type: string - title: order - description: The product's order. - fields: - type: string - title: fields - description: The product's fields. - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $or diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml index cb5298721d..8bd93d75bc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariantResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product variant's details. x-schemaName: AdminProductVariantResponse required: - variant diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml index 2a31b4ded7..78c1a5b3fb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotion.yaml @@ -4,6 +4,13 @@ x-schemaName: AdminPromotion required: - id properties: + application_method: + type: object + rules: + type: array + description: The promotion's rules. + items: + $ref: ./AdminPromotionRule.yaml id: type: string title: id @@ -12,6 +19,7 @@ properties: type: string title: code description: The promotion's code. + example: OFF50 type: type: string description: The promotion's type. @@ -21,17 +29,12 @@ properties: 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 + description: >- + Whether the promotion is applied on a cart automatically if it matches the + promotion's rules. campaign_id: type: string title: campaign_id - description: The promotion's campaign id. + description: The ID of the campaign this promotion belongs to. campaign: $ref: ./AdminCampaign.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 index 3a4255fe94..76ea15b558 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The promotion's details. x-schemaName: AdminPromotionResponse required: - promotion diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml index 010bb3dc39..30666b43dd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPromotionRule.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's details. +description: The promotion rule's details. x-schemaName: AdminPromotionRule required: - id @@ -8,18 +8,19 @@ properties: id: type: string title: id - description: The updated's ID. + description: The promotion rule's ID. description: type: string title: description - description: The updated's description. + description: The promotion rule's description. attribute: type: string title: attribute - description: The updated's attribute. + description: The promotion rule's attribute. + example: customer_group_id operator: type: string - description: The updated's operator. + description: The rule's operator. enum: - gt - lt @@ -30,6 +31,8 @@ properties: - gte values: type: array - description: The updated's values. + description: The rule's values. + example: + - cusgroup_123 items: $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRefund.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRefund.yaml new file mode 100644 index 0000000000..229fb7729c --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRefund.yaml @@ -0,0 +1,38 @@ +type: object +description: The refund's details. +x-schemaName: AdminRefund +required: + - id + - amount + - created_at + - payment +properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + $ref: ./BasePayment.yaml + refund_reason: + $ref: ./RefundReason.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 index 3110520654..919bb56bfa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRefundReason.yaml @@ -22,14 +22,14 @@ properties: description: The refund reason's description. metadata: type: object - description: The refund reason's metadata. + description: The refund reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The refund reason's created at. + description: The date the refund reason was created. updated_at: type: string format: date-time title: updated_at - description: The refund reason's updated at. + description: The date the refund reason was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml index 0ad92660d5..96b6ff979c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegion.yaml @@ -2,9 +2,9 @@ type: object description: The region's details. x-schemaName: AdminRegion required: - - id - name - currency_code + - id properties: id: type: string @@ -18,15 +18,16 @@ properties: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are applied automatically during checkout. countries: type: array description: The region's countries. items: - $ref: ./BaseRegionCountry.yaml + $ref: ./AdminRegionCountry.yaml payment_providers: type: array description: The region's payment providers. @@ -34,14 +35,14 @@ properties: $ref: ./AdminPaymentProvider.yaml metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml index 04938da440..88ca70090b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionCountry.yaml @@ -1,3 +1,33 @@ type: object -description: The billing address's country. +description: The country's details. x-schemaName: AdminRegionCountry +required: + - id +properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml index fc2373ff77..390c84603e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRegionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The region's details. x-schemaName: AdminRegionResponse required: - region diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml index df021b64bd..2b75d1102d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservation.yaml @@ -9,7 +9,6 @@ required: - external_id - description - inventory_item_id - - inventory_item properties: id: type: string @@ -18,11 +17,11 @@ properties: line_item_id: type: string title: line_item_id - description: The reservation's line item id. + description: The ID of the line item this reservation is for. location_id: type: string title: location_id - description: The reservation's location id. + description: The ID of the location the quantity is reserved from. quantity: type: number title: quantity @@ -30,7 +29,7 @@ properties: external_id: type: string title: external_id - description: The reservation's external id. + description: An ID in an external system description: type: string title: description @@ -38,29 +37,28 @@ properties: inventory_item_id: type: string title: inventory_item_id - description: The reservation's inventory item id. + description: The ID of the inventory item this reservation is associated with. inventory_item: - type: object - description: The reservation's inventory item. + $ref: ./AdminInventoryItem.yaml metadata: type: object - description: The reservation's metadata. + description: The reservation's metadata, can hold custom key-value pairs. created_by: type: string title: created_by - description: The reservation's created by. + description: The ID of the user that created this reservation. deleted_at: type: string format: date-time title: deleted_at - description: The reservation's deleted at. + description: The date this reservation was deleted. created_at: type: string format: date-time title: created_at - description: The reservation's created at. + description: The date this reservation was created. updated_at: type: string format: date-time title: updated_at - description: The reservation's updated at. + description: The date this reservation was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml index 42075fd8ac..4db926c72b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReservationResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The reservation's details. x-schemaName: AdminReservationResponse required: - reservation diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml index 0ef197d0f7..6ff3c2867d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturn.yaml @@ -1,12 +1,12 @@ type: object -description: The exchange's return. +description: The return's details. x-schemaName: AdminReturn required: + - items - id - order_id - order_version - display_id - - items - received_at - created_at - canceled_at @@ -15,14 +15,37 @@ properties: type: string title: id description: The return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. order_id: type: string title: order_id - description: The return's order id. - status: + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: ./AdminReturnItem.yaml + created_at: type: string - title: status - description: The return's status. + format: date-time + title: created_at + description: The date the return was created. + canceled_at: + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time exchange_id: type: string title: exchange_id @@ -46,26 +69,10 @@ properties: 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 + description: >- + Whether the customer should receive notifications about the return's + updates. 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. - canceled_at: - type: string - title: canceled_at - description: The return's canceled at. + description: The date the return was received. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml index 47cbe93e16..96691fc7ca 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnItem.yaml @@ -1,5 +1,5 @@ type: object -description: The return item's return items. +description: The return item's details. x-schemaName: AdminReturnItem required: - id @@ -20,27 +20,31 @@ properties: received_quantity: type: number title: received_quantity - description: The return item's received quantity. + description: >- + The received quantity of the item. This quantity is added to the stocked + inventory quantity of the item. damaged_quantity: type: number title: damaged_quantity - description: The return item's damaged quantity. + description: >- + The received damaged quantity of the item, which isn't added to the + stocked inventory quantity of the item. reason_id: type: string title: reason_id - description: The return item's reason id. + description: The ID of the return reason associated with the item. note: type: string title: note - description: The return item's note. + description: A note about why the item was returned. item_id: type: string title: item_id - description: The return item's item id. + description: The ID of the associated order item. return_id: type: string title: return_id - description: The return item's return id. + description: The ID of the return this return item belongs to. metadata: type: object - description: The return item's metadata. + description: The return item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml index 8b8734b2fe..a7958ba7de 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnPreviewResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of a return and a preview of the order once the return is applied. x-schemaName: AdminReturnPreviewResponse required: - order_preview diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml index 3046e2a254..7de3166b71 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReason.yaml @@ -26,14 +26,14 @@ properties: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml index 3743526610..7d69be5a27 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the return reason deletion. x-schemaName: AdminReturnReasonDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Return Reason was deleted. + description: Whether the return reason was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml index 0fa69fc517..4f931ef219 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of return reasons. x-schemaName: AdminReturnReasonListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The return reason's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The return reason's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The return reason's count. + description: The total number of items. return_reasons: type: array - description: The return reason's return reasons. + description: The list of 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 index 9b3ad0f9a4..513915d0c3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnReasonResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return reason's details. x-schemaName: AdminReturnReasonResponse required: - return_reason diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml index 8ce9535394..3e0fe4d159 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminReturnResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: AdminReturnResponse required: - return diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml index 7e99903e5b..af00ccb2fe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRevokeApiKey.yaml @@ -1,8 +1,10 @@ type: object -description: SUMMARY +description: The details of revoking the API key. x-schemaName: AdminRevokeApiKey properties: revoke_in: type: number title: revoke_in - description: The api key's revoke in. + description: >- + The time in seconds to revoke the API key after. If not set, the API key + is revoked immediately. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml index 8ca5eaabf3..53359ab0b4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleAttributeOption.yaml @@ -1,39 +1,27 @@ type: object -description: The attribute's attributes. +description: The details of a potential rule attribute. x-schemaName: AdminRuleAttributeOption required: - id - value - label - - field_type - - required - - disguised - operators properties: id: type: string title: id - description: The attribute's ID. + description: The rule attribute's ID, which is a rule's `attribute` it refers to. + example: customer_group value: type: string title: value - description: The attribute's value. + description: The rule attribute's value. + example: customer.groups.id 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. + description: The rule attribute option's label. + example: Customer Group operators: type: array description: The attribute's operators. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml index cb8776ea83..fbfa2d15c8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminRuleValueOption.yaml @@ -1,20 +1,17 @@ type: object -description: The value's values. +description: The details of a potential rule value. 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. + description: The rule value's value. + example: reg_123 label: type: string title: label - description: The value's label. + description: The rule value's label. + example: Europe Region diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml index 9b497e936c..2311a9b687 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannel.yaml @@ -1,5 +1,5 @@ type: object -description: The order's sales channel. +description: The sales channel's details. x-schemaName: AdminSalesChannel required: - id @@ -26,22 +26,22 @@ properties: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The sales channel's created at. + description: The date the sales channel was created. updated_at: type: string format: date-time title: updated_at - description: The sales channel's updated at. + description: The date the sales channel was updated. deleted_at: type: string format: date-time title: deleted_at - description: The sales channel's deleted at. + description: The date the sales channel was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml index fc93322002..0c2d3161a8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of deleting a sales channel. x-schemaName: AdminSalesChannelDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Sales Channel was deleted. + description: Whether the sales channel was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml index baeb779f03..bd930a26a7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminSalesChannelResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The sales channel's details. x-schemaName: AdminSalesChannelResponse required: - sales_channel 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 d0dff34efc..425c15722a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZone.yaml @@ -1,5 +1,5 @@ type: object -description: The service zone's service zones. +description: The shipping option's service zone. x-schemaName: AdminServiceZone required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml index 488b2b6081..7f3224a432 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the service zone deletion. x-schemaName: AdminServiceZoneDeleteResponse required: - id @@ -9,14 +9,15 @@ properties: id: type: string title: id - description: The fulfillment set's ID. + description: The service zone's ID. object: type: string title: object description: The name of the deleted object. + default: service_zone deleted: type: boolean title: deleted - description: Whether the Fulfillment Set was deleted. + description: Whether the service zone was deleted. parent: $ref: ./AdminFulfillmentSet.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml index dd8ff8c8d1..32685446d3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminServiceZoneResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The service zone's details. x-schemaName: AdminServiceZoneResponse required: - service_zone diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml index 219dac6bdc..7cb57ee389 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOption.yaml @@ -1,3 +1,105 @@ type: object -description: The shipping option's shipping options. +description: The shipping option's details. x-schemaName: AdminShippingOption +required: + - id + - name + - price_type + - service_zone_id + - service_zone + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - shipping_profile + - rules + - prices + - data + - metadata + - created_at + - updated_at + - deleted_at +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 + description: >- + The shipping option's price type. If it's `flat`, the price is fixed and + is set in the `prices` property. If it's `calculated`, the price is + calculated on checkout by the associated fulfillment provider. + enum: + - calculated + - flat + service_zone_id: + type: string + title: service_zone_id + description: The ID of the service zone this option belongs to. + service_zone: + type: object + provider_id: + type: string + title: provider_id + description: >- + The ID of the provider handling fulfillments created from this shipping + option. + provider: + $ref: ./AdminFulfillmentProvider.yaml + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The ID of the associated shipping option type. + type: + $ref: ./AdminShippingOptionType.yaml + shipping_profile_id: + type: string + title: shipping_profile_id + description: The ID of the associated shipping profile. + shipping_profile: + $ref: ./AdminShippingProfile.yaml + rules: + type: array + description: The shipping option's rules. + items: + $ref: ./AdminShippingOptionRule.yaml + prices: + type: array + description: >- + The shipping option's prices. If the `price_type` is `calculated`, this + array will be empty since the price is calculated by the fulfillment + provider during checkout. + items: + $ref: ./AdminShippingOptionPrice.yaml + data: + type: object + description: >- + The shipping option's data, useful for the fulfillment provider handling + fulfillments created from this option. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml index 141ba6526b..459667c5ec 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the shipping option's deletion. x-schemaName: AdminShippingOptionDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Shipping Option was deleted. + description: Whether the shipping option was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPrice.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPrice.yaml new file mode 100644 index 0000000000..95f76292c0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPrice.yaml @@ -0,0 +1,76 @@ +type: object +description: The details of the shipping option's price. +x-schemaName: AdminShippingOptionPrice +required: + - price_rules + - rules_count + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at +properties: + price_rules: + type: array + description: The price's rules. + items: + $ref: ./AdminShippingOptionPriceRule.yaml + rules_count: + type: number + title: rules_count + description: The number of rules the price has. + 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. + example: usd + 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 minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: >- + The maximum quantity that the cart's items must not surpass for this price + to apply. + price_set_id: + type: string + title: price_set_id + description: The ID of the price set this price belongs to. + created_at: + type: string + format: date-time + title: created_at + description: The date the price was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the price was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the price was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPriceRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPriceRule.yaml new file mode 100644 index 0000000000..a705731a41 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionPriceRule.yaml @@ -0,0 +1,15 @@ +type: object +description: The details of a shipping option price's rule. +x-schemaName: AdminShippingOptionPriceRule +required: + - id + - value +properties: + id: + type: string + title: id + description: The price rule's ID. + value: + type: string + title: value + description: The price rule's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml index dba509d7fd..b0b01a94ab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping option's details. x-schemaName: AdminShippingOptionResponse required: - shipping_option diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml index ed10fb27e4..26069d9a56 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionRule.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's details. +description: The shipping option rule's details. x-schemaName: AdminShippingOptionRule required: - id @@ -14,42 +14,46 @@ properties: id: type: string title: id - description: The updated's ID. + description: The shipping option rule's ID. attribute: type: string title: attribute - description: The updated's attribute. + description: The shipping option rule's attribute. + example: is_return operator: type: string title: operator - description: The updated's operator. + description: The shipping option rule's operator. + example: eq value: oneOf: - type: string title: value - description: The updated's value. + description: The rule's value. + example: '"true"' - type: array - description: The updated's value. + description: The rule's values. items: type: string title: value - description: The value's details. + description: A rule's value + example: '"true"' shipping_option_id: type: string title: shipping_option_id - description: The updated's shipping option id. + description: The ID of the shipping option this rule is for. created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The date the shipping option rule was created. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The date the shipping option rule was updated. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The date the shipping option rule was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionType.yaml new file mode 100644 index 0000000000..9aa2063d7e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingOptionType.yaml @@ -0,0 +1,48 @@ +type: object +description: The shipping option's details. +x-schemaName: AdminShippingOptionType +required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The shipping option's ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The type's shipping option id. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml index 29549d5ff2..1dc31c1b5b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfile.yaml @@ -1,3 +1,42 @@ type: object -description: The shipping option's shipping profile. +description: The shipping profile's details.. x-schemaName: AdminShippingProfile +properties: + id: + type: string + title: id + description: The shipping profile's ID. + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata, holds custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping profile was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping profile was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping profile was deleted. +required: + - id + - name + - type + - metadata + - created_at + - updated_at + - deleted_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml index bca17d5e8b..ed0e931fd6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the shipping profile's deletion. x-schemaName: AdminShippingProfileDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Shipping Profile was deleted. + description: Whether the shipping profile was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml index ce83a08372..00fa3dc1ab 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminShippingProfileResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping profile's details. x-schemaName: AdminShippingProfileResponse required: - shipping_profile diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml index 76f80ec99c..d9a9fedf99 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocation.yaml @@ -1,5 +1,5 @@ type: object -description: The parent's location. +description: The stock location's details. x-schemaName: AdminStockLocation required: - id @@ -17,21 +17,21 @@ properties: address_id: type: string title: address_id - description: The location's address id. + description: The ID of the associated address. address: $ref: ./AdminStockLocationAddress.yaml sales_channels: type: array - description: The location's sales channels. + description: The sales channels associated with the location. items: $ref: ./AdminSalesChannel.yaml fulfillment_providers: type: array - description: The location's fulfillment providers. + description: The fulfillment providers associated with the location. items: $ref: ./AdminFulfillmentProvider.yaml fulfillment_sets: type: array - description: The location's fulfillment sets. + description: The fulfillment sets associated with the location. 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 index 03be8aa3dd..22dc78b1d4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationAddress.yaml @@ -1,3 +1,51 @@ type: object -description: The location's address. +description: The details of the stock location address. x-schemaName: AdminStockLocationAddress +properties: + id: + type: string + title: id + description: The address's ID. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. +required: + - id + - address_1 + - address_2 + - company + - country_code + - city + - phone + - postal_code + - province diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml index 7d1160157d..cb05f2704a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the stock location's deletion. x-schemaName: AdminStockLocationDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Stock Location was deleted. + description: Whether the stock location was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml index f8181758b1..9f23c06060 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of stock locations. x-schemaName: AdminStockLocationListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The stock location's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The stock location's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The stock location's count. + description: The total number of items. stock_locations: type: array - description: The stock location's stock locations. + description: The list of 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 index 68d6a4db18..19f1d66a39 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStockLocationResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The stock location's details. x-schemaName: AdminStockLocationResponse required: - stock_location diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml index a56500fc7b..32f483dc82 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStore.yaml @@ -28,25 +28,25 @@ properties: default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the sales channel used by default in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the region used by default in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the stock location used by default in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The store's created at. + description: The date the store was created. updated_at: type: string format: date-time title: updated_at - description: The store's updated at. + description: The date the store was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml index 5014c7b7bc..a0e2ccb92d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreCurrency.yaml @@ -1,5 +1,5 @@ type: object -description: The supported currency's supported currencies. +description: The details of a store's currency. x-schemaName: AdminStoreCurrency required: - id @@ -14,33 +14,34 @@ properties: id: type: string title: id - description: The supported currency's ID. + description: The currency's ID. currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd store_id: type: string title: store_id - description: The supported currency's store id. + description: The ID of the store this currency belongs to. is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether this currency is the default in the store. currency: $ref: ./AdminCurrency.yaml created_at: type: string format: date-time title: created_at - description: The supported currency's created at. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The supported currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The supported currency's deleted at. + description: The date the currency was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml index 33099c28f1..639f93778b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of stores. x-schemaName: AdminStoreListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The store's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The store's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The store's count. + description: The total number of items. stores: type: array - description: The store's stores. + description: The list of 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 index c24cc35690..d335ebde98 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminStoreResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminStoreResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The store's details. x-schemaName: AdminStoreResponse required: - store diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml index f0321f5651..7972123ffe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRate.yaml @@ -1,5 +1,5 @@ type: object -description: The tax rate's parent. +description: The tax rate's details. x-schemaName: AdminTaxRate required: - id @@ -20,57 +20,61 @@ properties: id: type: string title: id - description: The parent's ID. + description: The tax rate's ID. rate: type: number title: rate - description: The parent's rate. + description: The rate to charge. + example: 10 code: type: string title: code - description: The parent's code. + description: The code the tax rate is identified by. name: type: string title: name - description: The parent's name. + description: The tax rate's name. metadata: type: object - description: The parent's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. tax_region_id: type: string title: tax_region_id - description: The parent's tax region id. + description: The ID of the tax region this rate belongs to. is_combinable: type: boolean title: is_combinable - description: The parent's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates is_default: type: boolean title: is_default - description: The parent's is default. + description: Whether this tax rate is the default in the tax region. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the tax rate was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the tax rate was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the tax rate was deleted. created_by: type: string title: created_by - description: The parent's created by. + description: The ID of the user that created the tax rate. tax_region: $ref: ./AdminTaxRegion.yaml rules: type: array - description: The parent's rules. + 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 index 6c284786d9..88c4b0ebb1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the tax rate deletion. x-schemaName: AdminTaxRateDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Tax Rate was deleted. + description: Whether the tax rate was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml index 2dd828e446..e4888f9c3a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The tax rate's details. x-schemaName: AdminTaxRateResponse required: - tax_rate diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml index 8e0ff14b5d..2d88ad2ed8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRateRule.yaml @@ -1,5 +1,5 @@ type: object -description: The rule's rules. +description: The tax rate rule's details. x-schemaName: AdminTaxRateRule required: - reference @@ -8,8 +8,10 @@ properties: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of a record in the table that this rule references. + example: ptyp_1 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml index 5ee5e6b8e0..0c5867f445 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegion.yaml @@ -1,17 +1,11 @@ type: object -description: The parent's tax region. +description: The tax region's details. 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 @@ -25,67 +19,44 @@ properties: 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. + example: us 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. + description: The tax region's metadata, can hold custom key-value pairs. parent_id: type: string title: parent_id - description: The tax region's parent id. + description: The ID of the parent tax region. created_at: type: string format: date-time title: created_at - description: The tax region's created at. + description: The date the tax region was created. updated_at: type: string format: date-time title: updated_at - description: The tax region's updated at. + description: The date the tax region was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tax region's deleted at. + description: The date the tax region was deleted. created_by: type: string title: created_by - description: The tax region's created by. + description: The ID of the user that created the tax region. tax_rates: type: array - description: The tax region's tax rates. + description: The tax region's rates. items: type: object parent: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml index 235dd86a80..be8ab35c7c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the tax region deletion. x-schemaName: AdminTaxRegionDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Tax Region was deleted. + description: Whether the tax region was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml index 0c200e26d0..b1cfcf7062 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminTaxRegionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The tax region's details. x-schemaName: AdminTaxRegionResponse required: - tax_region diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml index 1858893589..2f9911872e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateApiKey.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in an API key. x-schemaName: AdminUpdateApiKey required: - title @@ -7,4 +7,4 @@ properties: title: type: string title: title - description: The api key's title. + description: The API key's title. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml index 22a9be4f57..63cfe987d0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in a collection. x-schemaName: AdminUpdateCollection properties: title: @@ -12,4 +12,4 @@ properties: description: The collection's handle. metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml index acb0253445..57fb90e715 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in a customer group. x-schemaName: AdminUpdateCustomerGroup properties: name: @@ -8,4 +8,4 @@ properties: description: The customer group's name. metadata: type: object - description: The customer group's metadata. + description: The customer group's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml index 97688d7c5f..449d7f76e4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: the details to update in a price list. x-schemaName: AdminUpdatePriceList properties: title: @@ -13,11 +13,11 @@ properties: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -33,3 +33,6 @@ properties: rules: type: object description: The price list's rules. + example: + customer_group_id: + - cusgrp_123 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePricePreference.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePricePreference.yaml index 0c5f879d8f..cc04155d19 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePricePreference.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePricePreference.yaml @@ -1,16 +1,18 @@ type: object -description: SUMMARY +description: The details to update in the price preference. x-schemaName: AdminUpdatePricePreference properties: attribute: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices are tax inclusive for this price preference. 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 844455161e..6d17d3a72f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProduct.yaml @@ -1,51 +1,51 @@ type: object -description: The update's details. +description: The product's details. x-schemaName: AdminUpdateProduct properties: title: type: string title: title - description: The update's title. + description: The product's title. subtitle: type: string title: subtitle - description: The update's subtitle. + description: The product's subtitle. description: type: string title: description - description: The update's description. + description: The product's description. is_giftcard: type: boolean title: is_giftcard - description: The update's is giftcard. + description: Whether the product is a gift card. discountable: type: boolean title: discountable - description: The update's discountable. + description: Whether discounts can be applied on the product. images: type: array - description: The update's images. + description: The product's images. items: type: object - description: The image's images. + description: The image's details. required: - url properties: url: type: string title: url - description: The image's url. + description: The image's URL. thumbnail: type: string title: thumbnail - description: The update's thumbnail. + description: The product's thumbnail URL. handle: type: string title: handle - description: The update's handle. + description: The product's unique handle. status: type: string - description: The update's status. + description: The product's status. enum: - draft - proposed @@ -54,17 +54,17 @@ properties: type_id: type: string title: type_id - description: The update's type id. + description: The ID of the product's type. collection_id: type: string title: collection_id - description: The update's collection id. + description: The ID of the product's collection. categories: type: array - description: The update's categories. + description: The product's categories. items: type: object - description: The category's categories. + description: The product's category. required: - id properties: @@ -74,10 +74,10 @@ properties: description: The category's ID. tags: type: array - description: The update's tags. + description: The product's tags. items: type: object - description: The tag's tags. + description: The product's tag. required: - id properties: @@ -87,181 +87,24 @@ properties: description: The tag's ID. options: type: array - description: The update's options. + description: The product's options. items: $ref: ./AdminUpdateProductOption.yaml variants: type: array - description: The update's variants. + description: >- + The product's variants. You can add new variants or update existing ones, + passing their IDs in the object. items: 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. + - $ref: ./AdminCreateProductVariant.yaml + - $ref: ./AdminUpdateProductVariant.yaml sales_channels: type: array - description: The update's sales channels. + description: The sales channels that the product is available in. items: type: object - description: The sales channel's sales channels. + description: The sales channel's details. required: - id properties: @@ -272,35 +115,35 @@ properties: weight: type: number title: weight - description: The update's weight. + description: The product's weight. length: type: number title: length - description: The update's length. + description: The product's length. height: type: number title: height - description: The update's height. + description: The product's height. width: type: number title: width - description: The update's width. + description: The product's width. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product's MID code. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product's origin country. material: type: string title: material - description: The update's material. + description: The product's material. metadata: type: object - description: The update's metadata. + description: The product's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml index bfdca1a5cb..046aa99815 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductOption.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The details to update in a product option. x-schemaName: AdminUpdateProductOption properties: title: type: string title: title - description: The product's title. + description: The option's title. values: type: array - description: The product's values. + description: The option's values. items: type: string title: values - description: The value's values. + description: An option value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml index c0429b85e9..59f99cff83 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateProductVariant.yaml @@ -1,79 +1,81 @@ type: object -description: The update's details. +description: The properties to update of a product variant. x-schemaName: AdminUpdateProductVariant properties: title: type: string title: title - description: The update's title. + description: The product variant's title. sku: type: string title: sku - description: The update's sku. + description: The product variant's SKU. ean: type: string title: ean - description: The update's ean. + description: The product variant's EAN. upc: type: string title: upc - description: The update's upc. + description: The product variant's UPC. barcode: type: string title: barcode - description: The update's barcode. + description: The product variant's barcode. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product variant's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product variant's MID code. allow_backorder: type: boolean title: allow_backorder - description: The update's allow backorder. + description: Whether customers can order the variant even if it's not in stock. manage_inventory: type: boolean title: manage_inventory - description: The update's manage inventory. + description: >- + Whether the Medusa application manages the variant's inventory. If + disabled, the product variant is always considered in stock. variant_rank: type: number title: variant_rank - description: The update's variant rank. + description: The product variant's rank among its siblings. weight: type: number title: weight - description: The update's weight. + description: The product variant's weight. length: type: number title: length - description: The update's length. + description: The product variant's length. height: type: number title: height - description: The update's height. + description: The product variant's height. width: type: number title: width - description: The update's width. + description: The product variant's width. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product variant's origin country. material: type: string title: material - description: The update's material. + description: The product variant's material. metadata: type: object - description: The update's metadata. + description: The product variant's metadata, can hold custom key-value pairs. prices: type: array - description: The update's prices. + description: The product variant's prices. items: $ref: ./AdminCreateProductVariantPrice.yaml options: type: object - description: The update's options. + description: The product variant's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePromotionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePromotionRule.yaml new file mode 100644 index 0000000000..27f09bd9b7 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePromotionRule.yaml @@ -0,0 +1,49 @@ +type: object +description: The properties to update in a buy rule. +required: + - id + - values +properties: + id: + type: string + title: id + description: The buy rule's ID. + operator: + type: string + description: >- + The operator used to check whether the buy rule applies on a cart. For + example, `eq` means that the cart's value for the specified attribute must + match the specified value. + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: >- + The attribute to compare against when checking whether a promotion can be + applied on a cart. + example: items.product.id + values: + oneOf: + - type: string + title: values + description: The attribute's value. + example: prod_123 + - type: array + description: The allowed attribute values. + items: + type: string + title: values + description: An attribute value. + example: prod_123 +x-schemaName: AdminUpdatePromotionRule diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateOrderReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml similarity index 62% rename from www/apps/api-reference/specs/store/components/schemas/UpdateOrderReturnReason.yaml rename to www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml index 581ad731dc..3299988196 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateOrderReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateReturnReason.yaml @@ -1,11 +1,7 @@ type: object -description: SUMMARY -x-schemaName: UpdateOrderReturnReason +description: The details to update in a return reason. +x-schemaName: AdminUpdateReturnReason properties: - id: - type: string - title: id - description: The return reason's ID. label: type: string title: label @@ -20,4 +16,7 @@ properties: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. +required: + - value + - label diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml index 8f30103306..db5e76e560 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in the sales channel. x-schemaName: AdminUpdateSalesChannel properties: name: @@ -13,7 +13,7 @@ properties: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOptionRule.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOptionRule.yaml new file mode 100644 index 0000000000..96a09b2d5a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateShippingOptionRule.yaml @@ -0,0 +1,43 @@ +type: object +description: The properties to update in the shipping option rule. +required: + - id + - operator + - attribute + - value +properties: + id: + type: string + title: id + description: The rule's ID. + operator: + type: string + description: The operator used to check whether a rule applies. + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The name of a property or table that the rule applies to. + example: customer_group + value: + oneOf: + - type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 + - type: array + description: Values of the attribute that enable this rule. + items: + type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 +x-schemaName: AdminUpdateShippingOptionRule diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml index 2312fd5e3c..936fe6f522 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in a stock location. x-schemaName: AdminUpdateStockLocation properties: name: @@ -8,7 +8,9 @@ properties: description: The stock location's name. address: type: object - description: The stock location's address. + description: >- + The stock location's address. Pass this property if you're creating a new + address to associate with the location. required: - address_1 - country_code @@ -16,11 +18,11 @@ properties: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -33,6 +35,7 @@ properties: type: string title: country_code description: The address's country code. + example: us phone: type: string title: phone @@ -48,7 +51,9 @@ properties: address_id: type: string title: address_id - description: The stock location's address id. + description: >- + The ID of an existing stock location address to associate the stock + location with. metadata: type: object - description: The stock location's metadata. + description: The stock location's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml index 7df88b6bc0..e8c4463b52 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in a store. x-schemaName: AdminUpdateStore properties: name: @@ -11,34 +11,35 @@ properties: description: The store's supported currencies. items: type: object - description: The supported currency's supported currencies. + description: A store currency. required: - currency_code properties: currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether the currency is the default in the store. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The supported currency's is tax inclusive. + description: Whether prices using this currency are tax inclusive. default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the default sales channel in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the default region in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the default stock location in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml index 5580cc1ef6..8000de42a9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml @@ -1,21 +1,21 @@ type: object -description: SUMMARY +description: The properties to update in the tax rate. x-schemaName: AdminUpdateTaxRate properties: rate: type: number title: rate - description: The tax rate's rate. + description: The rate to charge. code: type: string title: code - description: The tax rate's code. + description: The code that the tax rate is identified by. rules: type: array description: The tax rate's rules. items: type: object - description: The rule's rules. + description: A tax rate rule. required: - reference - reference_id @@ -23,11 +23,13 @@ properties: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of the record in the table that the rule references. + example: ptyp_123 name: type: string title: name @@ -35,11 +37,14 @@ properties: is_default: type: boolean title: is_default - description: The tax rate's is default. + description: Whether the tax rate is the default in the store. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates metadata: type: object - description: The tax rate's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml index 1d1bd54d5a..2fc8ed46f5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in a user. x-schemaName: AdminUpdateUser properties: first_name: @@ -13,4 +13,4 @@ properties: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml index 8db01d8c4c..b61c9d020f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateVariantInventoryItem.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update of the variant's inventory item association. x-schemaName: AdminUpdateVariantInventoryItem required: - required_quantity @@ -7,4 +7,10 @@ properties: required_quantity: type: number title: required_quantity - description: The product's required quantity. + description: >- + The number of units a single quantity is equivalent to. For example, if a + customer orders one quantity of the variant, Medusa checks the + availability of the quantity multiplied by the value set for + `required_quantity`. When the customer orders the quantity, Medusa + reserves the ordered quantity multiplied by the value set for + `required_quantity`. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml index b0e8d7c033..5c265c5e0e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpsertStockLocationAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The stock location's address. +description: The details of the stock location address to create. x-schemaName: AdminUpsertStockLocationAddress required: - address_1 @@ -8,11 +8,11 @@ properties: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -21,6 +21,7 @@ properties: type: string title: country_code description: The address's country code. + example: usd city: type: string title: city diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml index 6fb258123e..c3bca505cb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUser.yaml @@ -32,22 +32,22 @@ properties: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The user's created at. + description: The date the user was created. updated_at: type: string format: date-time title: updated_at - description: The user's updated at. + description: The date the user was updated. deleted_at: type: string format: date-time title: deleted_at - description: The user's deleted at. + description: The date the user was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml index fb9888ff23..72ede85811 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the deleted user. x-schemaName: AdminUserDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the User was deleted. + description: Whether the user was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml index 7aac88724a..e595dad0cd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of users. x-schemaName: AdminUserListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The user's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The user's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The user's count. + description: The total number of items. users: type: array - description: The user's users. + description: The list of 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 index dfc78e1bc9..ed4678e0a0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUserResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUserResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The user's details. x-schemaName: AdminUserResponse required: - user diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml index 1c803655b9..c71f1c4364 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecution.yaml @@ -1,5 +1,5 @@ type: object -description: The workflows execution's workflow execution. +description: The workflows execution's details. x-schemaName: AdminWorkflowExecution required: - id @@ -18,11 +18,11 @@ properties: workflow_id: type: string title: workflow_id - description: The workflow execution's workflow id. + description: The ID of the workflow. transaction_id: type: string title: transaction_id - description: The workflow execution's transaction id. + description: The workflow execution's transaction ID. execution: $ref: ./AdminWorkflowExecutionExecution.yaml context: @@ -42,14 +42,14 @@ properties: type: string format: date-time title: created_at - description: The workflow execution's created at. + description: The date the workflow execution was created. updated_at: type: string format: date-time title: updated_at - description: The workflow execution's updated at. + description: The date the workflow execution was updated. deleted_at: type: string format: date-time title: deleted_at - description: The workflow execution's deleted at. + description: The date the workflow execution was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml index e589756af2..6b780c9e0a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionExecution.yaml @@ -1,9 +1,152 @@ type: object -description: The workflow execution's execution. +description: The workflow execution's steps details. x-schemaName: AdminWorkflowExecutionExecution required: - steps properties: steps: type: object - description: The execution's steps. + description: >- + The execution's steps. Each object key is a step ID, and the value is the + object whose properties are shown below. + required: + - id + - invoke + - definition + - compensate + - depth + - startedAt + additionalProperties: + type: object + properties: + id: + type: string + title: id + description: The step's ID. + invoke: + type: object + description: The state of the step's invokation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The invokation step's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The invokation step's state. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + definition: + type: object + description: The step's definition details. + x-schemaName: WorkflowExecutionDefinition + properties: + async: + type: boolean + title: async + description: Whether the step is async. + compensateAsync: + type: boolean + title: compensateAsync + description: Whether the compensation function of the step is async. + noCompensation: + type: boolean + title: noCompensation + description: Whether the step doesn't have a compensation function. + continueOnPermanentFailure: + type: boolean + title: continueOnPermanentFailure + description: >- + Whether the step continues executing even if its status is + changed to failed. + maxRetries: + type: number + title: maxRetries + description: The maximum number of times to retry the step. + noWait: + type: boolean + title: noWait + description: >- + Whether the workflow shouldn't wait for the step to finish + before moving to the next step. + default: false + retryInterval: + type: number + title: retryInterval + description: >- + The interval in seconds between retry attempts when the step + fails. + retryIntervalAwaiting: + type: number + title: retryIntervalAwaiting + description: >- + The interval in seconds to retry a step even if its status is + `waiting_response`. + saveResponse: + type: boolean + title: saveResponse + description: Whether the step's response is stored. + timeout: + type: number + title: timeout + description: >- + The maximum time in seconds to wait for this step to complete. + If the step exceeds this time, the step's state is changed to + `timeout`, but the step continues executing. + compensate: + type: object + description: The state of the step's compensation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The compensation function's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The compensation function's status. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + depth: + type: number + title: depth + description: The step's depth in the workflow's execution. + startedAt: + type: number + title: startedAt + description: The timestamp the step started executing. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml index 2c21bd3e4e..c57cb857d1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminWorkflowExecutionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The workflow execution's details. x-schemaName: AdminWorkflowExecutionResponse required: - workflow_execution diff --git a/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml index df83ca78ff..f5de0a2150 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/ApiKeyResponse.yaml @@ -1,5 +1,5 @@ type: object -description: The api key's details. +description: The API key's details. x-schemaName: ApiKeyResponse required: - id @@ -16,44 +16,50 @@ properties: id: type: string title: id - description: The api key's ID. + description: The API key's ID. token: type: string title: token - description: The api key's token. + description: The API key's token. redacted: type: string title: redacted - description: The api key's redacted. + description: >- + The redacted form of the API key's token. This is useful when showing + portion of the token. For example `sk_...123`. title: type: string title: title - description: The api key's title. + description: The API key's title. type: type: string + description: >- + The API key's type. `secret` API keys are used for authenticating admin + users, and `publishable` API key are used for storefronts and similar + clients to scope requests to sales channels. enum: - secret - publishable last_used_at: type: string title: last_used_at - description: The api key's last used at. + description: The date the API key was last used. format: date-time created_by: type: string title: created_by - description: The api key's created by. + description: The ID of the user that created the API key. created_at: type: string title: created_at - description: The api key's created at. + description: The date the API key was created. format: date-time revoked_by: type: string title: revoked_by - description: The api key's revoked by. + description: The ID of the user that revoked the API key. revoked_at: type: string title: revoked_at - description: The api key's revoked at. + description: The date the API key was revoked. format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/AuthCallbackResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AuthCallbackResponse.yaml index 65706e144b..aa4b4117eb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AuthCallbackResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AuthCallbackResponse.yaml @@ -4,7 +4,7 @@ x-schemaName: AuthCallbackResponse required: - location properties: - token: + location: type: string title: location description: >- diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml deleted file mode 100644 index 4e1e727e4a..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseApplicationMethod.yaml +++ /dev/null @@ -1,61 +0,0 @@ -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 - description: The application method's type. - enum: - - fixed - - percentage - target_type: - type: string - description: The application method's target type. - enum: - - items - - shipping_methods - - order - allocation: - type: string - description: The application method's allocation. - enum: - - each - - across - 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 70dd7bf660..f8db134ea0 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 parent's calculated price. +description: The calculated price's details. x-schemaName: BaseCalculatedPriceSet required: - id @@ -14,42 +14,102 @@ properties: is_calculated_price_price_list: type: boolean title: is_calculated_price_price_list - description: The calculated price's is calculated price price list. + description: Whether the calculated price belongs to a price list. is_calculated_price_tax_inclusive: type: boolean title: is_calculated_price_tax_inclusive - description: The calculated price's is calculated price tax inclusive. + description: Whether the calculated price is tax inclusive. calculated_amount: type: number title: calculated_amount - description: The calculated price's calculated amount. + description: >- + The amount of the calculated price, or `null` if there isn't a calculated + price. This is the amount shown to the customer. calculated_amount_with_tax: type: number title: calculated_amount_with_tax - description: The calculated price's calculated amount with tax. + description: The calculated price's amount with taxes applied. calculated_amount_without_tax: type: number title: calculated_amount_without_tax - description: The calculated price's calculated amount without tax. + description: The calculated price's amount without taxes applied. is_original_price_price_list: type: boolean title: is_original_price_price_list - description: The calculated price's is original price price list. + description: Whether the original price belongs to a price list. is_original_price_tax_inclusive: type: boolean title: is_original_price_tax_inclusive - description: The calculated price's is original price tax inclusive. + description: Whether the original price is tax inclusive. original_amount: type: number title: original_amount - description: The calculated price's original amount. + description: >- + The amount of the original price, or `null` if there isn't an original + price. This amount is useful to compare with the `calculated_amount`, such + as to check for discounted value. currency_code: type: string title: currency_code description: The calculated price's currency code. + example: usd calculated_price: type: object description: The calculated price's details. + properties: + id: + type: string + title: id + description: The calculated price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity original_price: type: object - description: The calculated price's original price. + description: The original price's details. + properties: + id: + type: string + title: id + description: The original price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml index 59baa7033c..a4456a306c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCapture.yaml @@ -1,3 +1,28 @@ type: object -description: The capture's captures. +description: The details of a captured payment. x-schemaName: BaseCapture +required: + - id + - amount + - created_at + - payment +properties: + id: + type: string + title: id + description: The payment capture's ID. + amount: + type: number + title: amount + description: The captured amount. + created_at: + type: string + format: date-time + title: created_at + description: The date the capture was created. + created_by: + type: string + title: created_by + description: The ID of the user that captured the payment. + payment: + type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml index 5cc50d1e73..5ba46f61aa 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCart.yaml @@ -1,3 +1,173 @@ type: object description: The item's cart. x-schemaName: BaseCart +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: + type: object + 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: + type: number + title: original_item_total + description: The cart's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The cart's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The cart's original item tax total. + item_total: + type: number + title: item_total + description: The cart's item total. + item_subtotal: + type: number + title: item_subtotal + description: The cart's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The cart's item tax total. + original_total: + type: number + title: original_total + description: The cart's original total. + original_subtotal: + type: number + title: original_subtotal + description: The cart's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The cart's original tax total. + total: + type: number + title: total + description: The cart's total. + subtotal: + type: number + title: subtotal + description: The cart's subtotal. + tax_total: + type: number + title: tax_total + description: The cart's tax total. + discount_total: + type: number + title: discount_total + description: The cart's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The cart's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The cart's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The cart's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The cart's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The cart's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml index 0cc3faf4c1..e85cfd8a57 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartAddress.yaml @@ -1,69 +1,3 @@ type: object -description: The parent's billing address. +description: The cart's shipping 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 index 01d9216030..b2e59d9621 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartLineItem.yaml @@ -1,5 +1,5 @@ type: object -description: The item's items. +description: The tax line's item. x-schemaName: BaseCartLineItem required: - id @@ -40,17 +40,9 @@ properties: 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 + type: number + title: quantity + description: The item's quantity. product: $ref: ./BaseProduct.yaml product_id: @@ -115,34 +107,18 @@ properties: 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 + type: number + title: compare_at_unit_price + description: The item's compare at unit price. 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 + type: number + title: unit_price + description: The item's unit price. tax_lines: type: array description: The item's tax lines. items: - $ref: ./BaseLineItemTaxLine.yaml + type: object adjustments: type: array description: The item's adjustments. @@ -173,134 +149,46 @@ properties: title: deleted_at description: The item's deleted at. 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 + type: number + title: original_total + description: The item's original total. 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 + type: number + title: original_subtotal + description: The item's original subtotal. 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 + type: number + title: original_tax_total + description: The item's original tax total. 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 + type: number + title: item_total + description: The item's item total. 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 + type: number + title: item_subtotal + description: The item's item subtotal. 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 + type: number + title: item_tax_total + description: The item's item tax total. 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 + type: number + title: total + description: The item's total. 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 + type: number + title: subtotal + description: The item's subtotal. 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 + type: number + title: tax_total + description: The item's tax total. 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 + type: number + title: discount_total + description: The item's discount total. 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 + type: number + title: discount_tax_total + description: The item's discount tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml index 6f613ecf88..1dbcebc278 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCartShippingMethod.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping method's shipping methods. +description: A cart's shipping method. x-schemaName: BaseCartShippingMethod required: - id @@ -25,7 +25,7 @@ properties: cart_id: type: string title: cart_id - description: The shipping method's cart id. + description: The ID of the cart this shipping method belongs to. name: type: string title: name @@ -35,31 +35,28 @@ properties: 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 + 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. + description: Whether the shipping method's amount is tax inclusive. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: >- + The shipping method's data, useful for fulfillment handling by third-party + services. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -67,112 +64,52 @@ properties: $ref: ./BaseShippingMethodTaxLine.yaml adjustments: type: array - description: The shipping method's adjustments. + description: The shipping method's adjustments, such as applied promotions. items: $ref: ./BaseShippingMethodAdjustment.yaml created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. 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 + type: string + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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 + type: string + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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 + type: string + title: original_tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. 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 + type: string + title: total + description: The shipping method's total amount including taxes and promotions. 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 + type: string + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. 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 + type: string + title: tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. 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 + type: string + title: discount_total + description: The total amount discounted. 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 + type: string + title: discount_total + description: The taxes applied on the discounted amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml deleted file mode 100644 index 85d6a02519..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseClaim.yaml +++ /dev/null @@ -1,3 +0,0 @@ -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 index 27c9efe996..fe407754be 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseClaimItem.yaml @@ -1,5 +1,5 @@ type: object -description: The claim item's claim items. +description: The claim item's details. x-schemaName: BaseClaimItem required: - id @@ -17,22 +17,22 @@ properties: claim_id: type: string title: claim_id - description: The claim item's claim id. + description: The ID of the claim this item belongs to. order_id: type: string title: order_id - description: The claim item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The claim item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The claim item's quantity. + description: The quantity claimed. reason: type: string - description: The claim item's reason. + description: The claim's reason. enum: - missing_item - wrong_item @@ -40,17 +40,28 @@ properties: - other raw_quantity: type: object - description: The claim item's raw quantity. + description: The quantity claimed. + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + required: + - value metadata: type: object - description: The claim item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The claim item's created at. + description: The date the claim was created. updated_at: type: string format: date-time title: updated_at - description: The claim item's updated at. + description: The date the claim was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml index 19efac7da2..6b7390021c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml @@ -1,3 +1,3 @@ type: object -description: The product's collection. +description: The collection's details. x-schemaName: BaseCollection diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml deleted file mode 100644 index ef30b67813..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomer.yaml +++ /dev/null @@ -1,73 +0,0 @@ -type: object -description: The customer's details. -x-schemaName: BaseCustomer -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 ID of the address used as the default billing address. - default_shipping_address_id: - type: string - title: default_shipping_address_id - description: The ID of the address used as the default shipping address. - 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, used to store custom key-value pairs. - created_by: - type: string - title: created_by - description: The ID of the user that created this customer, if available. - created_at: - type: string - format: date-time - title: created_at - description: The customer's creation date. - updated_at: - type: string - format: date-time - title: updated_at - description: The customer's update date. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The customer's deletion date. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml index 906bc9231d..c894dbf6d0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCustomerAddress.yaml @@ -1,3 +1,97 @@ type: object -description: The address's addresses. +description: The customer's address. x-schemaName: BaseCustomerAddress +required: + - id + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The address's ID. + address_name: + type: string + title: address_name + description: The address's name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: Whether the address is the default shipping address. + is_default_billing: + type: boolean + title: is_default_billing + description: Whether the address is the default billing address. + customer_id: + type: string + title: customer_id + description: The ID of the customer that this address belongs to. + 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 address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + 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, used to store custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The address's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The address's update date. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml index 852b2e0a94..82c98c6dbf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseExchangeItem.yaml @@ -1,5 +1,5 @@ type: object -description: The additional item's additional items. +description: The item's details. x-schemaName: BaseExchangeItem required: - id @@ -13,33 +13,33 @@ properties: id: type: string title: id - description: The additional item's ID. + description: The item's ID. exchange_id: type: string title: exchange_id - description: The additional item's exchange id. + description: The ID of the exchange this item belongs to. order_id: type: string title: order_id - description: The additional item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The additional item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The additional item's quantity. + description: The item's quantity. metadata: type: object - description: The additional item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The additional item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The additional item's updated at. + description: The date the item was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml index 5cddd56a89..7e0af5e7a7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseFulfillmentProvider.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping option's provider. +description: The fulfillment provider's details. x-schemaName: BaseFulfillmentProvider required: - id @@ -12,4 +12,4 @@ properties: is_enabled: type: boolean title: is_enabled - description: The provider's is enabled. + description: Whether the provider 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 index 5b5a104b31..af9b884de8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemAdjustment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The adjustment's details. x-schemaName: BaseLineItemAdjustment +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the cart this adjustment belongs to. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. +required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml index 1fdd8bf379..63946d4c1f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseLineItemTaxLine.yaml @@ -1,3 +1,62 @@ type: object -description: The tax line's tax lines. +description: The tax line's details x-schemaName: BaseLineItemTaxLine +properties: + item: + $ref: ./BaseCartLineItem.yaml + item_id: + type: string + title: item_id + description: The ID of the item the tax line applies on. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the associated tax rate. + code: + type: string + title: code + description: The code the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. +required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml index 09579fa8dd..2b2d4962a6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml @@ -1,3 +1,238 @@ type: object -description: The order change's order. +description: The order's details. x-schemaName: BaseOrder +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 + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + sales_channel: + $ref: ./AdminSalesChannel.yaml + customer: + $ref: ./AdminCustomer.yaml + shipping_address: + $ref: ./AdminOrderAddress.yaml + billing_address: + $ref: ./AdminOrderAddress.yaml + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The ID of the region associated with the order. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order is placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: number + title: display_id + description: The order's display ID. + 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 + description: The order's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillment_status: + type: string + description: The order's fulfillment status. + 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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the order's items including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The total of the order's items excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the order's items excluding promotions. + item_total: + type: number + title: item_total + description: The total of the order's items including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The total of the order's items excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order's items including promotions. + original_total: + type: number + title: original_total + description: The order's total excluding promotions, including taxes. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The order's tax total, excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The order's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The order's discount or promotions total. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total of order's discount or promotion. + 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 tax total of the order's gift card. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The tax total of the order's shipping. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The tax total of the order's shipping excluding promotions. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml index f1896707cd..ffdb335848 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The exchange's billing address. +description: An order address x-schemaName: BaseOrderAddress required: - id @@ -10,61 +10,64 @@ properties: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer this address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us + country: + $ref: ./AdminRegionCountry.yaml province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The billing address's updated at. + description: The date the address was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml deleted file mode 100644 index dc086f2f8e..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChange.yaml +++ /dev/null @@ -1,146 +0,0 @@ -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 - description: The order change's change type. - enum: - - return - - exchange - - claim - - edit - - return_request - 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 index 91725525be..476cad7744 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderChangeAction.yaml @@ -1,3 +1,85 @@ type: object description: The action's actions. x-schemaName: BaseOrderChangeAction +properties: + order_change: + type: object + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change this action belongs to. + order_id: + type: string + title: order_id + description: The ID of the associated order. + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + title: action + description: The applied action. + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the order change action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change action was updated. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: ./BaseOrder.yaml +required: + - order_change + - id + - order_change_id + - order_id + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at + - return_id + - claim_id + - exchange_id + - order diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml index 513f2f9f6a..12970b6fe2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml @@ -22,48 +22,53 @@ properties: location_id: type: string title: location_id - description: The fulfillment's location id. + description: The ID of the location the items are fulfilled from. packed_at: type: string title: packed_at - description: The fulfillment's packed at. + description: The date the items were packed. format: date-time shipped_at: type: string title: shipped_at - description: The fulfillment's shipped at. + description: The date the items were shipped. format: date-time delivered_at: type: string title: delivered_at - description: The fulfillment's delivered at. + description: The date the items were delivered. format: date-time canceled_at: type: string title: canceled_at - description: The fulfillment's canceled at. + description: The date the items were canceled. format: date-time data: type: object - description: The fulfillment's data. + description: >- + Data useful for the fulfillment provider handling it. This is taken from + the associated shipping option. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property provider_id: type: string title: provider_id - description: The fulfillment's provider id. + description: The ID of the fulfillment provider used to handle the fulfillment. shipping_option_id: type: string title: shipping_option_id - description: The fulfillment's shipping option id. + description: The ID of the associated shipping option. metadata: type: object - description: The fulfillment's metadata. + description: The fulfillment's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The fulfillment's created at. + description: The date the fulfillment was created. updated_at: type: string format: date-time title: updated_at - description: The fulfillment's updated at. + description: The date the fulfillment was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml index 0a1f9eb14d..b29f58deb1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderItemDetail.yaml @@ -1,3 +1,79 @@ type: object description: The item's detail. x-schemaName: BaseOrderItemDetail +required: + - id + - item_id + - item + - quantity + - fulfilled_quantity + - delivered_quantity + - shipped_quantity + - return_requested_quantity + - return_received_quantity + - return_dismissed_quantity + - written_off_quantity + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: the detail's ID. + item_id: + type: string + title: id + description: the ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + delivered_quantity: + type: number + title: fulfilled_quantity + description: The item's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + return_received_quantity: + type: number + title: return_received_quantity + description: >- + The item's quantity that's returned and added to the underlying variant's + stocked quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: >- + The item's quantity that's returned but damaged. So, it's not added to the + underlying variant's stocked quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed from the order. + metadata: + type: object + title: metadata + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the detail was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the detail was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml index ecf54b1785..f69a00e216 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItem.yaml @@ -56,19 +56,19 @@ properties: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The URL of the item's thumbnail. variant: $ref: ./BaseProductVariant.yaml variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated variant. product: $ref: ./BaseProduct.yaml product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -88,7 +88,7 @@ properties: product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the collection the item's product belongs to. product_handle: type: string title: product_handle @@ -96,7 +96,7 @@ properties: variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -107,23 +107,25 @@ properties: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The values of the item variant's options. + example: + Color: Blue requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item is tax inclusive. compare_at_unit_price: type: number title: compare_at_unit_price - description: The item's compare at unit price. + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -148,64 +150,64 @@ properties: type: string format: date-time title: created_at - description: The item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The item's updated at. + description: The date the item was updated. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. original_total: type: number title: original_total - description: The item's original total. + description: The item's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The item's original subtotal. + description: The item's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The item's original tax total. + description: The total taxes of the item, excluding promotions. item_total: type: number title: item_total - description: The item's item total. + description: The total taxes of the item, including promotions. item_subtotal: type: number title: item_subtotal - description: The item's item subtotal. + description: The item's total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The item's item tax total. + description: The total taxes of the item, including promotions. total: type: number title: total - description: The item's total. + description: The item's total, including taxes and promotions. subtotal: type: number title: subtotal - description: The item's subtotal. + description: The item's subtotal excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The item's tax total. + description: The tax total of the item including promotions. discount_total: type: number title: discount_total - description: The item's discount total. + description: The total discount amount of the item. discount_tax_total: type: number title: discount_tax_total - description: The item's discount tax total. + description: The total taxes applied on the discounted amount. refundable_total: type: number title: refundable_total - description: The item's refundable total. + description: The total refundable amount of the item's total. refundable_total_per_unit: type: number title: refundable_total_per_unit - description: The item's refundable total per unit. + description: The total refundable amount of the item's total for a single quantity. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml index a4f81ce94f..8bc04e5fdd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The adjustment's details. x-schemaName: BaseOrderLineItemAdjustment +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion that this applies on the order's item. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. +required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml index 213da9382d..b9bf8070c0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderLineItemTaxLine.yaml @@ -1,3 +1,62 @@ type: object description: The tax line's tax lines. x-schemaName: BaseOrderLineItemTaxLine +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the associated line item. + total: + type: number + title: total + description: The tax line's total including promotions. + subtotal: + type: number + title: subtotal + description: The tax line's subtotal excluding promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. +required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingDetail.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingDetail.yaml new file mode 100644 index 0000000000..5cd76600fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingDetail.yaml @@ -0,0 +1,42 @@ +type: object +description: Details of changes to a shipping method. +x-schemaName: BaseOrderShippingDetail +required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The ID of the new changes to the shipping method. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method. + shipping_method: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + return_id: + type: string + title: return_id + description: The ID of the associated return. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method change was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml index 4357db37d7..930352a943 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethod.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping method's shipping methods. +description: The shipping method's details. x-schemaName: BaseOrderShippingMethod required: - id @@ -28,7 +28,7 @@ properties: order_id: type: string title: order_id - description: The shipping method's order id. + description: The ID of the order the shipping method belongs to. name: type: string title: name @@ -44,17 +44,22 @@ properties: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping method's is tax inclusive. + description: Whether the shipping method's amount includes applied taxes. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: >- + The shipping method's data, useful for fulfillment provider handling its + fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -66,108 +71,46 @@ properties: 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 + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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 + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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 + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. 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 + type: number + title: total + description: The shipping method's total including taxes and promotions. 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 + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. 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 + type: number + title: tax_total + description: The shipping method's tax total including promotions. 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 + type: number + title: discount_total + description: The total discounts applied on the shipping method. 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 + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. + detail: + $ref: ./BaseOrderShippingDetail.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml index 0d458f73fa..59eec5e5eb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodAdjustment.yaml @@ -1,3 +1,56 @@ type: object description: The adjustment's adjustments. x-schemaName: BaseOrderShippingMethodAdjustment +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. +required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml index 3cce6d21b0..96102bb4ad 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderShippingMethodTaxLine.yaml @@ -1,3 +1,62 @@ type: object -description: The tax line's tax lines. +description: The tax line's details. x-schemaName: BaseOrderShippingMethodTaxLine +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider handling the tax calculation. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. +required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml index 395346dc23..26db0db078 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderSummary.yaml @@ -1,5 +1,5 @@ type: object -description: The order's summary. +description: The order's summary details. x-schemaName: BaseOrderSummary required: - total @@ -10,71 +10,46 @@ required: - 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. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The summary's subtotal. + description: The order's total excluding taxes, including promotions. total_tax: type: number title: total_tax - description: The summary's total tax. + description: The order's total taxes. ordered_total: type: number title: ordered_total - description: The summary's ordered total. + description: The order's total when it was placed. fulfilled_total: type: number title: fulfilled_total - description: The summary's fulfilled total. + description: The total of the fulfilled items of the order. returned_total: type: number title: returned_total - description: The summary's returned total. + description: The total of the order's returned items. return_request_total: type: number title: return_request_total - description: The summary's return request total. + description: The total of the items requested to be returned. 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. + description: The total of the items removed from the order. paid_total: type: number title: paid_total - description: The summary's paid total. + description: The total amount paid. refunded_total: type: number title: refunded_total - description: The summary's refunded total. + description: The total amount refunded. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml index 8abf8cfd58..f822566df9 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderTransaction.yaml @@ -1,5 +1,5 @@ type: object -description: The transaction's transactions. +description: An order transaction's details. x-schemaName: BaseOrderTransaction required: - id @@ -19,7 +19,7 @@ properties: order_id: type: string title: order_id - description: The transaction's order id. + description: The ID of the order this transaction belongs to. amount: type: number title: amount @@ -28,24 +28,31 @@ properties: type: string title: currency_code description: The transaction's currency code. + example: usd reference: type: string title: reference - description: The transaction's reference. + description: >- + The name of a table that this transaction references. If this transaction + is for captured payment, its value is `capture`. If this transaction is + for refunded payment, its value is `refund`. + enum: + - capture + - refund reference_id: type: string title: reference_id - description: The transaction's reference id. + description: The ID of the referenced record in the referenced table. metadata: type: object - description: The transaction's metadata. + description: The transaction's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The transaction's created at. + description: The date that the transaction was created. updated_at: type: string format: date-time title: updated_at - description: The transaction's updated at. + description: The date that the transaction was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml index 6171436ba7..86305baabf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePayment.yaml @@ -1,3 +1,93 @@ type: object -description: The payment's payments. +description: The payment's details. x-schemaName: BasePayment +required: + - id + - amount + - currency_code + - provider_id +properties: + id: + type: string + title: id + description: The payment's ID. + amount: + type: number + title: amount + description: The payment's amount. + authorized_amount: + type: number + title: authorized_amount + description: The amount authorized of the payment. + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The ID of the payment provider used to process this payment. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order_edit_id: + type: string + title: order_edit_id + description: The ID of the associated order edit. + customer_id: + type: string + title: customer_id + description: ID of the associated customer. + data: + type: object + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment + created_at: + type: string + format: date-time + title: created_at + description: The date the payment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the payment was updated. + captured_at: + type: string + format: date-time + title: captured_at + description: The date the payment was captured. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. + captured_amount: + type: number + title: captured_amount + description: The captured amount of the payment. + refunded_amount: + type: number + title: captured_amount + description: The refunded amount of the payment. + captures: + type: array + description: The details of payment captures. + items: + $ref: ./BaseCapture.yaml + refunds: + type: array + description: The details of payment refunds. + items: + $ref: ./BaseRefund.yaml + payment_collection: + type: object + payment_session: + type: object diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml index 309583af20..8ee4e76804 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentCollection.yaml @@ -1,5 +1,5 @@ type: object -description: The payment collection's payment collections. +description: The payment collection's details. x-schemaName: BasePaymentCollection required: - id @@ -20,77 +20,41 @@ properties: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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 + type: number + title: amount + description: The total amount to be paid. 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 + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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 + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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 + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -102,7 +66,9 @@ properties: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: >- + The payment provider used to process the collection's payments and + sessions. items: $ref: ./BasePaymentProvider.yaml payment_sessions: diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml index 2266f0a8ea..2b73a963fb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml @@ -1,3 +1,10 @@ type: object description: The payment provider's payment providers. x-schemaName: BasePaymentProvider +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/BasePaymentSession.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml index f0c1e2603a..33533c274e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentSession.yaml @@ -1,3 +1,61 @@ type: object -description: The payment session's payment sessions. +description: The payment session's details. x-schemaName: BasePaymentSession +properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: >- + The payment session's data, useful for the payment provider processing the + payment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: ./BasePayment.yaml +required: + - id + - amount + - currency_code + - provider_id + - data + - status 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 c07bd8c599..406806bd73 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProduct.yaml @@ -123,7 +123,7 @@ properties: type: array description: The product's variants. items: - $ref: ./BaseProductVariant.yaml + type: object options: type: array description: The product's options. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml index cbabec4609..f1e59ad937 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductImage.yaml @@ -1,3 +1,33 @@ type: object -description: The image's images. +description: The image's details. x-schemaName: BaseProductImage +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. +required: + - id + - url diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml index 91105a54c2..152999bb1c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml @@ -1,3 +1,44 @@ type: object -description: The option's options. +description: The product option's details. x-schemaName: BaseProductOption +properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: ./BaseProductOptionValue.yaml + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. +required: + - id + - title diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml index a607fba792..ba0a4dfd87 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOptionValue.yaml @@ -1,5 +1,5 @@ type: object -description: The option's options. +description: The product option value's details. x-schemaName: BaseProductOptionValue required: - id @@ -8,32 +8,32 @@ properties: id: type: string title: id - description: The option's ID. + description: The value's ID. value: type: string title: value - description: The option's value. + description: The value. option: - $ref: ./BaseProductOption.yaml + type: object option_id: type: string title: option_id - description: The option's option id. + description: The ID of the option this value belongs to. metadata: type: object - description: The option's metadata. + description: The value's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The option's created at. + description: The date the value was created. updated_at: type: string format: date-time title: updated_at - description: The option's updated at. + description: The date the value was updated. deleted_at: type: string format: date-time title: deleted_at - description: The option's deleted at. + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml index 559318d70e..e27ee0ea8c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductVariant.yaml @@ -1,3 +1,132 @@ type: object -description: The variant's variants. +description: The product variant's details. x-schemaName: BaseProductVariant +required: + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The variant's ID. + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN code. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's out of stock. + manage_inventory: + type: boolean + title: manage_inventory + description: >- + Whether the Medusa application manages the variant's inventory quantity + and availablility. If disabled, the variant is always considered in stock. + inventory_quantity: + type: number + title: inventory_quantity + description: >- + The variant's inventory quantity. This is only included if you pass in the + `fields` query parameter a `+variants.inventory_quantity` parameter. + hs_code: + type: string + title: hs_code + description: The variant's HS code. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + mid_code: + type: string + title: mid_code + description: The variant's MID code. + material: + type: string + title: material + description: The variant's material. + 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. + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its sibling variants. + options: + type: array + description: The variant's option values. + items: + $ref: ./BaseProductOptionValue.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The ID of the product that the variant belongs to. + calculated_price: + $ref: ./BaseCalculatedPriceSet.yaml + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml index 9cba351225..12eafa4026 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePromotionRuleValue.yaml @@ -1,5 +1,5 @@ type: object -description: The value's values. +description: The rule value's details. x-schemaName: BasePromotionRuleValue required: - id @@ -11,4 +11,4 @@ properties: value: type: string title: value - description: The value's details. + description: The value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml index 50d12fb0f9..9a8cf91839 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRefund.yaml @@ -1,3 +1,38 @@ type: object -description: The refund's refunds. +description: The refund's details. x-schemaName: BaseRefund +required: + - id + - amount + - created_at + - payment +properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + type: object + refund_reason: + $ref: ./RefundReason.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml index 778b10a689..bbf5758714 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRegion.yaml @@ -1,5 +1,5 @@ type: object -description: The parent's region. +description: The region's details. x-schemaName: BaseRegion required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml index ee76c5c787..5fd0a02708 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRegionCountry.yaml @@ -1,3 +1,33 @@ type: object -description: The country's countries. +description: The country's details. x-schemaName: BaseRegionCountry +properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. +required: + - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml deleted file mode 100644 index 3f0906bd54..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseReturnItem.yaml +++ /dev/null @@ -1,3 +0,0 @@ -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 index b5c88a34d8..d46a97718a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseRuleOperatorOptions.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseRuleOperatorOptions.yaml @@ -1,5 +1,5 @@ type: object -description: The operator's operators. +description: The operator's details. x-schemaName: BaseRuleOperatorOptions required: - id @@ -10,11 +10,14 @@ properties: type: string title: id description: The operator's ID. + example: in value: type: string title: value description: The operator's value. + example: in label: type: string title: label description: The operator's label. + example: In diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml index e20885775e..53869e4f40 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The adjustment's details. x-schemaName: BaseShippingMethodAdjustment +required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method the adjustment is applied on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml index e7e494dae5..50c5ff23ef 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseShippingMethodTaxLine.yaml @@ -1,3 +1,62 @@ type: object -description: The tax line's tax lines. +description: The tax line's details. x-schemaName: BaseShippingMethodTaxLine +required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of this shipping method the tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider that calculated the taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml index 5217a9aa3b..14de28c42e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CreateAddress.yaml @@ -1,51 +1,52 @@ type: object -description: The cart's shipping address. +description: The address to create. x-schemaName: CreateAddress properties: customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. + description: The address's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml deleted file mode 100644 index ea5d127dd2..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCartAddress.yaml +++ /dev/null @@ -1,47 +0,0 @@ -type: object -description: The cart's billing address. -x-schemaName: CreateCartAddress -properties: - 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml deleted file mode 100644 index fc4ffc2354..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateCartCreateLineItem.yaml +++ /dev/null @@ -1,97 +0,0 @@ -type: object -description: The item's items. -x-schemaName: CreateCartCreateLineItem -required: - - quantity - - variant_id -properties: - quantity: - type: string - title: quantity - description: The item's quantity. - variant_id: - type: string - title: variant_id - description: The item's variant 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. - 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. - is_giftcard: - type: boolean - title: is_giftcard - description: The item's is giftcard. - compare_at_unit_price: - type: string - title: compare_at_unit_price - description: The item's compare at unit price. - unit_price: - type: string - title: unit_price - description: The item's unit price. - metadata: - type: object - description: The item's metadata. 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/CustomerGroupInCustomerFilters.yaml b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml index fcc67cf89c..e16fde8c9b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/CustomerGroupInCustomerFilters.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's groups. +description: Filter by customer groups to get their associated customers. x-schemaName: CustomerGroupInCustomerFilters required: - id @@ -12,27 +12,27 @@ properties: oneOf: - type: string title: id - description: The group's ID. + description: Filter by a group's ID. - type: array - description: The group's ID. + description: Filter by group IDs. items: type: string title: id - description: The id's ID. + description: A group's ID. name: oneOf: - type: string title: name - description: The group's name. + description: Filter by a group's name. - type: array - description: The group's name. + description: Filter by group names. items: type: string title: name - description: The name's details. + description: A group's name. created_at: type: object - description: The group's created at. + description: Filter by the group's creation date. properties: $and: type: array @@ -56,7 +56,7 @@ properties: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -159,7 +159,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The group's updated at. + description: Filter by the group's update date. properties: $and: type: array @@ -183,7 +183,7 @@ properties: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -286,7 +286,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The group's deleted at. + description: Filter by the group's deletion date. properties: $and: type: array @@ -310,7 +310,7 @@ properties: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq diff --git a/www/apps/api-reference/specs/admin/components/schemas/File.yaml b/www/apps/api-reference/specs/admin/components/schemas/File.yaml deleted file mode 100644 index 20c6a466af..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/File.yaml +++ /dev/null @@ -1,45 +0,0 @@ -type: object -description: The product's file. -x-schemaName: File -required: - - lastModified - - name - - webkitRelativePath - - size - - type - - arrayBuffer - - stream - - text -properties: - lastModified: - type: number - title: lastModified - description: The file's lastmodified. - name: - type: string - title: name - description: The file's name. - webkitRelativePath: - type: string - title: webkitRelativePath - description: The file's webkitrelativepath. - size: - type: number - title: size - description: The file's size. - type: - type: string - title: type - description: The file's type. - arrayBuffer: - type: object - description: The file's arraybuffer. - slice: - type: object - description: The file's slice. - stream: - type: object - description: The file's stream. - text: - type: object - description: The file's text. diff --git a/www/apps/api-reference/specs/admin/components/schemas/FileList.yaml b/www/apps/api-reference/specs/admin/components/schemas/FileList.yaml deleted file mode 100644 index 2bc70ab8fb..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/FileList.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: FileList -required: - - length - - item - - __@iterator@258 -properties: - length: - type: number - title: length - description: The upload's length. - item: - type: object - description: The upload's item. - __@iterator@258: - type: object - description: The upload's @iterator@258. diff --git a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml index ff883a1a28..aa13bb7243 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/InventoryLevel.yaml @@ -1,5 +1,5 @@ type: object -description: The inventory level's inventory levels. +description: The inventory level's details x-schemaName: InventoryLevel required: - id @@ -17,11 +17,11 @@ properties: inventory_item_id: type: string title: inventory_item_id - description: The inventory level's inventory item id. + description: The ID of the associated inventory item. location_id: type: string title: location_id - description: The inventory level's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity @@ -40,4 +40,4 @@ properties: description: The inventory level's incoming quantity. metadata: type: object - description: The inventory level's metadata. + description: The inventory level's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml index 8c90e11018..47214c6a82 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -1,3 +1,296 @@ type: object -description: The transaction's order. +description: The order change's order. x-schemaName: Order +required: + - id + - version + - status + - currency_code + - 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_subtotal + - 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's ID. + version: + type: number + title: version + description: The order's version. + order_change: + type: object + status: + type: string + description: The order's status. + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The ID of the region the order belongs to. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order was placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + example: usd + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + items: + type: array + description: The order's items. + items: + $ref: ./OrderLineItem.yaml + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: ./OrderShippingMethod.yaml + transactions: + type: array + description: The order's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The order's summary. + metadata: + type: object + description: The order's metadata, can hold custom key-value pairs. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the order was canceled. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The order items' total including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order items' total excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The taxes total for order items, excluding promotions. + item_total: + type: number + title: item_total + description: The order items' total including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The order items' total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order items including promotions. + original_total: + type: number + title: original_total + description: The order's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the order including promotions. + discount_subtotal: + type: number + title: discount_subtotal + description: The total discount excluding taxes. + discount_total: + type: number + title: discount_total + description: The total discount including taxes. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total applied on the discount. + 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 including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The total taxes of the order's shipping including taxes. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The total taxes of the order's shipping excluding promotions. + raw_original_item_total: + type: object + description: The order's raw original item total. + raw_original_item_subtotal: + type: object + description: The order's raw original item subtotal. + raw_original_item_tax_total: + type: object + description: The order's raw original item tax total. + raw_item_total: + type: object + description: The order's raw item total. + raw_item_subtotal: + type: object + description: The order's raw item subtotal. + raw_item_tax_total: + type: object + description: The order's raw item tax total. + raw_original_total: + type: object + description: The order's raw original total. + raw_original_subtotal: + type: object + description: The order's raw original subtotal. + raw_original_tax_total: + type: object + description: The order's raw original tax total. + raw_total: + type: object + description: The order's raw total. + raw_subtotal: + type: object + description: The order's raw subtotal. + raw_tax_total: + type: object + description: The order's raw tax total. + raw_discount_total: + type: object + description: The order's raw discount total. + raw_discount_tax_total: + type: object + description: The order's raw discount tax total. + raw_gift_card_total: + type: object + description: The order's raw gift card total. + raw_gift_card_tax_total: + type: object + description: The order's raw gift card tax total. + raw_shipping_total: + type: object + description: The order's raw shipping total. + raw_shipping_subtotal: + type: object + description: The order's raw shipping subtotal. + raw_shipping_tax_total: + type: object + description: The order's raw shipping tax total. + raw_original_shipping_total: + type: object + description: The order's raw original shipping total. + raw_original_shipping_subtotal: + type: object + description: The order's raw original shipping subtotal. + raw_original_shipping_tax_total: + type: object + description: The order's raw original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml index 2006536055..3108787026 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The order preview's billing address. +description: The address's details. x-schemaName: OrderAddress required: - id @@ -9,61 +9,62 @@ properties: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The billing address's updated at. + description: The date the address was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml index e4b9f03dab..58d07e2b68 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChange.yaml @@ -1,5 +1,5 @@ type: object -description: The order preview's order change. +description: The order change's details. x-schemaName: OrderChange required: - id @@ -34,10 +34,12 @@ properties: version: type: number title: version - description: The order change's version. + description: >- + The order change's version. This will be the order's version when the + change is applied. change_type: type: string - description: The order change's change type. + description: The order change's type. enum: - return - exchange @@ -46,23 +48,23 @@ properties: order_id: type: string title: order_id - description: The order change's order id. + description: The ID of the order this change applies on. return_id: type: string title: return_id - description: The order change's return id. + description: The ID of the associated return. exchange_id: type: string title: exchange_id - description: The order change's exchange id. + description: The ID of the associated exchange. claim_id: type: string title: claim_id - description: The order change's claim id. + description: The ID of the associated claim. order: type: object return_order: - $ref: ./Return.yaml + type: object exchange: $ref: ./OrderExchange.yaml claim: @@ -74,74 +76,63 @@ properties: $ref: ./OrderChangeAction.yaml status: type: string - title: status description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined requested_by: type: string title: requested_by - description: The order change's requested by. + description: The ID of the user that requested the change. 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 + type: string + title: requested_at + description: The date the order change was requested. + format: date-time confirmed_by: type: string title: confirmed_by - description: The order change's confirmed by. + description: The ID of the user that confirmed the order change. 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 + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time declined_by: type: string title: declined_by - description: The order change's declined by. + description: The ID of the user that declined the order change. declined_reason: type: string title: declined_reason - description: The order change's declined reason. + description: The reason the order change was declined. metadata: type: object - description: The order change's metadata. + description: The order change's metadata, can hold custom key-value pairs. 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 + type: string + title: declined_at + description: The date the order change was declined. + format: date-time canceled_by: type: string title: canceled_by - description: The order change's canceled by. + description: The ID of the user that canceled the order change. 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 + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time created_at: type: string format: date-time title: created_at - description: The order change's created at. + description: The date the order change was created. updated_at: type: string format: date-time title: updated_at - description: The order change's updated at. + description: The date the order change was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml index 13a80ba767..d21c904f16 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderChangeAction.yaml @@ -1,3 +1,100 @@ type: object -description: The action's actions. +description: The order change action's details. x-schemaName: OrderChangeAction +required: + - id + - order_change_id + - order_change + - order_id + - return_id + - claim_id + - exchange_id + - order + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: ./Order.yaml + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml index 7d1a9d3366..41bb209451 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml @@ -1,3 +1,257 @@ type: object description: The order change's claim. x-schemaName: OrderClaim +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: + id: + type: string + title: id + description: The claim's ID. + order_id: + type: string + title: order_id + description: The ID of the order associated with the claim. + claim_items: + type: array + description: The order items targetted by the claim. + items: + $ref: ./BaseClaimItem.yaml + additional_items: + type: array + description: The outbound or new items of the claim. + items: + $ref: ./BaseClaimItem.yaml + return: + type: object + return_id: + type: string + title: return_id + description: The ID of the associated return. + no_notification: + type: boolean + title: no_notification + description: Whether the customer should be notified about changes in the claim. + refund_amount: + type: number + title: refund_amount + description: The amount to be refunded. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + region_id: + type: string + title: region_id + description: The ID of the region associated with the claim. + customer_id: + type: string + title: customer_id + description: The ID of the customer associated with the claim's order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the claim's order is created in. + email: + type: string + title: email + description: The email associated with the claim's order. + format: email + display_id: + type: number + 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 + description: The claim's payment status. + 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 + description: The claim's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + description: Learn more about transactions of orders and associated models. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The claim's metadata, used to store custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The claim's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's update date. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the associated order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the associated order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the original items in the associated order. + item_total: + type: number + title: item_total + description: The total of the claim's items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the claim's items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the claim's items. + original_total: + type: number + title: original_total + description: The associated order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The associated order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The associated order's original tax total. + total: + type: number + title: total + description: The associated order'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 associated order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The associated order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The associated order's original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml index 0c83b9bb1b..c0ba54357b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml @@ -1,3 +1,263 @@ type: object description: The order change's exchange. x-schemaName: OrderExchange +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 ID of the order the exchange is created for. + return_items: + type: array + description: The items returned (inbound) by the exchange. + items: + $ref: ./AdminReturnItem.yaml + additional_items: + type: array + description: The new items (outbound) sent by the exchange. + items: + $ref: ./BaseExchangeItem.yaml + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer notifications when the exchange is updated. + difference_due: + type: number + title: difference_due + description: >- + The amount to be exchanged or refunded. If the amount is negative, it must + be refunded. If positive, additional payment is required from the + customer. + return: + description: the return associated with the exchange. + $ref: ./AdminReturn.yaml + return_id: + type: string + title: return_id + description: The ID of the associated exchange. + 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 ID of the associated order's region. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the associated order belongs to. + email: + type: string + title: email + description: The email used when placing the order. + format: email + display_id: + type: number + title: display_id + description: The exchange's display ID. + shipping_address: + description: The shipping address to send new items to. + $ref: ./BaseOrderAddress.yaml + billing_address: + description: The customer's billing address. + $ref: ./BaseOrderAddress.yaml + shipping_methods: + type: array + description: The shipping methods used to send the new (outbound) items. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + description: The exchange's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments of new (outbound) items. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + description: The exchange's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + items: + $ref: ./BaseOrderTransaction.yaml + summary: + description: The totals summary of the exchange. + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The exchange's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date that the exchange was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date that the exchange was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The total tax of the original items in the order. + item_total: + type: number + title: item_total + description: The total of the exchange's new items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the exchange's new items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the exchange's new items. + original_total: + type: number + title: original_total + description: The total of the order. + original_subtotal: + type: number + title: original_subtotal + description: The subtotal of the order. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order. + total: + type: number + title: total + description: The total of the exchange. + subtotal: + type: number + title: subtotal + description: The subtotal of the exchange. + tax_total: + type: number + title: tax_total + description: The tax total of the exchange. + discount_total: + type: number + title: discount_total + description: The discount total of the exchange. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on discount of the exchange. + gift_card_total: + type: number + title: gift_card_total + description: The gift cards total of the exchange. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The total taxes on the gift card of the exchange. + 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 order's shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml index d7584d2fbe..ccd2567ac5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml @@ -1,3 +1,106 @@ type: object -description: The item's detail. +description: The order item's detail. x-schemaName: OrderItem +required: + - id + - item_id + - item + - quantity + - raw_quantity + - fulfilled_quantity + - raw_fulfilled_quantity + - delivered_quantity + - raw_delivered_quantity + - shipped_quantity + - raw_shipped_quantity + - return_requested_quantity + - raw_return_requested_quantity + - return_received_quantity + - raw_return_received_quantity + - return_dismissed_quantity + - raw_return_dismissed_quantity + - written_off_quantity + - raw_written_off_quantity + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The item's ID. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + raw_fulfilled_quantity: + type: object + description: The item's raw fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The item's delivered quantity. + raw_delivered_quantity: + type: object + description: The item's raw delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + raw_shipped_quantity: + type: object + description: The item's raw shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + raw_return_requested_quantity: + type: object + description: The item's raw return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The item's quantity that's received through a return. + raw_return_received_quantity: + type: object + description: The item's raw return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The item's quantity that's returned but dismissed because it's damaged. + raw_return_dismissed_quantity: + type: object + description: The item's raw return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed due to an order change. + raw_written_off_quantity: + type: object + description: The item's raw written off quantity. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. 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..7872ecc8f1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml @@ -0,0 +1,435 @@ +type: object +description: The order line item's details. +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 URL. + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the associated product's type. + product_collection: + type: string + title: product_collection + description: The ID of the associated product's 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 associated variant's values for the associated product's options. + example: + Color: Red + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item's price includes taxes. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw compare at unit price's value. + - type: number + title: value + description: The raw compare at unit price's value. + unit_price: + type: number + title: unit_price + description: The item's price for a single quantity. + raw_unit_price: + type: object + description: The item's raw unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw unit price's value. + - type: number + title: value + description: The raw unit price's value. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + 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 + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes and promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. + item_total: + type: number + title: item_total + description: The item's total for a single quantity, including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: >- + The item's total for a single quantity, excluding taxes and including + promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of a single quantity of the item, including promotions. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the item, including promotions. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total amount of the item that can be refunded. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total amount that can be refunded of a single quantity of the item. + raw_original_total: + type: object + description: The item'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 item'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 item'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_item_total: + type: object + description: The item'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 item'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 item'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_total: + type: object + description: The item'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 item'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 item'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 item'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 item'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_refundable_total: + type: object + description: The item's raw refundable total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total's value. + - type: number + title: value + description: The raw refundable total's value. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total per unit's value. + - type: number + title: value + description: The raw refundable total per unit's value. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml index 18f5e20824..caeb06aecf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The line item adjustment's details. x-schemaName: OrderLineItemAdjustment +required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml index 0b002d0419..90d590d62b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml @@ -1,3 +1,70 @@ type: object -description: The tax line's tax lines. +description: The line item tax line's details. x-schemaName: OrderLineItemTaxLine +required: + - item + - item_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the line item that the tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax lines. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml deleted file mode 100644 index 56edabcde0..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml +++ /dev/null @@ -1,1550 +0,0 @@ -type: object -description: The order edit's order preview. -x-schemaName: OrderPreview -required: - - order_change - - status - - currency_code - - version - - id - - 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: - order_change: - $ref: ./OrderChange.yaml - items: - type: array - description: The order preview's items. - items: - allOf: - - 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 - format: date-time - title: created_at - description: The item's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The item's updated at. - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: ./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. - - 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: OrderChangeAction - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - allOf: - - 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. - - 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: OrderChangeAction - status: - type: string - description: The order preview's status. - enum: - - canceled - - requires_action - - pending - - completed - - draft - - archived - currency_code: - type: string - title: currency_code - description: The order preview's currency code. - version: - type: number - title: version - description: The order preview's version. - id: - type: string - title: id - description: The order preview's ID. - 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 - shipping_address: - $ref: ./OrderAddress.yaml - billing_address: - $ref: ./OrderAddress.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 - - pending_difference - - raw_pending_difference - 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 - pending_difference: - oneOf: - - type: string - title: pending_difference - description: The summary's pending difference. - - type: number - title: pending_difference - description: The summary's pending difference. - - type: string - title: pending_difference - description: The summary's pending difference. - - type: object - description: The summary's pending difference. - x-schemaName: IBigNumber - raw_pending_difference: - type: object - description: The summary's raw pending difference. - 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: - 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 - 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 - 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/OrderReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml new file mode 100644 index 0000000000..2b2fa31a38 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml @@ -0,0 +1,50 @@ +type: object +description: The item's items. +x-schemaName: OrderReturnItem +required: + - id + - quantity + - received_quantity + - damaged_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 received quantity of the item. This quantity is added to the stocked + inventory quantity of the item. + damaged_quantity: + type: number + title: damaged_quantity + description: >- + The received damaged quantity of the item, which isn't added to the + stocked inventory quantity of the item. + reason_id: + type: string + title: reason_id + description: The ID of the return reason associated with the item. + note: + type: string + title: note + description: A note about why the item was returned. + item_id: + type: string + title: item_id + description: The ID of the associated order item. + return_id: + type: string + title: return_id + description: The ID of the return this return item belongs to. + metadata: + type: object + description: The return item's metadata, can hold custom key-value pairs. 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..892005eea0 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml @@ -0,0 +1,246 @@ +type: object +description: The shipping method's details. +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 ID of the order that the shipping method belongs to. + 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. + raw_amount: + type: object + description: The shipping method's raw amount. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw amount's value. + - type: number + title: value + description: The raw amount's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the shipping method's amount includes taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: >- + The shipping method's data, useful for the fulfillment provider handling + the fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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 date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's subtotal excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the shipping method excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the shipping method, including promotions. + discount_total: + type: number + title: discount_total + description: The shipping method's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes of the discount amount. + raw_original_total: + type: object + description: The shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml index a05be82f62..c63afb13c0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The shipping method adjustment's details. x-schemaName: OrderShippingMethodAdjustment +required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion this adjustment applies. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml index 89976e41b4..d49d3e1414 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml @@ -1,3 +1,70 @@ type: object -description: The tax line's tax lines. +description: The shipping method tax line's details. x-schemaName: OrderShippingMethodTaxLine +required: + - shipping_method + - shipping_method_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method that this tax line is for. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml index fe6226719f..100e873e64 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml @@ -1,18 +1,16 @@ type: object -description: The transaction's transactions. +description: The transaction's details. x-schemaName: OrderTransaction required: - id - order_id - - order - amount - - raw_amount - currency_code - reference - reference_id + - metadata - created_at - updated_at - - metadata properties: id: type: string @@ -21,46 +19,40 @@ properties: order_id: type: string title: order_id - description: The transaction's order id. - order: - type: object + description: The ID of the order this transaction belongs to. 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. + type: number + title: amount + description: The transaction's amount. currency_code: type: string title: currency_code description: The transaction's currency code. + example: usd reference: type: string title: reference - description: The transaction's reference. + description: >- + The name of a table that this transaction references. If this transaction + is for captured payment, its value is `capture`. If this transaction is + for refunded payment, its value is `refund`. + enum: + - capture + - refund reference_id: type: string title: reference_id - description: The transaction's reference id. + description: The ID of the referenced record in the referenced table. + metadata: + type: object + description: The transaction's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The transaction's created at. + description: The date that the transaction was created. updated_at: type: string format: date-time title: updated_at - description: The transaction's updated at. - metadata: - type: object - description: The transaction's metadata. + description: The date that the transaction was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml new file mode 100644 index 0000000000..5c68174797 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/RefundReason.yaml @@ -0,0 +1,35 @@ +type: object +description: The refund reason's details. +x-schemaName: RefundReason +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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund reason was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the refund reason was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml index 2ccee98673..e3f9c36587 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/RefundReasonResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The refund reason's details. x-schemaName: RefundReasonResponse required: - refund_reason diff --git a/www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml deleted file mode 100644 index d66cc74750..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/ReservationResponse.yaml +++ /dev/null @@ -1,66 +0,0 @@ -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 index 529ada57ca..b16dbae793 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml @@ -1,3 +1,299 @@ type: object -description: The order change's return order. +description: The return's details. x-schemaName: Return +required: + - id + - status + - order_id + - items + - currency_code + - 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 + - discount_subtotal + - 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 return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. + order_id: + type: string + title: order_id + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: ./OrderReturnItem.yaml + region_id: + type: string + title: region_id + description: The ID of the region this return belongs to. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the associated order's sales channel. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The return's currency code. + example: usd + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + shipping_methods: + type: array + description: The return's shipping methods. + items: + $ref: ./OrderShippingMethod.yaml + transactions: + type: array + description: The return's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The return's summary. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the return was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the return was updated. + original_item_total: + type: number + title: original_item_total + description: The return's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The return's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The return's original item tax total. + item_total: + type: number + title: item_total + description: The return's item total. + item_subtotal: + type: number + title: item_subtotal + description: The return's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The return's item tax total. + original_total: + type: number + title: original_total + description: The return's original total. + original_subtotal: + type: number + title: original_subtotal + description: The return's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The return's original tax total. + total: + type: number + title: total + description: The return's total. + subtotal: + type: number + title: subtotal + description: The return's subtotal. + tax_total: + type: number + title: tax_total + description: The return's tax total. + discount_total: + type: number + title: discount_total + description: The return's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The return's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The return's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The return's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The return's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The return's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The return's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The return's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The return's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The return's original shipping tax total. + order_change: + $ref: ./OrderChange.yaml + canceled_at: + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time + discount_subtotal: + type: number + title: discount_subtotal + description: The return's discount subtotal. + raw_original_item_total: + type: object + description: The return's raw original item total. + raw_original_item_subtotal: + type: object + description: The return's raw original item subtotal. + raw_original_item_tax_total: + type: object + description: The return's raw original item tax total. + raw_item_total: + type: object + description: The return's raw item total. + raw_item_subtotal: + type: object + description: The return's raw item subtotal. + raw_item_tax_total: + type: object + description: The return's raw item tax total. + raw_original_total: + type: object + description: The return's raw original total. + raw_original_subtotal: + type: object + description: The return's raw original subtotal. + raw_original_tax_total: + type: object + description: The return's raw original tax total. + raw_total: + type: object + description: The return's raw total. + raw_subtotal: + type: object + description: The return's raw subtotal. + raw_tax_total: + type: object + description: The return's raw tax total. + raw_discount_total: + type: object + description: The return's raw discount total. + raw_discount_tax_total: + type: object + description: The return's raw discount tax total. + raw_gift_card_total: + type: object + description: The return's raw gift card total. + raw_gift_card_tax_total: + type: object + description: The return's raw gift card tax total. + raw_shipping_total: + type: object + description: The return's raw shipping total. + raw_shipping_subtotal: + type: object + description: The return's raw shipping subtotal. + raw_shipping_tax_total: + type: object + description: The return's raw shipping tax total. + raw_original_shipping_total: + type: object + description: The return's raw original shipping total. + raw_original_shipping_subtotal: + type: object + description: The return's raw original shipping subtotal. + raw_original_shipping_tax_total: + type: object + description: The return's raw original shipping tax total. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml index c791cbd824..8ce18622d4 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the line item to add. x-schemaName: StoreAddCartLineItem required: - variant_id @@ -8,11 +8,11 @@ properties: variant_id: type: string title: variant_id - description: The cart's variant id. + description: The ID of the product variant to add to the cart. quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml deleted file mode 100644 index 729f1b95bd..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCalculateCartTaxes.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StoreCalculateCartTaxes -properties: - fields: - type: string - title: fields - description: The cart's fields. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml index 73037779af..9ec4dc1c9f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml @@ -1,9 +1,9 @@ type: object -description: The cart's parent. +description: The cart's details. x-schemaName: StoreCart required: - - id - currency_code + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -30,320 +30,148 @@ properties: id: type: string title: id - description: The parent's ID. + description: The cart's ID. region: - $ref: ./BaseRegion.yaml + $ref: ./StoreRegion.yaml region_id: type: string title: region_id - description: The parent's region id. + description: The ID of the region the cart belongs to. customer_id: type: string title: customer_id - description: The parent's customer id. + description: The ID of the customer the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The parent's sales channel id. + description: >- + The ID of the cart's sales channel. Only products that belong to the same + sales channel can be added to the cart. The created order will be + associated with the same sales channel. email: type: string title: email - description: The parent's email. + description: The email of the customer the cart belongs to. format: email currency_code: type: string title: currency_code - description: The parent's currency code. + description: The cart's currency code. + example: usd shipping_address: - $ref: ./BaseCartAddress.yaml + $ref: ./StoreCartAddress.yaml billing_address: - $ref: ./BaseCartAddress.yaml + $ref: ./StoreCartAddress.yaml items: type: array - description: The parent's items. + description: The cart's items. items: - $ref: ./BaseCartLineItem.yaml + $ref: ./StoreCartLineItem.yaml shipping_methods: type: array - description: The parent's shipping methods. + description: The cart's shipping methods. items: - $ref: ./BaseCartShippingMethod.yaml + $ref: ./StoreCartShippingMethod.yaml payment_collection: - $ref: ./BasePaymentCollection.yaml + $ref: ./StorePaymentCollection.yaml metadata: type: object - description: The parent's metadata. + description: The cart's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the cart was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the cart was updated. original_item_total: - oneOf: - - type: string - title: original_item_total - description: The parent's original item total. - - type: number - title: original_item_total - description: The parent's original item total. - - type: string - title: original_item_total - description: The parent's original item total. - - $ref: ./IBigNumber.yaml + type: number + title: original_item_total + description: The cart items' total including taxes, excluding promotions. original_item_subtotal: - oneOf: - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - type: number - title: original_item_subtotal - description: The parent's original item subtotal. - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: original_item_subtotal + description: The cart items' total excluding taxes, including promotions. original_item_tax_total: - oneOf: - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - type: number - title: original_item_tax_total - description: The parent's original item tax total. - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - $ref: ./IBigNumber.yaml + type: number + title: original_item_tax_total + description: The cart items' tax total excluding promotions. item_total: - oneOf: - - type: string - title: item_total - description: The parent's item total. - - type: number - title: item_total - description: The parent's item total. - - type: string - title: item_total - description: The parent's item total. - - $ref: ./IBigNumber.yaml + type: number + title: item_total + description: The cart items' total including taxes and promotions. item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The parent's item subtotal. - - type: number - title: item_subtotal - description: The parent's item subtotal. - - type: string - title: item_subtotal - description: The parent's item subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: item_subtotal + description: The cart items' total excluding taxes, including promotions. item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The parent's item tax total. - - type: number - title: item_tax_total - description: The parent's item tax total. - - type: string - title: item_tax_total - description: The parent's item tax total. - - $ref: ./IBigNumber.yaml + type: number + title: item_tax_total + description: The cart items' tax total including promotions. original_total: - oneOf: - - type: string - title: original_total - description: The parent's original total. - - type: number - title: original_total - description: The parent's original total. - - type: string - title: original_total - description: The parent's original total. - - $ref: ./IBigNumber.yaml + type: number + title: original_total + description: The cart's total including taxes, excluding promotions. original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The parent's original subtotal. - - type: number - title: original_subtotal - description: The parent's original subtotal. - - type: string - title: original_subtotal - description: The parent's original subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: original_subtotal + description: The cart's total excluding taxes, including promotions. original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The parent's original tax total. - - type: number - title: original_tax_total - description: The parent's original tax total. - - type: string - title: original_tax_total - description: The parent's original tax total. - - $ref: ./IBigNumber.yaml + type: number + title: original_tax_total + description: The cart's tax total excluding promotions. total: - oneOf: - - type: string - title: total - description: The parent's total. - - type: number - title: total - description: The parent's total. - - type: string - title: total - description: The parent's total. - - $ref: ./IBigNumber.yaml + type: number + title: total + description: The cart's total including taxes and promotions. subtotal: - oneOf: - - type: string - title: subtotal - description: The parent's subtotal. - - type: number - title: subtotal - description: The parent's subtotal. - - type: string - title: subtotal - description: The parent's subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: subtotal + description: The cart's total excluding taxes, including promotions. tax_total: - oneOf: - - type: string - title: tax_total - description: The parent's tax total. - - type: number - title: tax_total - description: The parent's tax total. - - type: string - title: tax_total - description: The parent's tax total. - - $ref: ./IBigNumber.yaml + type: number + title: tax_total + description: The cart's tax total including promotions. discount_total: - oneOf: - - type: string - title: discount_total - description: The parent's discount total. - - type: number - title: discount_total - description: The parent's discount total. - - type: string - title: discount_total - description: The parent's discount total. - - $ref: ./IBigNumber.yaml + type: number + title: discount_total + description: The cart's discount total. discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - type: number - title: discount_tax_total - description: The parent's discount tax total. - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - $ref: ./IBigNumber.yaml + type: number + title: discount_tax_total + description: The tax total applied on the discounted amount. gift_card_total: - oneOf: - - type: string - title: gift_card_total - description: The parent's gift card total. - - type: number - title: gift_card_total - description: The parent's gift card total. - - type: string - title: gift_card_total - description: The parent's gift card total. - - $ref: ./IBigNumber.yaml + type: number + title: gift_card_total + description: The total gift card amount applied on the cart. gift_card_tax_total: - oneOf: - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: number - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - $ref: ./IBigNumber.yaml + type: number + title: gift_card_tax_total + description: The total taxes applied on the gift card amount. shipping_total: - oneOf: - - type: string - title: shipping_total - description: The parent's shipping total. - - type: number - title: shipping_total - description: The parent's shipping total. - - type: string - title: shipping_total - description: The parent's shipping total. - - $ref: ./IBigNumber.yaml + type: number + title: shipping_total + description: The cart's shipping total including taxes and promotions. shipping_subtotal: - oneOf: - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: number - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. shipping_tax_total: - oneOf: - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - type: number - title: shipping_tax_total - description: The parent's shipping tax total. - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - $ref: ./IBigNumber.yaml + type: number + title: shipping_tax_total + description: The total taxes applied on the cart's shipping amount. original_shipping_total: - oneOf: - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - type: number - title: original_shipping_total - description: The parent's original shipping total. - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - $ref: ./IBigNumber.yaml + type: number + title: original_shipping_total + description: The cart's shipping total including taxes, excluding promotions. original_shipping_subtotal: - oneOf: - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: number - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: original_shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. original_shipping_tax_total: - oneOf: - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: number - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - $ref: ./IBigNumber.yaml + type: number + title: original_shipping_tax_total + description: The total taxes applied on the cart's shipping amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml index af376781b2..15aa12c9eb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's billing address. +description: The address's details. x-schemaName: StoreCartAddress required: - id @@ -9,69 +9,62 @@ properties: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: - oneOf: - - type: string - title: created_at - description: The billing address's created at. - - type: string - title: created_at - description: The billing address's created at. - format: date-time + type: string + title: created_at + description: The date the address was created. + format: date-time updated_at: - oneOf: - - type: string - title: updated_at - description: The billing address's updated at. - - type: string - title: updated_at - description: The billing address's updated at. - format: date-time + type: string + title: updated_at + description: The date the address was updated. + format: date-time diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml index 1b92e40ec6..824b9623cb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartLineItem.yaml @@ -1,27 +1,27 @@ type: object -description: The item's items. +description: The item's details. x-schemaName: StoreCartLineItem required: - - id - - title - - quantity - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - cart - - cart_id - - original_total - - original_subtotal - - original_tax_total + - title + - id - item_total - item_subtotal - item_tax_total + - original_total + - original_subtotal + - original_tax_total - total - subtotal - tax_total - discount_total - discount_tax_total + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - cart_id properties: id: type: string @@ -38,25 +38,17 @@ properties: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The item's thumbnail URL. 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 + type: number + title: quantity + description: The item's quantity. product: - $ref: ./BaseProduct.yaml + $ref: ./StoreProduct.yaml product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -72,25 +64,25 @@ properties: product_type: type: string title: product_type - description: The item's product type. + description: The ID of the associated product's type. product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the associated product's collection. product_handle: type: string title: product_handle description: The item's product handle. variant: - $ref: ./BaseProductVariant.yaml + $ref: ./StoreProductVariant.yaml variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -101,206 +93,246 @@ properties: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The associated variant's value for the product's options. + example: + Color: Red requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item's price includes taxes. 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 + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. 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 + type: number + title: unit_price + description: The price of a single quantity of the item. tax_lines: type: array description: The item's tax lines. items: - $ref: ./BaseLineItemTaxLine.yaml + allOf: + - type: object + description: The tax line's details. + x-schemaName: BaseLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + item_id: + type: string + title: item_id + description: The ID of the line item this tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + description: The tax line's details adjustments: type: array description: The item's adjustments. items: - $ref: ./BaseLineItemAdjustment.yaml + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseLineItemAdjustment + required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + item_id: + type: string + title: item_id + description: The ID of the item that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + description: The adjustment's details. cart: - $ref: ./BaseCart.yaml + type: object cart_id: type: string title: cart_id - description: The item's cart id. + description: The ID of the cart that the line item belongs to. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string title: created_at - description: The item's created at. + description: The date the item was created. format: date-time updated_at: type: string title: updated_at - description: The item's updated at. + description: The date the item was updated. format: date-time deleted_at: type: string title: deleted_at - description: The item's deleted at. + description: The date the item was deleted. 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 + type: number + title: original_total + description: The item's total including taxes, excluding promotions. 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 + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. 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 + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. 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 + type: number + title: original_tax_total + description: The item's total including taxes and promotions. 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 + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. 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 + type: number + title: item_tax_total + description: The total taxes of the item including promotions. 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 + type: number + title: total + description: The item's total including taxes and promotions. 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 + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. 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 + type: number + title: tax_total + description: The total taxes of the item including promotions. 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 + type: number + title: discount_total + description: The total discount of the item. 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 + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml index 2bfa43f956..43ad8c7035 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The cart's details. x-schemaName: StoreCartResponse required: - cart diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml new file mode 100644 index 0000000000..818a670856 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCartShippingMethod.yaml @@ -0,0 +1,253 @@ +type: object +description: A cart's shipping method. +x-schemaName: StoreCartShippingMethod +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 ID of the cart this shipping method belongs to. + 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: Whether the shipping method's amount is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: >- + The shipping method's data, useful for fulfillment handling by third-party + services. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's details + x-schemaName: BaseShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments, such as applied promotions. + items: + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + description: The adjustment's details. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. + total: + type: number + title: total + description: The shipping method's total amount including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. + discount_total: + type: number + title: discount_total + description: The total amount discounted. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discounted amount. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml index a336103bb6..ad9bc1b4ea 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml @@ -2,13 +2,13 @@ type: object description: The collection's details. x-schemaName: StoreCollection required: - - id - title + - metadata + - id - handle - created_at - updated_at - deleted_at - - metadata properties: id: type: string @@ -26,22 +26,22 @@ properties: type: string format: date-time title: created_at - description: The collection's created at. + description: The date the collection was created. updated_at: type: string format: date-time title: updated_at - description: The collection's updated at. + description: The date the collection was updated. deleted_at: type: string format: date-time title: deleted_at - description: The collection's deleted at. + description: The date the collection was deleted. products: type: array description: The collection's products. items: - $ref: ./AdminProduct.yaml + type: object metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml index ad095a583e..ee547bec16 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCollectionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The collection's details. x-schemaName: StoreCollectionResponse required: - collection diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml index 41c5888a13..69fb5ff088 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCart.yaml @@ -1,11 +1,13 @@ type: object -description: SUMMARY +description: The details of the cart to be created. x-schemaName: StoreCreateCart properties: region_id: type: string title: region_id - description: The cart's region id. + description: >- + The ID of the cart's region. This affects the prices and currency of the + cart. shipping_address: $ref: ./StoreCartAddress.yaml billing_address: @@ -13,12 +15,15 @@ properties: email: type: string title: email - description: The cart's email. + description: The email of the cart's customer. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: >- + The cart's currency code. If not provided, the region's currency is used. + This affects prices in the cart, as well. + example: usd items: type: array description: The cart's items. @@ -27,7 +32,10 @@ properties: sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: >- + The ID of the sales channel that cart is created in. Only products + available in that sales channel can be added to the cart. If not provided, + the store's default sales channel is associated with the cart instead. metadata: type: object - description: The cart's metadata. + description: The cart's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml index f8f116c0fa..6821b05339 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the customer to create. x-schemaName: StoreCreateCustomer required: - email @@ -27,4 +27,4 @@ properties: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml index c88dbe20d2..d93623368f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreatePaymentCollection.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the payment collection to create. x-schemaName: StoreCreatePaymentCollection required: - cart_id @@ -7,4 +7,4 @@ properties: cart_id: type: string title: cart_id - description: The payment collection's cart id. + description: The ID of the cart this payment collection is for. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml index 60c6dc1fd5..bd5befc29b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturn.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the return to create. x-schemaName: StoreCreateReturn required: - order_id @@ -9,7 +9,7 @@ properties: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. items: type: array description: The return's items. @@ -20,12 +20,12 @@ properties: note: type: string title: note - description: The return's note. + description: A note with more details about the return. receive_now: type: boolean title: receive_now - description: The return's receive now. + description: Whether to mark the return as received. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location that items are returned to. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml index 021192cc25..ecdbeb0c2d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnItem.yaml @@ -1,5 +1,5 @@ type: object -description: The item's items. +description: The details of the line item to create. x-schemaName: StoreCreateReturnItem required: - id @@ -16,8 +16,8 @@ properties: reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. note: type: string title: note - description: The item's note. + description: A note with more details about the returned item. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml index ff842a7175..ee60d6374b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCreateReturnShipping.yaml @@ -1,5 +1,5 @@ type: object -description: The return's return shipping. +description: The return's shipping details. x-schemaName: StoreCreateReturnShipping required: - option_id @@ -7,8 +7,8 @@ properties: option_id: type: string title: option_id - description: The return shipping's option id. + description: The ID of the shipping option to use. price: type: number title: price - description: The return shipping's price. + description: The shipping's price. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml index 05eec9f84d..70e56aa4eb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrency.yaml @@ -8,7 +8,6 @@ required: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at @@ -17,6 +16,7 @@ properties: type: string title: code description: The currency's code. + example: usd symbol: type: string title: symbol @@ -37,33 +37,18 @@ properties: 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. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The currency's deleted at. + description: The date the currency was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml index cb51836b4b..349a669091 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of currencies. x-schemaName: StoreCurrencyListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The currency's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The currency's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The currency's count. + description: The total count of items. currencies: type: array - description: The currency's currencies. + description: The list of 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 index 18fffcdeeb..2bb1a6b68a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCurrencyResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The currency's details. x-schemaName: StoreCurrencyResponse required: - currency diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml index c6626ecc9c..0c0997ff3f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomer.yaml @@ -1,73 +1,69 @@ type: object -description: The customer's parent. +description: The customer's details. x-schemaName: StoreCustomer required: + - addresses - id - email - - default_billing_address_id - - default_shipping_address_id - company_name - first_name - last_name - - addresses + - default_billing_address_id + - default_shipping_address_id properties: id: type: string title: id - description: The parent's ID. + description: The customer's ID. email: type: string title: email - description: The parent's email. + description: The customer's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The parent's default billing address id. + description: The ID of the address used for billing by default. default_shipping_address_id: type: string title: default_shipping_address_id - description: The parent's default shipping address id. + description: The ID of the address used for shipping by default. company_name: type: string title: company_name - description: The parent's company name. + description: The customer's company name. first_name: type: string title: first_name - description: The parent's first name. + description: The customer's first name. last_name: type: string title: last_name - description: The parent's last name. + description: The customer's last name. addresses: type: array - description: The parent's addresses. + description: The customer's addresses. items: - $ref: ./BaseCustomerAddress.yaml + $ref: ./StoreCustomerAddress.yaml phone: type: string title: phone - description: The parent's phone. + description: The customer's phone. metadata: type: object - description: The parent's metadata. - created_by: - type: string - title: created_by - description: The parent's created by. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + description: The customer's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the customer was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the customer was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the customer was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml index 8bc8942adb..4d3108e25f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's address. +description: The customer address's details x-schemaName: StoreCustomerAddress required: - id @@ -28,19 +28,19 @@ properties: address_name: type: string title: address_name - description: The address's address name. + description: The address's name. is_default_shipping: type: boolean title: is_default_shipping - description: The address's is default shipping. + description: Whether the address is used for shipping by default. is_default_billing: type: boolean title: is_default_billing - description: The address's is default billing. + description: Whether the address is used for billing by default. customer_id: type: string title: customer_id - description: The address's customer id. + description: The ID of the customer the address belongs to. company: type: string title: company @@ -56,11 +56,11 @@ properties: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. city: type: string title: city @@ -69,6 +69,7 @@ properties: type: string title: country_code description: The address's country code. + example: usd province: type: string title: province @@ -83,14 +84,14 @@ properties: description: The address's phone. metadata: type: object - description: The address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The address's updated at. + description: The date the address was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml index ae6cf1559e..e04348e7e3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of customer addresses. x-schemaName: StoreCustomerAddressListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The customer's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer's count. + description: The total number of items. addresses: type: array - description: The customer's addresses. + description: The list of 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 index a665e19eb1..515fa48b09 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerAddressResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The address's details. x-schemaName: StoreCustomerAddressResponse required: - address diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml index c121ca1d70..f64fdf1657 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCustomerResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The customer's details. x-schemaName: StoreCustomerResponse required: - customer diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml index 188ac9c5e5..58ff75075f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's order. +description: The order's details. x-schemaName: StoreOrder required: - id @@ -51,28 +51,29 @@ properties: region_id: type: string title: region_id - description: The order's region id. + description: The ID of the associated region. customer_id: type: string title: customer_id - description: The order's customer id. + description: The ID of the customer that placed the order. sales_channel_id: type: string title: sales_channel_id - description: The order's sales channel id. + description: The ID of the sales channel the order was placed in. email: type: string title: email - description: The order's email. + description: The email of the customer that placed the order. format: email currency_code: type: string title: currency_code description: The order's currency code. + example: usd display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. shipping_address: $ref: ./BaseOrderAddress.yaml billing_address: @@ -123,74 +124,69 @@ properties: - 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. + description: The order's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The order's created at. + description: The date the order was created. updated_at: type: string format: date-time title: updated_at - description: The order's updated at. + description: The date the order was updated. original_item_total: type: number title: original_item_total - description: The order's original item total. + description: The order items' total including taxes, excluding promotions. original_item_subtotal: type: number title: original_item_subtotal - description: The order's original item subtotal. + description: The order items' total excluding taxes, including promotions. original_item_tax_total: type: number title: original_item_tax_total - description: The order's original item tax total. + description: The total taxes applied on the order items, excluding promotions. item_total: type: number title: item_total - description: The order's item total. + description: The order items' total including taxes and promotions. item_subtotal: type: number title: item_subtotal - description: The order's item subtotal. + description: The order items' total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The order's item tax total. + description: The total taxes applied on the order's items, including promotions. original_total: type: number title: original_total - description: The order's original total. + description: The order's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The order's original subtotal. + description: The order's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The order's original tax total. + description: The total taxes of the order excluding promotions. total: type: number title: total - description: The order's total. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The order's subtotal. + description: The order's total excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The order's tax total. + description: The tax totals of the order including promotions. discount_total: type: number title: discount_total @@ -198,7 +194,7 @@ properties: discount_tax_total: type: number title: discount_tax_total - description: The order's discount tax total. + description: The total taxes applied on the discounted amount. gift_card_total: type: number title: gift_card_total @@ -206,28 +202,28 @@ properties: gift_card_tax_total: type: number title: gift_card_tax_total - description: The order's gift card tax total. + description: The total taxes applied on the gift card's amount. shipping_total: type: number title: shipping_total - description: The order's shipping total. + description: The order's shipping total including taxes and promotions. shipping_subtotal: type: number title: shipping_subtotal - description: The order's shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. shipping_tax_total: type: number title: shipping_tax_total - description: The order's shipping tax total. + description: The total taxes of the order's shipping including promotions. original_shipping_total: type: number title: original_shipping_total - description: The order's original shipping total. + description: The order's shipping total including taxes, excluding promotions. original_shipping_subtotal: type: number title: original_shipping_subtotal - description: The order's original shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. original_shipping_tax_total: type: number title: original_shipping_tax_total - description: The order's original shipping tax total. + description: The total taxes of the order's shipping excluding promotions. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml index c0ce372244..ee6f5a725e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order's details. x-schemaName: StoreOrderResponse required: - order diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml index 94658ceb27..01509e2578 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollection.yaml @@ -2,12 +2,12 @@ type: object description: The payment collection's details. x-schemaName: StorePaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -20,77 +20,41 @@ properties: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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 + type: number + title: amount + description: The total amount to be paid. 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 + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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 + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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 + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -102,14 +66,16 @@ properties: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: >- + The payment provider used to process the collection's payments and + sessions. items: - $ref: ./BasePaymentProvider.yaml + $ref: ./StorePaymentProvider.yaml payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: ./BasePaymentSession.yaml + $ref: ./StorePaymentSession.yaml payments: type: array description: The payment collection's payments. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml index 3f4dd244b0..dd6dbcee76 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentCollectionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The payment collection's details. x-schemaName: StorePaymentCollectionResponse required: - payment_collection diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml index 70de4c3efc..81642fa9ec 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentProvider.yaml @@ -1,5 +1,5 @@ type: object -description: The payment provider's payment providers. +description: The payment provider's details x-schemaName: StorePaymentProvider required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/StorePaymentSession.yaml b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentSession.yaml new file mode 100644 index 0000000000..7d6195667e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StorePaymentSession.yaml @@ -0,0 +1,61 @@ +type: object +description: The payment session's details. +x-schemaName: StorePaymentSession +properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: >- + The payment session's data, useful for the payment provider processing the + payment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: ./BasePayment.yaml +required: + - id + - amount + - currency_code + - provider_id + - data + - status 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 7062d98f47..044867e21f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -2,15 +2,14 @@ type: object description: The product's details. x-schemaName: StoreProduct required: + - variants + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - - variants - handle - subtitle - is_giftcard @@ -24,9 +23,10 @@ required: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: categories: @@ -56,7 +56,7 @@ properties: type: array description: The product's options. items: - $ref: ./BaseProductOption.yaml + $ref: ./StoreProductOption.yaml description: type: string title: description @@ -67,22 +67,22 @@ properties: description: The product's ID. metadata: type: object - description: The product's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The product's updated at. + description: The date the product was updated. variants: type: array description: The product's variants. items: - $ref: ./BaseProductVariant.yaml + $ref: ./StoreProductVariant.yaml handle: type: string title: handle @@ -94,11 +94,11 @@ properties: is_giftcard: type: boolean title: is_giftcard - description: The product's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The product's thumbnail. + description: The product's thumbnail URL. width: type: number title: width @@ -118,45 +118,45 @@ properties: hs_code: type: string title: hs_code - description: The product's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The product's mid code. + description: The product's MID code. material: type: string title: material description: The product's material. collection: - $ref: ./BaseCollection.yaml + $ref: ./StoreCollection.yaml collection_id: type: string title: collection_id - description: The product's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The product's type id. + description: The ID of the product's type. tags: type: array description: The product's tags. items: - $ref: ./BaseProductTag.yaml + $ref: ./StoreProductTag.yaml images: type: array description: The product's images. items: - $ref: ./BaseProductImage.yaml + $ref: ./StoreProductImage.yaml discountable: type: boolean title: discountable - description: The product's discountable. + description: Whether the product can be discounted. external_id: type: string title: external_id - description: The product's external id. + description: The ID of the product in an external service or system. deleted_at: type: string format: date-time title: deleted_at - description: The product's deleted at. + description: The date the product was deleted. 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 d164aa2e9c..cea963e49c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategory.yaml @@ -1,13 +1,11 @@ type: object -description: The category's categories. +description: The category's details. x-schemaName: StoreProductCategory required: - id - name - description - handle - - is_active - - is_internal - rank - parent_category_id - parent_category @@ -37,14 +35,6 @@ properties: type: string title: handle description: The category's handle. - 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 @@ -52,29 +42,29 @@ properties: parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. parent_category: - $ref: ./BaseProductCategory.yaml + type: object category_children: type: array - description: The category's category children. + description: The category's children. items: - $ref: ./BaseProductCategory.yaml + type: object metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml index 0b9eedfe4f..124035ab92 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product categories. x-schemaName: StoreProductCategoryListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: ./StoreProductCategory.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml index 05dc39f824..7530c17d57 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductCategoryResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product category's details. x-schemaName: StoreProductCategoryResponse required: - product_category diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml new file mode 100644 index 0000000000..632f1a9c1a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductImage.yaml @@ -0,0 +1,33 @@ +type: object +description: The image's details. +x-schemaName: StoreProductImage +required: + - id + - url +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml new file mode 100644 index 0000000000..40ba71a5d9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOption.yaml @@ -0,0 +1,44 @@ +type: object +description: The product option's details. +x-schemaName: StoreProductOption +properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The ID of the product this option belongs to. + values: + type: array + description: The option's values. + items: + $ref: ./StoreProductOptionValue.yaml + metadata: + type: object + description: The option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the product option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the product option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the product option was deleted. +required: + - title + - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml new file mode 100644 index 0000000000..9a754c37c2 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductOptionValue.yaml @@ -0,0 +1,39 @@ +type: object +description: The product option value's details. +x-schemaName: StoreProductOptionValue +required: + - value + - id +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml index ac22f2a56f..aab52a7a1d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product's details. x-schemaName: StoreProductResponse required: - product diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml new file mode 100644 index 0000000000..1e31fdb2fb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductTag.yaml @@ -0,0 +1,35 @@ +type: object +description: The tag's details. +x-schemaName: StoreProductTag +properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The date the tag was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tag was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the tag was deleted. + metadata: + type: object + description: The tag's metadata, can hold custom key-value pairs. +required: + - id + - value + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml new file mode 100644 index 0000000000..4d7558620a --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml @@ -0,0 +1,140 @@ +type: object +description: The variant's details. +x-schemaName: StoreProductVariant +properties: + options: + type: array + description: The variant's options. + items: + $ref: ./StoreProductOptionValue.yaml + product: + type: object + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. + id: + type: string + title: id + description: The variant's ID. + width: + type: number + title: width + description: The variant's width. + weight: + type: number + title: weight + description: The variant's weight. + height: + type: number + title: height + description: The variant's height. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + 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. + material: + type: string + title: material + description: The variant's material. + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + product_id: + type: string + title: product_id + description: The ID of the product this variant belongs to. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's not in stock. + manage_inventory: + type: boolean + title: manage_inventory + description: >- + Whether Medusa manages the variant's inventory. If disabled, the variant + is always considered in stock. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + inventory_quantity: + type: number + title: inventory_quantity + description: >- + The variant's inventory quantity. This property is only available if you + pass `+variants.inventory_quantity` in the `fields` query parameter. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its siblings. + calculated_price: + $ref: ./BaseCalculatedPriceSet.yaml +required: + - options + - length + - title + - id + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - created_at + - updated_at + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml deleted file mode 100644 index 295b3c1fdd..0000000000 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariantParams.yaml +++ /dev/null @@ -1,76 +0,0 @@ -type: object -description: The product's variants. -x-schemaName: StoreProductVariantParams -properties: - q: - type: string - title: q - description: The variant's q. - id: - oneOf: - - type: string - title: id - description: The variant's ID. - - type: array - description: The variant's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The variant's options. - limit: - type: number - title: limit - description: The variant's limit. - offset: - type: number - title: offset - description: The variant's offset. - order: - type: string - title: order - description: The variant's order. - fields: - type: string - title: fields - description: The variant's fields. - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $or diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml index d07d5098a6..4f92f9c220 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreRegion.yaml @@ -18,10 +18,13 @@ properties: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: >- + Whether taxes are calculated automatically during checkout for carts that + belong to this region. countries: type: array description: The region's countries. @@ -34,14 +37,14 @@ properties: $ref: ./AdminPaymentProvider.yaml metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml new file mode 100644 index 0000000000..9fd9034074 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml @@ -0,0 +1,32 @@ +type: object +description: The country's details. +x-schemaName: StoreRegionCountry +required: + - id +properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's ISO 2 code. + example: us + iso_3: + type: string + title: iso_3 + description: The country's ISO 3 codel. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml index 4f35c16688..2b3ca272bf 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml @@ -2,14 +2,13 @@ type: object description: The return's details. x-schemaName: StoreReturn required: - - id - - order_id - - order_version - - display_id - items - - received_at + - order_id + - id - created_at + - display_id - canceled_at + - received_at properties: id: type: string @@ -18,7 +17,7 @@ properties: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. status: type: string title: status @@ -26,46 +25,38 @@ properties: exchange_id: type: string title: exchange_id - description: The return's exchange id. + description: The ID of the associated exchange. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. 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. + description: The ID of the associated claim. 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. + description: The return's display ID. refund_amount: type: number title: refund_amount - description: The return's refund amount. + description: The return's refunded amount. items: type: array description: The return's items. items: - $ref: ./BaseReturnItem.yaml + $ref: ./StoreReturnItem.yaml received_at: type: string title: received_at - description: The return's received at. + description: The date the return was received. created_at: type: string format: date-time title: created_at - description: The return's created at. + description: The date the return was created. canceled_at: type: string title: canceled_at - description: The return's canceled at. + description: The date the return was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml new file mode 100644 index 0000000000..878ce1a742 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnItem.yaml @@ -0,0 +1,46 @@ +type: object +description: The return item's details. +x-schemaName: StoreReturnItem +properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + received_quantity: + type: number + title: received_quantity + description: The item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. + reason_id: + type: string + title: reason_id + description: The ID of the item's reason. + note: + type: string + title: note + description: A note with more details on why the item is returned. + item_id: + type: string + title: item_id + description: The ID of the item in the order. + return_id: + type: string + title: return_id + description: The ID of the return this item belongs to. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. +required: + - id + - quantity + - received_quantity + - damaged_quantity + - item_id + - return_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml index 0b2be3c0f3..b08051fb32 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReason.yaml @@ -26,14 +26,14 @@ properties: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml index 19edb6a521..b3071e4427 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnReasonResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return reason's details. x-schemaName: StoreReturnReasonResponse required: - return_reason diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml index bac8524459..6dc083e1d5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturnResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: StoreReturnResponse required: - return diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml index 13a1160363..c1e75ff242 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOption.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping option's shipping options. +description: The shipping option's details. x-schemaName: StoreShippingOption required: - id @@ -26,30 +26,33 @@ properties: description: The shipping option's name. price_type: type: string - description: The shipping option's price type. + description: >- + The shipping option's price type. If it's `flat`, the price is fixed and + is set in the `prices` property. If it's `calculated`, the price is + calculated on checkout by the associated fulfillment provider. enum: - flat - calculated service_zone_id: type: string title: service_zone_id - description: The shipping option's service zone id. + description: The ID of the service zone the shipping option belongs to. provider_id: type: string title: provider_id - description: The shipping option's provider id. + description: The ID of the fulfillment provider handling this option. provider: $ref: ./BaseFulfillmentProvider.yaml shipping_option_type_id: type: string title: shipping_option_type_id - description: The shipping option's shipping option type id. + description: The ID of the shipping option's type. type: - type: object + $ref: ./StoreShippingOptionType.yaml shipping_profile_id: type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: The ID of the associated shipping profile. amount: type: number title: amount @@ -57,10 +60,13 @@ properties: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping option's is tax inclusive. + description: Whether the amount includes taxes. data: type: object - description: The shipping option's data. + description: The shipping option's data, useful for the provider handling fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping option's metadata. + description: The shipping option's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml index 8001c7a8c5..695f2175b1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping option's details. x-schemaName: StoreShippingOptionListResponse required: - shipping_options diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionType.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionType.yaml new file mode 100644 index 0000000000..d88dffb77d --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreShippingOptionType.yaml @@ -0,0 +1,48 @@ +type: object +description: The shipping option type's details. +x-schemaName: StoreShippingOptionType +required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The type's ID. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + created_at: + type: string + format: date-time + title: created_at + description: The date the type was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the type was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the type was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml index a6468aab56..844c2958ce 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in the line item. x-schemaName: StoreUpdateCartLineItem required: - quantity @@ -7,7 +7,7 @@ properties: quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml index f3f14b1f5e..0eaa5dda8b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in the customer. x-schemaName: StoreUpdateCustomer properties: company_name: diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml index 0338cc6658..22025cb22d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's shipping address. +description: The details to update in the address. x-schemaName: UpdateAddress required: - id @@ -7,51 +7,52 @@ properties: id: type: string title: id - description: The shipping address's ID. + description: The ID of an existing address to update. customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer that this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: usd province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. + description: The address's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml index 0b29d94268..32376f2c2f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/UpdateCartData.yaml @@ -1,36 +1,41 @@ type: object -description: SUMMARY +description: The details to update in a cart. x-schemaName: UpdateCartData properties: region_id: type: string title: region_id - description: The cart's region id. + description: >- + The ID of the associated region. This can affect the prices and currency + code of the cart. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The ID of the customer that the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: >- + The ID of the associated sales channel. Only products available in this + channel can be added to the cart. email: type: string title: email - description: The cart's email. + description: The email of the customer that the cart belongs to. format: email currency_code: type: string title: currency_code description: The cart's currency code. + example: usd shipping_address_id: type: string title: shipping_address_id - description: The cart's shipping address id. + description: The ID of the cart's shipping address. billing_address_id: type: string title: billing_address_id - description: The cart's billing address id. + description: The ID of the cart's billing address. billing_address: oneOf: - $ref: ./CreateAddress.yaml @@ -41,4 +46,4 @@ properties: - $ref: ./UpdateAddress.yaml metadata: type: object - description: The cart's metadata. + description: The cart's metadata, ca hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml b/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml index 2d20174121..2f04930503 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/WorkflowExecutionContext.yaml @@ -8,6 +8,30 @@ properties: data: type: object description: The context's data. + properties: + invoke: + type: object + description: The step's invokation details. + required: + - output + additionalProperties: + type: object + properties: + output: + type: object + description: The invokation's details. + required: + - output + - compensateInput + properties: + output: + description: the step's output + compensateInput: + description: the compensation function's input. + payload: + description: the payload of the transaction. + required: + - invoke compensate: type: object description: The context's compensate. @@ -16,4 +40,20 @@ properties: description: The context's errors. items: type: object - description: The error's errors. + description: The error's details. + properties: + error: + type: object + description: The error's details. + action: + type: string + title: action + description: The error's action. + handlerType: + type: string + title: handlerType + description: The error's handler type. + required: + - error + - action + - handlerType diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index 765940c100..9370cd2733 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -494,6 +494,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -502,6 +504,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -510,6 +514,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -518,6 +524,8 @@ 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 `-`. + externalDocs: + url: '#pagination' - name: q in: query description: A search term to search the API keys' searchable properties. @@ -1659,6 +1667,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -1718,6 +1728,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -1791,7 +1803,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -1853,6 +1865,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -1920,6 +1934,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -1996,6 +2012,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -2004,6 +2022,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -2012,6 +2032,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -2102,6 +2124,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -2252,6 +2276,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -2311,6 +2337,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -2445,7 +2473,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -2507,6 +2535,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -2583,6 +2613,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -2591,6 +2623,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -2599,6 +2633,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -3423,6 +3459,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -3495,6 +3533,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -3606,6 +3646,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -3681,6 +3723,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -3756,6 +3800,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4047,6 +4093,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4167,6 +4215,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4243,6 +4293,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4318,6 +4370,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4379,6 +4433,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4459,6 +4515,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4534,6 +4592,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4594,6 +4654,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -4625,10 +4687,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} x-workflow: confirmClaimRequestWorkflow delete: operationId: DeleteClaimsIdRequest @@ -4697,6 +4755,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -4705,6 +4765,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -4713,6 +4775,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -5537,6 +5601,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -5608,6 +5674,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -5667,6 +5735,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -5782,6 +5852,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -5858,6 +5930,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -5866,6 +5940,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -5874,6 +5950,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -5984,6 +6062,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -6038,6 +6118,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6046,6 +6128,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -6054,6 +6138,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -6860,7 +6946,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of customer groups. required: - limit - offset @@ -6869,23 +6955,23 @@ paths: limit: type: number title: limit - description: The customer group's limit. + description: The maximum number of items retrieved. offset: type: number title: offset - description: The customer group's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer group's count. + description: The total number of items - type: object - description: SUMMARY + description: The paginated list of customer groups. required: - customer_groups properties: customer_groups: type: array - description: The customer group's customer groups. + description: The list of customer groups. items: $ref: '#/components/schemas/AdminCustomerGroup' '400': @@ -6922,6 +7008,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -6993,6 +7081,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -7052,6 +7142,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -7126,7 +7218,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -7187,6 +7279,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -7263,6 +7357,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -7271,6 +7367,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -7279,6 +7377,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -10650,6 +10750,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -10766,6 +10868,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -10825,6 +10929,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -10943,7 +11049,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -10973,7 +11079,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - x-workflow: deleteCustomersWorkflow + x-workflow: removeCustomerAccountWorkflow /admin/customers/{id}/addresses: get: operationId: GetCustomersIdAddresses @@ -11003,6 +11109,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -11011,6 +11119,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -11019,6 +11129,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -11214,6 +11326,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -11379,6 +11493,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -11445,6 +11561,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -11609,6 +11727,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -11627,7 +11747,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -11646,11 +11766,11 @@ paths: title: deleted description: Whether the Customer was deleted. - type: object - description: SUMMARY + description: The deletion's details. properties: parent: $ref: '#/components/schemas/AdminCustomer' - description: SUMMARY + description: The deletion's details. '400': $ref: '#/components/responses/400_error' '401': @@ -11687,6 +11807,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -11695,6 +11817,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -11703,6 +11827,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -13131,7 +13257,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of draft orders. required: - limit - offset @@ -13140,17 +13266,17 @@ paths: limit: type: number title: limit - description: The draft order's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The draft order's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The draft order's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of draft orders. required: - draft_orders properties: @@ -13190,6 +13316,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -13598,6 +13726,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -13606,6 +13736,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -13614,6 +13746,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -14405,7 +14539,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of exchanges. required: - limit - offset @@ -14414,22 +14548,25 @@ paths: limit: type: number title: limit - description: The exchange's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The exchange's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The exchange's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of exchanges. required: - exchanges properties: exchanges: - $ref: '#/components/schemas/AdminExchange' + type: array + description: The exchange's exchanges. + items: + $ref: '#/components/schemas/AdminExchange' '400': $ref: '#/components/responses/400_error' '401': @@ -14464,6 +14601,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -14535,6 +14674,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -14749,22 +14890,6 @@ paths: 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. security: - api_token: [] - cookie_auth: [] @@ -14889,6 +15014,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15007,6 +15134,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15083,6 +15212,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15158,6 +15289,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15218,6 +15351,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15298,6 +15433,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15373,6 +15510,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15432,6 +15571,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15464,10 +15605,6 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmExchangeRequestWorkflow - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteExchangesIdRequest summary: Cancel Exchange Request @@ -15535,6 +15672,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -15543,6 +15682,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -15551,6 +15692,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -15709,6 +15852,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15904,6 +16049,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -15970,6 +16117,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -16215,6 +16364,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -16328,6 +16479,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -16390,6 +16543,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -16460,6 +16615,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -16468,6 +16625,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -16476,6 +16635,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -16839,7 +17000,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of inventory items. required: - limit - offset @@ -16848,17 +17009,17 @@ paths: limit: type: number title: limit - description: The inventory item's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The inventory item's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The inventory item's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of inventory items. required: - inventory_items properties: @@ -16901,6 +17062,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -16983,6 +17146,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -17042,6 +17207,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -17183,7 +17350,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -17244,6 +17411,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -17252,6 +17421,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -17260,6 +17431,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -17320,7 +17493,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of inventory levels. required: - limit - offset @@ -17329,17 +17502,17 @@ paths: limit: type: number title: limit - description: The inventory item's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The inventory item's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The inventory item's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of inventory levels. required: - inventory_levels properties: @@ -17389,6 +17562,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -17585,6 +17760,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -17670,6 +17847,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -17688,7 +17867,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -17707,11 +17886,11 @@ paths: title: deleted description: Whether the Inventory Item was deleted. - type: object - description: SUMMARY + description: The deletion's details. properties: parent: $ref: '#/components/schemas/AdminInventoryItem' - description: SUMMARY + description: The deletion's details. '400': $ref: '#/components/responses/400_error' '401': @@ -17748,6 +17927,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -17756,6 +17937,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -17764,6 +17947,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -18261,6 +18446,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -18415,6 +18602,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -18465,7 +18654,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -18526,6 +18715,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -18551,10 +18742,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} x-workflow: refreshInviteTokensWorkflow /admin/notifications: get: @@ -18579,6 +18766,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -18587,6 +18776,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -18595,6 +18786,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -18719,6 +18912,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -18830,7 +19025,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -19370,6 +19565,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -19378,6 +19575,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -19386,6 +19585,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -20064,6 +20265,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20124,6 +20327,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20155,10 +20360,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} /admin/orders/{id}/archive: post: operationId: PostOrdersIdArchive @@ -20188,15 +20389,12 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/AdminArchiveOrder' x-codeSamples: - lang: Shell label: cURL @@ -20266,6 +20464,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20297,10 +20497,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} x-workflow: cancelOrderWorkflow /admin/orders/{id}/changes: get: @@ -20401,6 +20597,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20477,6 +20675,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20603,6 +20803,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20654,6 +20856,77 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: cancelOrderFulfillmentWorkflow + /admin/orders/{id}/fulfillments/{fulfillment_id}/mark-as-delivered: + post: + operationId: PostOrdersIdFulfillmentsFulfillment_idMarkAsDelivered + summary: Mark a Fulfillment as Delivered. + x-sidebar-summary: Mark Delivered + description: Mark an order's fulfillment as delivered. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: fulfillment_id + in: path + description: The fulfillment'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. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/orders/{id}/fulfillments/{fulfillment_id}/mark-as-delivered' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminOrderResponse' + '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: markOrderFulfillmentAsDeliveredWorkflow /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: post: operationId: PostOrdersIdFulfillmentsFulfillment_idShipments @@ -20690,6 +20963,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20865,6 +21140,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -20994,6 +21271,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -21066,6 +21345,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -21074,6 +21355,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -21082,6 +21365,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -21584,6 +21869,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -21592,6 +21879,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -21600,6 +21889,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -21737,6 +22028,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -21797,6 +22090,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -21869,6 +22164,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -21943,6 +22240,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -21951,6 +22250,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -21959,6 +22260,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -22324,6 +22627,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -22397,6 +22702,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -22456,6 +22763,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -22576,8 +22885,8 @@ paths: description: A price's details. required: - currency_code - - amount - variant_id + - amount properties: currency_code: type: string @@ -22707,6 +23016,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -22767,6 +23078,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -22775,6 +23088,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -22783,6 +23098,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -22914,6 +23231,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -22980,6 +23299,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -23039,6 +23360,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -23143,6 +23466,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -23151,6 +23476,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -23159,6 +23486,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -23705,6 +24034,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -23777,6 +24108,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: include_ancestors_tree in: query description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. @@ -23852,6 +24185,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -24001,6 +24336,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -24077,6 +24414,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -24085,6 +24424,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -24093,6 +24434,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -24565,6 +24908,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -24636,6 +24981,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -24695,6 +25042,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -24812,6 +25161,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -24820,6 +25171,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -24828,6 +25181,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -25300,6 +25655,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -25308,7 +25665,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/AdminCreateProduct' + $ref: '#/components/schemas/AdminCreateProductType' x-codeSamples: - lang: Shell label: cURL @@ -25371,6 +25728,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -25430,6 +25789,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -25547,6 +25908,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -25555,6 +25918,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -25563,6 +25928,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -26006,7 +26373,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of product variants. required: - limit - offset @@ -26015,17 +26382,17 @@ paths: limit: type: number title: limit - description: The product variant's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product variant's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product variant's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of product variants. required: - variants properties: @@ -26069,6 +26436,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -26085,6 +26454,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -26629,6 +27000,411 @@ paths: type: string title: collection_id description: A product collection's ID. + - name: variants + in: query + description: Filter the retrieved products' variants. + required: false + schema: + type: object + description: Filter the retrieved products' variants. + x-schemaName: AdminProductVariantParams + properties: + q: + type: string + title: q + description: Search term to apply on the variant's searchable properties. + id: + oneOf: + - type: string + title: id + description: Filter by a variant's ID. + - type: array + description: Filter by variant IDs. + items: + type: string + title: id + description: A variant's ID. + manage_inventory: + type: boolean + title: manage_inventory + description: Filter by whether the Medusa application manages the variant's inventory. + allow_backorder: + type: boolean + title: allow_backorder + description: Filter by whether the variant can be ordered even if it's out of stock. + created_at: + type: object + description: Filter by the variant's creation date. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by an exact match. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + updated_at: + type: object + description: The variant's updated at. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by an exact match. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + deleted_at: + type: object + description: The variant's deleted at. + properties: + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by an exact match. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + - type: object + description: Filter by values not matching the conditions in this parameter. + - type: array + description: Filter by values not matching the conditions in this parameter. + items: + type: string + title: $not + description: Filter by values not matching the conditions in this parameter. + $gt: + type: string + title: $gt + description: Filter by values greater than this parameter. Useful for numbers and dates only. + $gte: + type: string + title: $gte + description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: Filter by values less than this parameter. Useful for numbers and dates only. + $lte: + type: string + title: $lte + description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: Apply a case-insensitive `like` filter. Useful for strings only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: Filter arrays that have overlapping values with this parameter. + items: + type: string + title: $overlap + description: Filter arrays that have overlapping values with this parameter. + $contains: + type: array + description: Filter arrays that contain some of the values of this parameter. + items: + type: string + title: $contains + description: Filter arrays that contain some of the values of this parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: Filter by whether a value for this parameter exists (not `null`). + limit: + type: number + title: limit + description: Limit the number of items returned in the list. + offset: + type: number + title: offset + description: The number of items to skip when retrieving a list. + order: + 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 `-`. + fields: + 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. + $and: + type: array + description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -26711,6 +27487,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -26783,6 +27561,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -26847,6 +27627,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -26990,6 +27772,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -27049,6 +27833,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -27168,6 +27954,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -27176,6 +27964,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -27184,6 +27974,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -27337,6 +28129,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -27425,6 +28219,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -27491,6 +28287,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -27574,6 +28372,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -27636,6 +28436,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -27644,6 +28446,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -27652,6 +28456,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -28164,6 +28970,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28244,6 +29052,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28313,9 +29123,9 @@ paths: type: object description: The associations to create between a product variant and an inventory item. required: - - required_quantity - - inventory_item_id - variant_id + - inventory_item_id + - required_quantity properties: required_quantity: type: number @@ -28336,9 +29146,9 @@ paths: type: object description: Update a product variant's association with an inventory item. required: - - required_quantity - - inventory_item_id - variant_id + - inventory_item_id + - required_quantity properties: required_quantity: type: number @@ -28359,8 +29169,8 @@ paths: type: object description: Delete a product variant's association with an inventory item. required: - - inventory_item_id - variant_id + - inventory_item_id properties: inventory_item_id: type: string @@ -28434,6 +29244,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28500,6 +29312,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28580,6 +29394,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28648,6 +29464,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28732,6 +29550,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28814,6 +29634,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -28869,6 +29691,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -28877,6 +29701,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -28885,6 +29711,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -29405,6 +30233,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -29747,13 +30577,15 @@ paths: get: operationId: GetPromotionsRuleAttributeOptionsRule_type summary: List Rule Attribute Options of a Rule Type - x-sidebar-summary: List Rule Attribute Options + x-sidebar-summary: List Potential Rule Attributes description: | - Retrieve a list of attributes for the promotion and application method types specified in the query parameters. + Retrieve a list of potential rule attributes for the promotion and application method types specified in the query parameters. Only the attributes of the rule type specified in the path parameter are retrieved: - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. - - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. + - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. + + - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. x-authenticated: true parameters: - name: rule_type @@ -29862,6 +30694,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -29870,6 +30704,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -29969,6 +30805,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -30028,6 +30866,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -30190,7 +31030,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -30252,6 +31092,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -30267,93 +31109,12 @@ paths: type: array description: The buy rules to create. items: - type: object - description: A buy rule's details. - required: - - operator - - attribute - - values - properties: - operator: - type: string - description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: '#/components/schemas/AdminCreatePromotionRule' update: type: array description: The buy rules to update. items: - type: object - description: The properties to update in a buy rule. - required: - - id - - values - properties: - id: - type: string - title: id - description: The buy rule's ID. - operator: - type: string - description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: '#/components/schemas/AdminUpdatePromotionRule' delete: type: array description: The buy rules to delete. @@ -30459,6 +31220,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -30474,93 +31237,12 @@ paths: type: array description: The rules to create. items: - type: object - description: A rule's details. - required: - - operator - - attribute - - values - properties: - operator: - type: string - description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: '#/components/schemas/AdminCreatePromotionRule' update: type: array description: The rules to update. items: - type: object - description: The properties to update in a rule. - required: - - id - - values - properties: - id: - type: string - title: id - description: The rule's ID. - operator: - type: string - description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: '#/components/schemas/AdminUpdatePromotionRule' delete: type: array description: The rules to delete. @@ -30666,6 +31348,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -30681,93 +31365,12 @@ paths: type: array description: The target rules to create. items: - type: object - description: A target rule's details. - required: - - operator - - attribute - - values - properties: - operator: - type: string - description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: '#/components/schemas/AdminCreatePromotionRule' update: type: array description: The target rules to update. items: - type: object - description: The properties to update in a target rule. - required: - - id - - values - properties: - id: - type: string - title: id - description: The target rule's ID. - operator: - type: string - description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: '#/components/schemas/AdminUpdatePromotionRule' delete: type: array description: The target rules to delete. @@ -30887,6 +31490,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -30950,6 +31555,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -30958,6 +31565,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -30966,6 +31575,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -31036,7 +31647,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of refund reasons. required: - limit - offset @@ -31045,17 +31656,17 @@ paths: limit: type: number title: limit - description: The refund reason's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The refund reason's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The refund reason's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of refund reasons. required: - refund_reasons properties: @@ -31098,6 +31709,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -31169,6 +31782,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -31228,6 +31843,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -31310,7 +31927,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -31365,6 +31982,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -31373,6 +31992,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -31381,6 +32002,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -31896,6 +32519,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -31968,6 +32593,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -32027,6 +32654,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -32134,7 +32763,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -32189,6 +32818,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -32197,6 +32828,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -32205,6 +32838,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -32724,9 +33359,9 @@ paths: properties: reservations: type: array - description: The list of reservations`. + description: The list of reservations. items: - $ref: '#/components/schemas/ReservationResponse' + $ref: '#/components/schemas/AdminReservation' '400': $ref: '#/components/responses/400_error' '401': @@ -32761,6 +33396,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -32836,6 +33473,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -32895,6 +33534,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -32985,7 +33626,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -33040,6 +33681,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -33048,6 +33691,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -33056,6 +33701,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -33572,6 +34219,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -33580,7 +34229,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/CreateOrderReturnReason' + $ref: '#/components/schemas/AdminCreateReturnReason' x-codeSamples: - lang: Shell label: cURL @@ -33643,6 +34292,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -33702,6 +34353,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -33710,7 +34363,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UpdateOrderReturnReason' + $ref: '#/components/schemas/AdminUpdateReturnReason' x-codeSamples: - lang: Shell label: cURL @@ -33806,6 +34459,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -33814,6 +34469,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -33822,6 +34479,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -34430,7 +35089,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of returns. required: - limit - offset @@ -34439,17 +35098,17 @@ paths: limit: type: number title: limit - description: The return's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The return's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The return's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of returns. required: - returns properties: @@ -34492,6 +35151,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -34576,6 +35237,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -34635,6 +35298,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -34756,6 +35421,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -34832,6 +35499,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -34907,6 +35576,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -34968,6 +35639,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35049,7 +35722,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -35111,6 +35784,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35187,6 +35862,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35262,6 +35939,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35324,6 +36003,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35391,6 +36072,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35459,7 +36142,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -35521,6 +36204,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35597,6 +36282,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35672,6 +36359,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35734,6 +36423,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35814,6 +36505,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35889,6 +36582,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -35944,6 +36639,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -35952,6 +36649,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -35960,6 +36659,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -36505,6 +37206,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -36577,6 +37280,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -36636,6 +37341,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -36752,6 +37459,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -36828,6 +37537,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -36836,6 +37547,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -36844,6 +37557,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -37399,6 +38114,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -37407,7 +38124,7 @@ paths: content: application/json: schema: - type: object + $ref: '#/components/schemas/AdminCreateShippingOption' x-codeSamples: - lang: Shell label: cURL @@ -37451,6 +38168,70 @@ paths: $ref: '#/components/responses/500_error' x-workflow: createShippingOptionsWorkflow /admin/shipping-options/{id}: + get: + operationId: GetShippingOptionsId + summary: Get a Shipping Option + description: Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option'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. + externalDocs: + url: '#select-fields-and-relations' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/shipping-options/{id}' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminShippingOptionResponse' + '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: PostShippingOptionsId summary: Update a Shipping Option @@ -37479,6 +38260,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -37518,9 +38301,9 @@ paths: type: object description: The shipping option's type. required: - - label - - description - code + - description + - label properties: label: type: string @@ -37755,6 +38538,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -37770,89 +38555,12 @@ paths: type: array description: The shipping option rules to create. items: - type: object - description: A shipping option's details. - required: - - operator - - attribute - - value - properties: - operator: - type: string - description: The operator used to check whether a rule applies. - enum: - - in - - eq - - ne - - gt - - gte - - lt - - lte - - nin - attribute: - type: string - title: attribute - description: The name of a property or table that the rule applies to. - example: customer_group - value: - oneOf: - - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 - - type: array - description: Values of the attribute that enable this rule. - items: - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 + $ref: '#/components/schemas/AdminCreateShippingOptionRule' update: type: array description: The shipping option rules to update. items: - type: object - description: The properties to update in the shipping option rule. - required: - - id - - operator - - attribute - - value - properties: - id: - type: string - title: id - description: The rule's ID. - operator: - type: string - description: The operator used to check whether a rule applies. - enum: - - in - - eq - - ne - - gt - - gte - - lt - - lte - - nin - attribute: - type: string - title: attribute - description: The name of a property or table that the rule applies to. - example: customer_group - value: - oneOf: - - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 - - type: array - description: Values of the attribute that enable this rule. - items: - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 + $ref: '#/components/schemas/AdminUpdateShippingOptionRule' delete: type: array description: The shipping option rules to delete. @@ -37951,6 +38659,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -37959,6 +38669,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -37967,6 +38679,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -38470,6 +39184,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -38542,6 +39258,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -38601,6 +39319,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -38722,6 +39442,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -38730,6 +39452,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -38738,6 +39462,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -39238,6 +39964,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39310,6 +40038,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39369,6 +40099,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39485,6 +40217,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39568,6 +40302,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39579,8 +40315,8 @@ paths: type: object description: The fulfillment set to create. required: - - name - type + - name properties: name: type: string @@ -39653,6 +40389,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39729,6 +40467,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -39737,6 +40477,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -39745,6 +40487,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -39867,6 +40611,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39926,6 +40672,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -39994,6 +40742,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40002,6 +40752,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -40010,6 +40762,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -40583,6 +41337,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -40655,6 +41411,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -40714,6 +41472,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -40829,6 +41589,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -40907,6 +41669,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -40927,7 +41691,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -40946,11 +41710,11 @@ paths: title: deleted description: Whether the Tax Rate was deleted. - type: object - description: SUMMARY + description: The deletion's details. properties: parent: $ref: '#/components/schemas/AdminTaxRate' - description: SUMMARY + description: The deletion's details. '400': $ref: '#/components/responses/400_error' '401': @@ -40987,6 +41751,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40995,6 +41761,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -41003,6 +41771,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -42029,6 +42799,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -42102,6 +42874,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -42193,17 +42967,17 @@ paths: schema: oneOf: - type: object - description: The files to upload. + description: The files to upload required: - files properties: files: type: array - description: The files to upload. + description: The upload's files. items: oneOf: - type: object - description: A file's details. + description: The file's files. required: - name - content @@ -42215,9 +42989,22 @@ paths: content: type: string title: content - description: The file's base64 content. - - $ref: '#/components/schemas/File' - - $ref: '#/components/schemas/FileList' + description: The file's content. + - type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: files + - type: array + description: list of files to upload. + items: + type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: FileList description: The files to upload. x-codeSamples: - lang: Shell @@ -42276,6 +43063,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -42338,7 +43127,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -42393,6 +43182,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -42401,6 +43192,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -42409,6 +43202,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -42869,6 +43664,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -42923,6 +43720,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -42976,6 +43775,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -43051,7 +43852,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - x-workflow: deleteUsersWorkflow + x-workflow: removeUserAccountWorkflow /admin/workflows-executions: get: operationId: GetWorkflowsExecutions @@ -43075,6 +43876,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -43083,6 +43886,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -43091,6 +43896,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -43216,6 +44023,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -43294,6 +44103,8 @@ paths: required: - workflowId - transactionId + - hasFinished + - hasFailed properties: workflowId: type: string @@ -43303,6 +44114,18 @@ paths: type: string description: The ID of the workflow exection's transaction. Use this later to track the workflow execution's progress or succeed / fail its steps. title: transactionId + parentStepIdempotencyKey: + type: string + title: parentStepIdempotencyKey + description: The idempotency key of the workflow execution. + hasFinished: + type: boolean + title: hasFinished + description: Whether the workflow execution has finished. + hasFailed: + type: boolean + title: hasFailed + description: Whether the workflow execution has failed. '400': $ref: '#/components/responses/400_error' '401': @@ -43528,6 +44351,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -43675,7 +44500,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - success properties: @@ -43768,12 +44593,9 @@ paths: "email": "admin@medusa-test.com", "password": "supersecret" }' - - lang: Shell + - lang: Bash label: Google Provider source: curl -X POST '{backend_url}/auth/user/google' - - lang: Shell - label: GitHub Provider - source: curl -X POST '{backend_url}/auth/user/github' tags: - Auth responses: @@ -43823,7 +44645,7 @@ paths: - lang: Shell label: Google Provider source: curl -X POST '{backend_url}/auth/user/google/callback?code=123' - - lang: Shell + - lang: Bash label: GitHub Provider source: curl -X POST '{backend_url}/auth/user/github/callback?code=123' tags: @@ -43975,17 +44797,69 @@ components: properties: api_key: $ref: '#/components/schemas/AdminApiKey' - AdminArchiveOrder: + AdminApplicationMethod: type: object - description: SUMMARY - x-schemaName: AdminArchiveOrder + description: The application method's details. + x-schemaName: AdminApplicationMethod required: - - order_id + - id properties: - order_id: + promotion: + $ref: '#/components/schemas/AdminPromotion' + target_rules: + type: array + description: The application method's target rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' + id: type: string - title: order_id - description: The order's order id. + title: id + description: The application method's ID. + type: + type: string + description: The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage. + enum: + - fixed + - percentage + target_type: + type: string + description: Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order. + enum: + - items + - shipping_methods + - order + allocation: + type: string + description: How is the promotion amount discounted. `each` means the discounted amount is applied on each applicable item; `across` means the discounted amount is split accross the applicable items. + enum: + - each + - across + value: + type: number + title: value + description: The amount to be discounted. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + example: usd + max_quantity: + type: number + title: max_quantity + description: The max quantity allowed in the cart for the associated promotion to be applied. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`. AdminBatchProductRequest: type: object description: The products to create, update, or delete. @@ -44206,44 +45080,18 @@ components: description: The claim's details. x-schemaName: AdminClaim required: - - order_id - - claim_items - - additional_items - - currency_code + - order + - return - id - - region_id - - customer_id - - sales_channel_id - - email - - shipping_methods - - payment_status - - fulfillment_status - - summary - - metadata + - type + - order_id + - display_id + - order_version - 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 + - canceled_at + - additional_items + - claim_items properties: id: type: string @@ -44264,7 +45112,7 @@ components: items: $ref: '#/components/schemas/BaseClaimItem' return: - $ref: '#/components/schemas/Return' + $ref: '#/components/schemas/AdminReturn' return_id: type: string title: return_id @@ -44277,76 +45125,15 @@ components: type: number title: refund_amount description: The amount to be refunded. - currency_code: - type: string - title: currency_code - description: The claim's currency code. - region_id: - type: string - title: region_id - description: The ID of the region associated with the claim. - customer_id: - type: string - title: customer_id - description: The ID of the customer associated with the claim's order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the claim's order is created in. - email: - type: string - title: email - description: The email associated with the claim's order. - format: email display_id: type: number 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 - description: The claim's payment status. - 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 - description: The claim's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered + $ref: '#/components/schemas/AdminOrderShippingMethod' transactions: type: array description: The claim's transactions. @@ -44355,8 +45142,6 @@ components: description: Learn more about transactions of orders and associated models. items: $ref: '#/components/schemas/BaseOrderTransaction' - summary: - $ref: '#/components/schemas/BaseOrderSummary' metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -44370,94 +45155,32 @@ components: format: date-time title: updated_at description: The claim's update date. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the associated order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the associated order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The tax total of the original items in the associated order. - item_total: - type: number - title: item_total - description: The total of the claim's items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the claim's items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the claim's items. - original_total: - type: number - title: original_total - description: The associated order's original total. - original_subtotal: - type: number - title: original_subtotal - description: The associated order's original subtotal. - original_tax_total: - type: number - title: original_tax_total - description: The associated order's original tax total. - total: - type: number - title: total - description: The associated order'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 associated order's original shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The associated order's original shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The associated order's original shipping tax total. + order: + $ref: '#/components/schemas/AdminOrder' + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order_version: + type: string + title: order_version + description: The version of the order when the claim is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. AdminClaimDeleteResponse: type: object description: The details of the deleted claim. @@ -44528,7 +45251,7 @@ components: - claim properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimRequestResponse: @@ -44543,7 +45266,7 @@ components: return: $ref: '#/components/schemas/AdminReturn' order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimResponse: @@ -44564,7 +45287,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminCollection: @@ -44691,68 +45414,6 @@ components: enum: - publishable - secret - AdminCreateApplicationMethod: - type: object - description: The application method's details. - x-schemaName: AdminCreateApplicationMethod - required: - - value - - type - - target_type - properties: - description: - type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: The discounted amount applied by the associated promotion based on the `type`. - currency_code: - type: string - title: currency_code - description: The application method's currency code. - max_quantity: - type: number - title: max_quantity - description: The max quantity allowed in the cart for the associated promotion to be applied. - type: - type: string - description: The type of the application method indicating how the associated promotion is applied. - enum: - - fixed - - percentage - target_type: - type: string - description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order. - enum: - - items - - shipping_methods - - order - allocation: - type: string - description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart. - enum: - - each - - across - target_rules: - type: array - description: The application method's target rules. - items: - $ref: '#/components/schemas/AdminCreatePromotionRule' - buy_rules: - type: array - description: The application method's buy rules. - items: - $ref: '#/components/schemas/AdminCreatePromotionRule' - apply_to_quantity: - type: number - title: apply_to_quantity - description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. AdminCreateCollection: type: object description: the product collection's details. @@ -44790,15 +45451,14 @@ components: description: The filfillment's details. x-schemaName: AdminCreateFulfillment required: + - data + - order_id + - metadata + - items - location_id - provider_id - delivery_address - - items - labels - - order - - order_id - - data - - metadata properties: location_id: type: string @@ -44863,8 +45523,8 @@ components: description: An item to fulfill. required: - title - - sku - quantity + - sku - barcode properties: title: @@ -45062,8 +45722,8 @@ components: description: A price's details. required: - currency_code - - amount - variant_id + - amount properties: currency_code: type: string @@ -45328,6 +45988,20 @@ components: metadata: type: object description: The product tag's metadata, used to store custom key-value pairs. + AdminCreateProductType: + type: object + description: The details of the product type to create. + x-schemaName: AdminCreateProductType + required: + - value + properties: + metadata: + type: object + description: The product's metadata, used to store custom key-value pairs. + value: + type: string + title: value + description: The product type's value. AdminCreateProductVariant: type: object description: The product variant's details. @@ -45413,6 +46087,26 @@ components: description: The variant's options, where the key is an option's name, and the value is the option's value. example: Color: Black + inventory_items: + type: array + description: The variant's inventory items to create. + items: + $ref: '#/components/schemas/AdminCreateProductVariantInventoryKit' + AdminCreateProductVariantInventoryKit: + type: object + description: The details of a variant's inventory item. + x-schemaName: AdminCreateProductVariantInventoryKit + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory item's ID. + required_quantity: + type: number + title: required_quantity + description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. AdminCreateProductVariantPrice: type: object description: The details of a variant's price. @@ -45442,6 +46136,13 @@ components: description: The price's rules. example: region_id: reg_123 + properties: + region_id: + type: string + title: region_id + description: The ID of a region. + required: + - region_id AdminCreatePromotionRule: type: object description: The promotion rule's details. @@ -45455,13 +46156,13 @@ components: type: string description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: + - gte + - lte - gt - lt - eq - ne - in - - lte - - gte description: type: string title: description @@ -45470,7 +46171,7 @@ components: type: string title: attribute description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: item.product.id + example: items.product.id values: oneOf: - type: string @@ -45575,6 +46276,33 @@ components: metadata: type: object description: The reservation's metadata, used to store custom key-value pairs. + AdminCreateReturnReason: + type: object + description: The details of the return reason to create. + x-schemaName: AdminCreateReturnReason + required: + - value + - label + properties: + 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. + parent_return_reason_id: + type: string + title: parent_return_reason_id + description: The ID of the parent return reason. + metadata: + type: object + description: The return reason's metadata, can hold custom key-value pairs. AdminCreateSalesChannel: type: object description: The sales channel's details. @@ -45632,85 +46360,22 @@ components: description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - name - - service_zone_id - - shipping_profile_id - - price_type - - provider_id - - type - - prices + - label + - description + - code properties: - name: + label: type: string - title: name - description: The shipping option's name. - service_zone_id: + title: label + description: The type's label. + description: type: string - title: service_zone_id - description: The ID of the service zone this shipping option belongs to. - shipping_profile_id: + title: description + description: The type's description. + code: type: string - title: shipping_profile_id - description: The ID of the shipping profile this shipping option belongs to. - data: - type: object - description: Any data necessary for fulfillment providers to handle shipping methods and fulfillments of this shipping option. - externalDocs: - url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property - description: Learn more about the data property. - price_type: - type: string - description: | - The shipping option price's type. If `flat`, it means the option has a fixed price set in the `prices` property. `calculated` means that the shipping option's price is calculated during checkout. - enum: - - flat - - calculated - provider_id: - type: string - title: provider_id - description: The ID of the fulfillment provider used to handle this shipping option and its associated methods and fulfillments. - type: - type: object - prices: - type: array - description: The shipping option's prices. If `price_type` is `calculated`, pass an empty array for this property. - items: - oneOf: - - type: object - description: The price for a currency code. - x-schemaName: AdminCreateShippingOptionPriceWithCurrency - required: - - currency_code - - amount - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - - type: object - description: The price in a region. - x-schemaName: AdminCreateShippingOptionPriceWithRegion - required: - - region_id - - amount - properties: - region_id: - type: string - title: region_id - description: The ID of the region this price is used in. - amount: - type: number - title: amount - description: The price's amount. - rules: - type: array - description: The shipping option's rules. - items: - $ref: '#/components/schemas/AdminCreateShippingOptionRule' + title: code + description: The type's code. AdminCreateShippingOptionRule: type: object description: The details of the shipping option rule. @@ -45796,6 +46461,7 @@ components: required: - name - tax_region_id + - code properties: name: type: string @@ -45875,6 +46541,7 @@ components: type: object description: The tax region's default tax rate. required: + - code - name properties: rate: @@ -45907,8 +46574,8 @@ components: description: The details of the variant-inventory item association. x-schemaName: AdminCreateVariantInventoryItem required: - - required_quantity - inventory_item_id + - required_quantity properties: required_quantity: type: number @@ -45966,7 +46633,6 @@ components: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at @@ -46055,6 +46721,7 @@ components: x-schemaName: AdminCustomer required: - has_account + - addresses - id - email - default_billing_address_id @@ -46062,7 +46729,6 @@ components: - company_name - first_name - last_name - - addresses properties: id: type: string @@ -46106,7 +46772,7 @@ components: type: array description: The customer's addresses. items: - $ref: '#/components/schemas/BaseCustomerAddress' + $ref: '#/components/schemas/AdminCustomerAddress' phone: type: string title: phone @@ -46245,9 +46911,9 @@ components: description: The customer group's details. x-schemaName: AdminCustomerGroup required: + - customers - id - name - - customers - metadata - created_at - updated_at @@ -46264,7 +46930,7 @@ components: type: array description: The customer group's customers. items: - $ref: '#/components/schemas/BaseCustomer' + type: object metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. @@ -46280,7 +46946,7 @@ components: description: The customer group's update date. AdminCustomerGroupResponse: type: object - description: SUMMARY + description: The customer group's details. x-schemaName: AdminCustomerGroupResponse required: - customer_group @@ -46843,7 +47509,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). AdminCustomerResponse: type: object - description: SUMMARY + description: The customer's details. x-schemaName: AdminCustomerResponse required: - customer @@ -46886,44 +47552,14 @@ components: 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 + - order_id - 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 + - canceled_at + - deleted_at + - additional_items + - return_items properties: order_id: type: string @@ -46948,88 +47584,24 @@ components: title: difference_due description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. return: - description: the return associated with the exchange. $ref: '#/components/schemas/AdminReturn' return_id: type: string title: return_id description: The ID of the associated exchange. - 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 ID of the associated order's region. - customer_id: - type: string - title: customer_id - description: The ID of the customer that placed the order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the associated order belongs to. - email: - type: string - title: email - description: The email used when placing the order. - format: email display_id: - type: number + type: string title: display_id description: The exchange's display ID. - shipping_address: - description: The shipping address to send new items to. - $ref: '#/components/schemas/BaseOrderAddress' - billing_address: - description: The customer's billing address. - $ref: '#/components/schemas/BaseOrderAddress' shipping_methods: type: array description: The shipping methods used to send the new (outbound) items. items: $ref: '#/components/schemas/BaseOrderShippingMethod' - payment_collections: - type: array - description: The exchange's payment collections. - items: - $ref: '#/components/schemas/BasePaymentCollection' - payment_status: - type: string - description: The exchange's payment status. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - fulfillments: - type: array - description: The exchange's fulfillments of new (outbound) items. - items: - $ref: '#/components/schemas/BaseOrderFulfillment' - fulfillment_status: - type: string - description: The exchange's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered transactions: type: array description: The exchange's transactions. @@ -47037,9 +47609,6 @@ components: url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions items: $ref: '#/components/schemas/BaseOrderTransaction' - summary: - description: The totals summary of the exchange. - $ref: '#/components/schemas/BaseOrderSummary' metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -47053,94 +47622,30 @@ components: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The total tax of the original items in the order. - item_total: - type: number - title: item_total - description: The total of the exchange's new items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the exchange's new items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the exchange's new items. - original_total: - type: number - title: original_total - description: The total of the order. - original_subtotal: - type: number - title: original_subtotal - description: The subtotal of the order. - original_tax_total: - type: number - title: original_tax_total - description: The tax total of the order. - total: - type: number - title: total - description: The total of the exchange. - subtotal: - type: number - title: subtotal - description: The subtotal of the exchange. - tax_total: - type: number - title: tax_total - description: The tax total of the exchange. - discount_total: - type: number - title: discount_total - description: The discount total of the exchange. - discount_tax_total: - type: number - title: discount_tax_total - description: The total taxes on discount of the exchange. - gift_card_total: - type: number - title: gift_card_total - description: The gift cards total of the exchange. - gift_card_tax_total: - type: number - title: gift_card_tax_total - description: The total taxes on the gift card of the exchange. - 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 order's shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The order's shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The order's shipping tax total. + order_version: + type: string + title: order_version + description: The version of the order once the exchange is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + order: + $ref: '#/components/schemas/AdminOrder' + allow_backorder: + type: boolean + title: allow_backorder + description: Whether variants that are out-of-stock can still be added as additional or outbound items. AdminExchangeDeleteResponse: type: object description: The details of deleting an exchange. @@ -47185,7 +47690,7 @@ components: - exchange properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeRequestResponse: @@ -47198,11 +47703,9 @@ components: - exchange properties: return: - description: The associated return's details. $ref: '#/components/schemas/AdminReturn' order_preview: - description: A preview of the order once the exchange is applied. - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeResponse: @@ -47223,7 +47726,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminExportProductResponse: @@ -47314,10 +47817,8 @@ components: title: shipping_option_id description: The ID of the shipping option this fulfillment is created for. provider: - description: The details of the fulfillment provider using to handle this fulfillment. $ref: '#/components/schemas/AdminFulfillmentProvider' delivery_address: - description: The address to deliver the item to. $ref: '#/components/schemas/AdminFulfillmentAddress' items: type: array @@ -47571,8 +48072,20 @@ components: description: The date the label was deleted. AdminFulfillmentProvider: type: object - description: The shipping option's provider. + description: The fulfillment provider's details. x-schemaName: AdminFulfillmentProvider + 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. AdminFulfillmentProviderListResponse: type: object description: The paginated list of fulfillment providers. @@ -47611,7 +48124,7 @@ components: $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object - description: The fulfillment set's parent. + description: The service zone's fulfillment set. x-schemaName: AdminFulfillmentSet required: - id @@ -47626,37 +48139,37 @@ components: id: type: string title: id - description: The parent's ID. + description: The fulfillment set's ID. name: type: string title: name - description: The parent's name. + description: The fulfillment set's name. type: type: string title: type - description: The parent's type. + description: The fulfillment set's type. location: $ref: '#/components/schemas/AdminStockLocation' service_zones: type: array - description: The parent's service zones. + description: The fulfillment set's service zones. items: $ref: '#/components/schemas/AdminServiceZone' created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The fulfillment set's created at. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The fulfillment set's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The fulfillment set's deleted at. AdminFulfillmentSetDeleteResponse: type: object description: The deletion details. @@ -47681,7 +48194,7 @@ components: description: Whether the fulfillment set was deleted. AdminFulfillmentSetResponse: type: object - description: SUMMARY + description: The fulfillment set's details. x-schemaName: AdminFulfillmentSetResponse required: - fulfillment_set @@ -47690,7 +48203,7 @@ components: $ref: '#/components/schemas/AdminFulfillmentSet' AdminGeoZone: type: object - description: The geo zone's details. + description: The geo zone's geo zones. x-schemaName: AdminGeoZone required: - id @@ -47734,17 +48247,17 @@ components: type: string format: date-time title: created_at - description: The date the geo zone was created. + description: The geo zone's created at. updated_at: type: string format: date-time title: updated_at - description: The date the geo zone was update. + description: The geo zone's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The date the geo zone was deleted. + description: The geo zone's deleted at. AdminImportProductRequest: type: object description: The import's details. @@ -47753,7 +48266,12 @@ components: - file properties: file: - $ref: '#/components/schemas/File' + type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: file AdminImportProductResponse: type: object description: The import process's details. @@ -47783,7 +48301,7 @@ components: description: The number of products that will be updated by this import. AdminInventoryItem: type: object - description: The inventory item's details. + description: The reservation's inventory item. x-schemaName: AdminInventoryItem required: - id @@ -47796,7 +48314,7 @@ components: sku: type: string title: sku - description: The inventory item's SKU. + description: The inventory item's sku. origin_country: type: string title: origin_country @@ -47804,15 +48322,15 @@ components: hs_code: type: string title: hs_code - description: The inventory item's HS code. + description: The inventory item's hs code. requires_shipping: type: boolean title: requires_shipping - description: Whether the inventory item requires shipping. + description: The inventory item's requires shipping. mid_code: type: string title: mid_code - description: The inventory item's MID code. + description: The inventory item's mid code. material: type: string title: material @@ -47844,13 +48362,13 @@ components: thumbnail: type: string title: thumbnail - description: The URL of the inventory item's thumbnail. + description: The inventory item's thumbnail. metadata: type: object - description: The inventory item's metadata, can hold custom key-value pairs. + description: The inventory item's metadata. location_levels: type: array - description: The inventory item's associated inventory levels. + description: The inventory item's location levels. items: $ref: '#/components/schemas/AdminInventoryLevel' AdminInventoryItemResponse: @@ -47864,7 +48382,7 @@ components: $ref: '#/components/schemas/AdminInventoryItem' AdminInventoryLevel: type: object - description: The inventory level's details. + description: The location level's location levels. x-schemaName: AdminInventoryLevel required: - id @@ -47874,62 +48392,59 @@ components: - inventory_item_id - location_id - stocked_quantity - - raw_stocked_quantity - reserved_quantity - - raw_reserved_quantity - incoming_quantity - - raw_incoming_quantity - metadata - available_quantity properties: id: type: string title: id - description: The inventory level's ID. + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. inventory_item_id: type: string title: inventory_item_id - description: The ID of the inventory item this level belongs to. + description: The location level's inventory item id. location_id: type: string title: location_id - description: The ID of the stock location this level belongs to. + description: The location level's location id. stocked_quantity: type: number title: stocked_quantity - description: The quantity of the associated inventory item stocked in the associated stock location. + description: The location level's stocked quantity. reserved_quantity: type: number title: reserved_quantity - description: The reserved quantity of the associated inventory item stocked in the associated stock location. + description: The location level's reserved quantity. incoming_quantity: type: number title: incoming_quantity - description: The incoming quantity of the associated inventory item stocked in the associated stock location. + description: The location level's incoming quantity. metadata: type: object - description: The location level's metadata, can hold custom key-value pairs. + description: The location level's metadata. inventory_item: type: object available_quantity: type: number title: available_quantity - description: The quantity available for order of the associated inventory item in the associated stock location. - created_at: - type: string - format: date-time - title: created_at - description: The date the inventory level was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the inventory level was updated. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The date the inventory level was deleted. + description: The location level's available quantity. AdminInvite: type: object description: The invite's details. @@ -48105,21 +48620,20 @@ components: x-schemaName: AdminOrder required: - payment_collections + - items + - shipping_methods + - currency_code - id + - created_at + - updated_at + - email - 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 @@ -48152,7 +48666,7 @@ components: type: array description: The order's fulfillments. items: - $ref: '#/components/schemas/BaseOrderFulfillment' + $ref: '#/components/schemas/AdminOrderFulfillment' sales_channel: $ref: '#/components/schemas/AdminSalesChannel' customer: @@ -48198,12 +48712,12 @@ components: type: array description: The order's items. items: - $ref: '#/components/schemas/BaseOrderLineItem' + $ref: '#/components/schemas/AdminOrderLineItem' shipping_methods: type: array description: The order's shipping methods. items: - $ref: '#/components/schemas/BaseOrderShippingMethod' + $ref: '#/components/schemas/AdminOrderShippingMethod' payment_status: type: string description: The order's payment status. @@ -48412,6 +48926,252 @@ components: format: date-time title: updated_at description: The date the address was updated. + AdminOrderChange: + type: object + description: The order change's details. + x-schemaName: AdminOrderChange + required: + - order + - claim + - return_order + - exchange + - actions + - status + - order_id + - metadata + - id + - created_at + - updated_at + - version + - canceled_at + - return_id + - exchange_id + - claim_id + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - declined_at + - canceled_by + properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. This will be the order's version when the change is applied. + change_type: + type: string + description: The order change's type. + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The ID of the order this change applies on. + return_id: + type: string + title: return_id + description: The ID of the associated return. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + return_order: + $ref: '#/components/schemas/AdminReturn' + exchange: + $ref: '#/components/schemas/AdminExchange' + claim: + $ref: '#/components/schemas/AdminClaim' + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/AdminOrderChangeAction' + status: + type: string + description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined + requested_by: + type: string + title: requested_by + description: The ID of the user that requested the change. + requested_at: + type: string + title: requested_at + description: The date the order change was requested. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The ID of the user that confirmed the order change. + confirmed_at: + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time + declined_by: + type: string + title: declined_by + description: The ID of the user that declined the order change. + declined_reason: + type: string + title: declined_reason + description: The reason the order change was declined. + metadata: + type: object + description: The order change's metadata, can hold custom key-value pairs. + declined_at: + type: string + title: declined_at + description: The date the order change was declined. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The ID of the user that canceled the order change. + canceled_at: + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The date the order change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change was updated. + AdminOrderChangeAction: + type: object + description: The order change action's details. + x-schemaName: AdminOrderChangeAction + required: + - order_change + - order + - order_id + - internal_note + - id + - created_at + - updated_at + - return_id + - exchange_id + - claim_id + - order_change_id + - reference + - reference_id + - action + - details + properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. AdminOrderChangesResponse: type: object description: The details of an order's changes. @@ -48423,7 +49183,7 @@ components: type: array description: An order's changes. items: - $ref: '#/components/schemas/BaseOrderChange' + $ref: '#/components/schemas/AdminOrderChange' AdminOrderEditPreviewResponse: type: object description: The preview of an order edit. @@ -48432,7 +49192,7 @@ components: - order_preview properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' AdminOrderEditResponse: type: object description: An order edit's details. @@ -48441,7 +49201,298 @@ components: - order_change properties: order_change: - $ref: '#/components/schemas/OrderChange' + $ref: '#/components/schemas/AdminOrderChange' + AdminOrderFulfillment: + type: object + description: The fulfillment's details. + x-schemaName: AdminOrderFulfillment + required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - requires_shipping + - 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 ID of the location the items are fulfilled from. + packed_at: + type: string + title: packed_at + description: The date the items were packed. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The date the items were shipped. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The date the items were delivered. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The date the items were canceled. + format: date-time + data: + type: object + description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider used to handle the fulfillment. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + metadata: + type: object + description: The fulfillment's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the fulfillment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the fulfillment was updated. + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the fulfillment requires shipping. + AdminOrderLineItem: + type: object + description: The item's details. + x-schemaName: AdminOrderLineItem + required: + - title + - metadata + - id + - subtitle + - thumbnail + - created_at + - updated_at + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - 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 + - 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 URL of the item's thumbnail. + variant: + $ref: '#/components/schemas/AdminProductVariant' + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: '#/components/schemas/AdminProduct' + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the collection the item's product belongs to. + 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 values of the item variant's options. + example: + Color: Blue + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + 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: + type: object + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item, excluding promotions. + item_total: + type: number + title: item_total + description: The total taxes of the item, including promotions. + item_subtotal: + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of the item, including promotions. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the item including promotions. + discount_total: + type: number + title: discount_total + description: The total discount amount of the item. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total refundable amount of the item's total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total refundable amount of the item's total for a single quantity. AdminOrderPreview: type: object description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. @@ -48450,19 +49501,18 @@ components: - return_requested_total - order_change - currency_code - - version - id + - created_at + - updated_at + - email + - 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 @@ -48491,7 +49541,7 @@ components: title: return_requested_total description: The total of the requested return. order_change: - $ref: '#/components/schemas/BaseOrderChange' + $ref: '#/components/schemas/AdminOrderChange' items: type: array description: The order's items. @@ -48563,7 +49613,7 @@ components: title: variant_id description: The ID of the associated variant. product: - $ref: '#/components/schemas/BaseProduct' + $ref: '#/components/schemas/AdminProduct' product_id: type: string title: product_id @@ -48621,8 +49671,8 @@ components: description: Whether the item's price includes taxes. compare_at_unit_price: type: number - title: The original price of the item before a promotion or sale. - description: The + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -48936,7 +49986,7 @@ components: type: array description: The order's fulfillments. items: - $ref: '#/components/schemas/BaseOrderFulfillment' + $ref: '#/components/schemas/AdminOrderFulfillment' fulfillment_status: type: string description: The order's fulfillment status. @@ -49091,6 +50141,120 @@ components: $ref: '#/components/schemas/Order' return: $ref: '#/components/schemas/AdminReturn' + AdminOrderShippingMethod: + type: object + description: The shipping method's details. + x-schemaName: AdminOrderShippingMethod + 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 ID of the order the shipping method belongs to. + 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: Whether the shipping method's amount includes applied taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: The shipping method's data, useful for fulfillment provider handling its fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The shipping method's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The total discounts applied on the shipping method. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + detail: + $ref: '#/components/schemas/BaseOrderShippingDetail' AdminPayment: type: object description: The payment's details. @@ -49179,22 +50343,22 @@ components: type: array description: The details of payment refunds. items: - $ref: '#/components/schemas/BaseRefund' + $ref: '#/components/schemas/AdminRefund' payment_collection: - $ref: '#/components/schemas/BasePaymentCollection' + type: object payment_session: - $ref: '#/components/schemas/BasePaymentSession' + $ref: '#/components/schemas/AdminPaymentSession' AdminPaymentCollection: type: object description: The payment collection's details. x-schemaName: AdminPaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -49255,17 +50419,17 @@ components: type: array description: The payment provider used to process the collection's payments and sessions. items: - $ref: '#/components/schemas/BasePaymentProvider' + $ref: '#/components/schemas/AdminPaymentProvider' payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: '#/components/schemas/BasePaymentSession' + $ref: '#/components/schemas/AdminPaymentSession' payments: type: array description: The payment collection's payments. items: - $ref: '#/components/schemas/BasePayment' + $ref: '#/components/schemas/AdminPayment' AdminPaymentCollectionResponse: type: object description: The payment collection's details. @@ -49300,6 +50464,65 @@ components: properties: payment: $ref: '#/components/schemas/AdminPayment' + AdminPaymentSession: + type: object + description: The payment session's details. + x-schemaName: AdminPaymentSession + properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: The payment session's data, useful for the payment provider processing the payment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: '#/components/schemas/BasePayment' + required: + - id + - amount + - currency_code + - provider_id + - data + - status AdminPostCancelClaimReqSchema: type: object description: The details of canceling a claim. @@ -50443,15 +51666,15 @@ components: description: The product's details. x-schemaName: AdminProduct required: + - variants - type + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - handle - subtitle - is_giftcard @@ -50465,9 +51688,10 @@ components: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: collection: @@ -50514,7 +51738,7 @@ components: type: array description: The product's options. items: - $ref: '#/components/schemas/BaseProductOption' + $ref: '#/components/schemas/AdminProductOption' description: type: string title: description @@ -50592,7 +51816,7 @@ components: type: array description: The product's images. items: - $ref: '#/components/schemas/BaseProductImage' + $ref: '#/components/schemas/AdminProductImage' discountable: type: boolean title: discountable @@ -50767,9 +51991,43 @@ components: type: boolean title: deleted description: Whether the product was deleted. + AdminProductImage: + type: object + description: The image's details. + x-schemaName: AdminProductImage + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. + required: + - id + - url AdminProductOption: type: object - description: The product's product option. + description: The product option's details. x-schemaName: AdminProductOption required: - id @@ -50784,37 +52042,37 @@ components: title: title description: The product option's title. product: - $ref: '#/components/schemas/BaseProduct' + type: object product_id: type: string title: product_id - description: The product option's product id. + description: The ID of the product this option belongs to. values: type: array description: The product option's values. items: - $ref: '#/components/schemas/BaseProductOptionValue' + type: object metadata: type: object - description: The product option's metadata. + description: The product option's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The product option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The product option's deleted at. + description: The date the product option was deleted. AdminProductOptionDeleteResponse: type: object - description: SUMMARY + description: The details of the product option deletion. x-schemaName: AdminProductOptionDeleteResponse required: - id @@ -50824,29 +52082,70 @@ components: id: type: string title: id - description: The product's ID. + description: The product option's ID. object: type: string title: object description: The name of the deleted object. + default: product_option deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product option was deleted. parent: $ref: '#/components/schemas/AdminProduct' AdminProductOptionResponse: type: object - description: SUMMARY + description: The product option's details. x-schemaName: AdminProductOptionResponse required: - product_option properties: product_option: $ref: '#/components/schemas/AdminProductOption' + AdminProductOptionValue: + type: object + description: The product option value's details. + x-schemaName: AdminProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + $ref: '#/components/schemas/AdminProductOption' + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. AdminProductResponse: type: object - description: SUMMARY + description: The product's details. x-schemaName: AdminProductResponse required: - product @@ -50855,7 +52154,7 @@ components: $ref: '#/components/schemas/AdminProduct' AdminProductTag: type: object - description: The tag's tags. + description: The product tag's details. x-schemaName: AdminProductTag required: - id @@ -50875,23 +52174,23 @@ components: type: string format: date-time title: created_at - description: The tag's created at. + description: The date the tag was created. updated_at: type: string format: date-time title: updated_at - description: The tag's updated at. + description: The date the tag was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tag's deleted at. + description: The date the tag was deleted. metadata: type: object - description: The tag's metadata. + description: The tag's metadata, can hold custom key-value pairs. AdminProductTagDeleteResponse: type: object - description: SUMMARY + description: The details of the product tag deletion. x-schemaName: AdminProductTagDeleteResponse required: - id @@ -50910,10 +52209,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Product Tag was deleted. + description: Whether the product tag was deleted. AdminProductTagListResponse: type: object - description: SUMMARY + description: The paginated list of product tags. x-schemaName: AdminProductTagListResponse required: - limit @@ -50924,23 +52223,23 @@ components: limit: type: number title: limit - description: The product tag's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product tag's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product tag's count. + description: The total number of items. product_tags: type: array - description: The product tag's product tags. + description: The list of product tags. items: $ref: '#/components/schemas/AdminProductTag' AdminProductTagResponse: type: object - description: SUMMARY + description: The product tag's details. x-schemaName: AdminProductTagResponse required: - product_tag @@ -50949,7 +52248,7 @@ components: $ref: '#/components/schemas/AdminProductTag' AdminProductType: type: object - description: The parent's type. + description: The product type's details. x-schemaName: AdminProductType required: - id @@ -50969,23 +52268,23 @@ components: type: string format: date-time title: created_at - description: The type's created at. + description: The date the type was created. updated_at: type: string format: date-time title: updated_at - description: The type's updated at. + description: The date the type was updated. deleted_at: type: string format: date-time title: deleted_at - description: The type's deleted at. + description: The date the type was deleted. metadata: type: object - description: The type's metadata. + description: The type's metadata, can hold custom key-value pairs. AdminProductTypeDeleteResponse: type: object - description: SUMMARY + description: The details of the product type deletion. x-schemaName: AdminProductTypeDeleteResponse required: - id @@ -51004,10 +52303,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Product Type was deleted. + description: Whether the product type was deleted. AdminProductTypeListResponse: type: object - description: SUMMARY + description: The paginated list of product types. x-schemaName: AdminProductTypeListResponse required: - limit @@ -51018,23 +52317,23 @@ components: limit: type: number title: limit - description: The product type's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product type's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product type's count. + description: The total number of items. product_types: type: array - description: The product type's product types. + description: The list of product types. items: $ref: '#/components/schemas/AdminProductType' AdminProductTypeResponse: type: object - description: SUMMARY + description: The product type's details. x-schemaName: AdminProductTypeResponse required: - product_type @@ -51043,10 +52342,11 @@ components: $ref: '#/components/schemas/AdminProductType' AdminProductVariant: type: object - description: The product's parent. + description: The product variant's details. x-schemaName: AdminProductVariant required: - prices + - options - id - title - sku @@ -51063,122 +52363,121 @@ components: - length - height - width - - options - created_at - updated_at - deleted_at properties: prices: type: array - description: The parent's prices. + description: The variant's prices. items: $ref: '#/components/schemas/AdminPrice' id: type: string title: id - description: The parent's ID. + description: The variant's ID. title: type: string title: title - description: The parent's title. + description: The variant's title. sku: type: string title: sku - description: The parent's sku. + description: The variant's SKU. barcode: type: string title: barcode - description: The parent's barcode. + description: The variant's barcode. ean: type: string title: ean - description: The parent's ean. + description: The variant's EAN code. upc: type: string title: upc - description: The parent's upc. + description: The variant's UPC. allow_backorder: type: boolean title: allow_backorder - description: The parent's allow backorder. + description: Whether the variant can be ordered even if it's out of stock. manage_inventory: type: boolean title: manage_inventory - description: The parent's manage inventory. + description: Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock. inventory_quantity: type: number title: inventory_quantity - description: The parent's inventory quantity. + description: The variant's inventory quantity. This is only included if you pass in the `fields` query parameter a `+variants.inventory_quantity` parameter. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The variant's HS code. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The variant's origin country. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The variant's MID code. material: type: string title: material - description: The parent's material. + description: The variant's material. weight: type: number title: weight - description: The parent's weight. + description: The variant's weight. length: type: number title: length - description: The parent's length. + description: The variant's length. height: type: number title: height - description: The parent's height. + description: The variant's height. width: type: number title: width - description: The parent's width. + description: The variant's width. variant_rank: type: number title: variant_rank - description: The parent's variant rank. + description: The variant's rank among its sibling variants. options: type: array - description: The parent's options. + description: The variant's option values. items: - $ref: '#/components/schemas/BaseProductOptionValue' + $ref: '#/components/schemas/AdminProductOptionValue' product: - $ref: '#/components/schemas/BaseProduct' + type: object product_id: type: string title: product_id - description: The parent's product id. + description: The ID of the product that the variant belongs to. calculated_price: $ref: '#/components/schemas/BaseCalculatedPriceSet' created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the variant was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the variant was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the variant was deleted. metadata: type: object - description: The parent's metadata. + description: The variant's metadata, can hold custom key-value pairs. AdminProductVariantDeleteResponse: type: object - description: SUMMARY + description: The details of the product variant's deletion. x-schemaName: AdminProductVariantDeleteResponse required: - id @@ -51188,7 +52487,7 @@ components: id: type: string title: id - description: The product's ID. + description: The product variant's ID. object: type: string title: object @@ -51196,12 +52495,13 @@ components: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product variant was deleted. + default: variant parent: $ref: '#/components/schemas/AdminProduct' AdminProductVariantInventoryBatchResponse: type: object - description: SUMMARY + description: The created, updated, and deleted associations between variants and inventory items. x-schemaName: AdminProductVariantInventoryBatchResponse required: - created @@ -51212,10 +52512,10 @@ components: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: The product's created. + description: The created associations between product variants and inventory items. items: type: object - description: The created's details. + description: A created association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -51223,32 +52523,32 @@ components: properties: productService: type: object - description: The created's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The created's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. updated: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: The product's updated. + description: The updated associations between product variants and inventory items. items: type: object - description: The updated's details. + description: An updated association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -51256,32 +52556,32 @@ components: properties: productService: type: object - description: The updated's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The updated's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. deleted: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: SUMMARY + description: The deleted associations between product variants and inventory items. items: type: object - description: SUMMARY + description: An deleted association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -51289,55 +52589,55 @@ components: properties: productService: type: object - description: The deleted's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The deleted's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. AdminProductVariantInventoryLink: type: object - description: The product's ID. + description: The details of an association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - - productService - - inventoryService + - Product + - Inventory properties: - productService: + Product: type: object - description: The id's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. - inventoryService: + description: The ID of the product variant. + Inventory: type: object - description: The id's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. AdminProductVariantInventoryLinkDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted associated between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLinkDeleteResponse required: - id @@ -51351,752 +52651,16 @@ components: type: string title: object description: The name of the deleted object. + default: variant-inventory-item-link deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the association was deleted. parent: $ref: '#/components/schemas/AdminProductVariant' - AdminProductVariantParams: - type: object - description: SUMMARY - x-schemaName: AdminProductVariantParams - properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. - items: - type: string - title: id - description: The id's ID. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - created_at: - type: object - description: The product's created at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - updated_at: - type: object - description: The product's updated at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - deleted_at: - type: object - description: The product's deleted at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - limit: - type: number - title: limit - description: The product's limit. - offset: - type: number - title: offset - description: The product's offset. - order: - type: string - title: order - description: The product's order. - fields: - type: string - title: fields - description: The product's fields. - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or AdminProductVariantResponse: type: object - description: SUMMARY + description: The product variant's details. x-schemaName: AdminProductVariantResponse required: - variant @@ -52110,6 +52674,13 @@ components: required: - id properties: + application_method: + type: object + rules: + type: array + description: The promotion's rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' id: type: string title: id @@ -52118,6 +52689,7 @@ components: type: string title: code description: The promotion's code. + example: OFF50 type: type: string description: The promotion's type. @@ -52127,23 +52699,16 @@ components: 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' + description: Whether the promotion is applied on a cart automatically if it matches the promotion's rules. campaign_id: type: string title: campaign_id - description: The promotion's campaign id. + description: The ID of the campaign this promotion belongs to. campaign: $ref: '#/components/schemas/AdminCampaign' AdminPromotionResponse: type: object - description: SUMMARY + description: The promotion's details. x-schemaName: AdminPromotionResponse required: - promotion @@ -52152,7 +52717,7 @@ components: $ref: '#/components/schemas/AdminPromotion' AdminPromotionRule: type: object - description: The updated's details. + description: The promotion rule's details. x-schemaName: AdminPromotionRule required: - id @@ -52161,18 +52726,19 @@ components: id: type: string title: id - description: The updated's ID. + description: The promotion rule's ID. description: type: string title: description - description: The updated's description. + description: The promotion rule's description. attribute: type: string title: attribute - description: The updated's attribute. + description: The promotion rule's attribute. + example: customer_group_id operator: type: string - description: The updated's operator. + description: The rule's operator. enum: - gt - lt @@ -52183,9 +52749,50 @@ components: - gte values: type: array - description: The updated's values. + description: The rule's values. + example: + - cusgroup_123 items: $ref: '#/components/schemas/BasePromotionRuleValue' + AdminRefund: + type: object + description: The refund's details. + x-schemaName: AdminRefund + required: + - id + - amount + - created_at + - payment + properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + $ref: '#/components/schemas/BasePayment' + refund_reason: + $ref: '#/components/schemas/RefundReason' AdminRefundReason: type: object description: The refund reason's details. @@ -52211,25 +52818,25 @@ components: description: The refund reason's description. metadata: type: object - description: The refund reason's metadata. + description: The refund reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The refund reason's created at. + description: The date the refund reason was created. updated_at: type: string format: date-time title: updated_at - description: The refund reason's updated at. + description: The date the refund reason was updated. AdminRegion: type: object description: The region's details. x-schemaName: AdminRegion required: - - id - name - currency_code + - id properties: id: type: string @@ -52243,15 +52850,16 @@ components: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are applied automatically during checkout. countries: type: array description: The region's countries. items: - $ref: '#/components/schemas/BaseRegionCountry' + $ref: '#/components/schemas/AdminRegionCountry' payment_providers: type: array description: The region's payment providers. @@ -52259,24 +52867,54 @@ components: $ref: '#/components/schemas/AdminPaymentProvider' metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. AdminRegionCountry: type: object - description: The billing address's country. + description: The country's details. x-schemaName: AdminRegionCountry + required: + - id + properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. AdminRegionResponse: type: object - description: SUMMARY + description: The region's details. x-schemaName: AdminRegionResponse required: - region @@ -52295,7 +52933,6 @@ components: - external_id - description - inventory_item_id - - inventory_item properties: id: type: string @@ -52304,11 +52941,11 @@ components: line_item_id: type: string title: line_item_id - description: The reservation's line item id. + description: The ID of the line item this reservation is for. location_id: type: string title: location_id - description: The reservation's location id. + description: The ID of the location the quantity is reserved from. quantity: type: number title: quantity @@ -52316,7 +52953,7 @@ components: external_id: type: string title: external_id - description: The reservation's external id. + description: An ID in an external system description: type: string title: description @@ -52324,35 +52961,34 @@ components: inventory_item_id: type: string title: inventory_item_id - description: The reservation's inventory item id. + description: The ID of the inventory item this reservation is associated with. inventory_item: - type: object - description: The reservation's inventory item. + $ref: '#/components/schemas/AdminInventoryItem' metadata: type: object - description: The reservation's metadata. + description: The reservation's metadata, can hold custom key-value pairs. created_by: type: string title: created_by - description: The reservation's created by. + description: The ID of the user that created this reservation. deleted_at: type: string format: date-time title: deleted_at - description: The reservation's deleted at. + description: The date this reservation was deleted. created_at: type: string format: date-time title: created_at - description: The reservation's created at. + description: The date this reservation was created. updated_at: type: string format: date-time title: updated_at - description: The reservation's updated at. + description: The date this reservation was updated. AdminReservationResponse: type: object - description: SUMMARY + description: The reservation's details. x-schemaName: AdminReservationResponse required: - reservation @@ -52361,14 +52997,14 @@ components: $ref: '#/components/schemas/AdminReservation' AdminReturn: type: object - description: The exchange's return. + description: The return's details. x-schemaName: AdminReturn required: + - items - id - order_id - order_version - display_id - - items - received_at - created_at - canceled_at @@ -52377,14 +53013,37 @@ components: type: string title: id description: The return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. order_id: type: string title: order_id - description: The return's order id. - status: + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/AdminReturnItem' + created_at: type: string - title: status - description: The return's status. + format: date-time + title: created_at + description: The date the return was created. + canceled_at: + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time exchange_id: type: string title: exchange_id @@ -52408,32 +53067,14 @@ components: 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' + description: Whether the customer should receive notifications about the return's updates. 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. - canceled_at: - type: string - title: canceled_at - description: The return's canceled at. + description: The date the return was received. AdminReturnItem: type: object - description: The return item's return items. + description: The return item's details. x-schemaName: AdminReturnItem required: - id @@ -52454,33 +53095,33 @@ components: received_quantity: type: number title: received_quantity - description: The return item's received quantity. + description: The received quantity of the item. This quantity is added to the stocked inventory quantity of the item. damaged_quantity: type: number title: damaged_quantity - description: The return item's damaged quantity. + description: The received damaged quantity of the item, which isn't added to the stocked inventory quantity of the item. reason_id: type: string title: reason_id - description: The return item's reason id. + description: The ID of the return reason associated with the item. note: type: string title: note - description: The return item's note. + description: A note about why the item was returned. item_id: type: string title: item_id - description: The return item's item id. + description: The ID of the associated order item. return_id: type: string title: return_id - description: The return item's return id. + description: The ID of the return this return item belongs to. metadata: type: object - description: The return item's metadata. + description: The return item's metadata, can hold custom key-value pairs. AdminReturnPreviewResponse: type: object - description: SUMMARY + description: The details of a return and a preview of the order once the return is applied. x-schemaName: AdminReturnPreviewResponse required: - order_preview @@ -52519,20 +53160,20 @@ components: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. AdminReturnReasonDeleteResponse: type: object - description: SUMMARY + description: The details of the return reason deletion. x-schemaName: AdminReturnReasonDeleteResponse required: - id @@ -52551,10 +53192,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Return Reason was deleted. + description: Whether the return reason was deleted. AdminReturnReasonListResponse: type: object - description: SUMMARY + description: The paginated list of return reasons. x-schemaName: AdminReturnReasonListResponse required: - limit @@ -52565,23 +53206,23 @@ components: limit: type: number title: limit - description: The return reason's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The return reason's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The return reason's count. + description: The total number of items. return_reasons: type: array - description: The return reason's return reasons. + description: The list of return reasons. items: $ref: '#/components/schemas/AdminReturnReason' AdminReturnReasonResponse: type: object - description: SUMMARY + description: The return reason's details. x-schemaName: AdminReturnReasonResponse required: - return_reason @@ -52590,7 +53231,7 @@ components: $ref: '#/components/schemas/AdminReturnReason' AdminReturnResponse: type: object - description: SUMMARY + description: The return's details. x-schemaName: AdminReturnResponse required: - return @@ -52599,50 +53240,38 @@ components: $ref: '#/components/schemas/AdminReturn' AdminRevokeApiKey: type: object - description: SUMMARY + description: The details of revoking the API key. x-schemaName: AdminRevokeApiKey properties: revoke_in: type: number title: revoke_in - description: The api key's revoke in. + description: The time in seconds to revoke the API key after. If not set, the API key is revoked immediately. AdminRuleAttributeOption: type: object - description: The attribute's attributes. + description: The details of a potential rule attribute. x-schemaName: AdminRuleAttributeOption required: - id - value - label - - field_type - - required - - disguised - operators properties: id: type: string title: id - description: The attribute's ID. + description: The rule attribute's ID, which is a rule's `attribute` it refers to. + example: customer_group value: type: string title: value - description: The attribute's value. + description: The rule attribute's value. + example: customer.groups.id 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. + description: The rule attribute option's label. + example: Customer Group operators: type: array description: The attribute's operators. @@ -52650,28 +53279,25 @@ components: $ref: '#/components/schemas/BaseRuleOperatorOptions' AdminRuleValueOption: type: object - description: The value's values. + description: The details of a potential rule value. 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. + description: The rule value's value. + example: reg_123 label: type: string title: label - description: The value's label. + description: The rule value's label. + example: Europe Region AdminSalesChannel: type: object - description: The order's sales channel. + description: The sales channel's details. x-schemaName: AdminSalesChannel required: - id @@ -52698,28 +53324,28 @@ components: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The sales channel's created at. + description: The date the sales channel was created. updated_at: type: string format: date-time title: updated_at - description: The sales channel's updated at. + description: The date the sales channel was updated. deleted_at: type: string format: date-time title: deleted_at - description: The sales channel's deleted at. + description: The date the sales channel was deleted. AdminSalesChannelDeleteResponse: type: object - description: SUMMARY + description: The details of deleting a sales channel. x-schemaName: AdminSalesChannelDeleteResponse required: - id @@ -52738,10 +53364,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Sales Channel was deleted. + description: Whether the sales channel was deleted. AdminSalesChannelResponse: type: object - description: SUMMARY + description: The sales channel's details. x-schemaName: AdminSalesChannelResponse required: - sales_channel @@ -52750,7 +53376,7 @@ components: $ref: '#/components/schemas/AdminSalesChannel' AdminServiceZone: type: object - description: The service zone's service zones. + description: The shipping option's service zone. x-schemaName: AdminServiceZone required: - id @@ -52804,7 +53430,7 @@ components: description: The service zone's deleted at. AdminServiceZoneDeleteResponse: type: object - description: SUMMARY + description: The details of the service zone deletion. x-schemaName: AdminServiceZoneDeleteResponse required: - id @@ -52814,20 +53440,21 @@ components: id: type: string title: id - description: The fulfillment set's ID. + description: The service zone's ID. object: type: string title: object description: The name of the deleted object. + default: service_zone deleted: type: boolean title: deleted - description: Whether the Fulfillment Set was deleted. + description: Whether the service zone was deleted. parent: $ref: '#/components/schemas/AdminFulfillmentSet' AdminServiceZoneResponse: type: object - description: SUMMARY + description: The service zone's details. x-schemaName: AdminServiceZoneResponse required: - service_zone @@ -52836,11 +53463,102 @@ components: $ref: '#/components/schemas/AdminServiceZone' AdminShippingOption: type: object - description: The shipping option's shipping options. + description: The shipping option's details. x-schemaName: AdminShippingOption + required: + - id + - name + - price_type + - service_zone_id + - service_zone + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - shipping_profile + - rules + - prices + - data + - metadata + - created_at + - updated_at + - deleted_at + 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 + description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider. + enum: + - calculated + - flat + service_zone_id: + type: string + title: service_zone_id + description: The ID of the service zone this option belongs to. + service_zone: + type: object + provider_id: + type: string + title: provider_id + description: The ID of the provider handling fulfillments created from this shipping option. + provider: + $ref: '#/components/schemas/AdminFulfillmentProvider' + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The ID of the associated shipping option type. + type: + $ref: '#/components/schemas/AdminShippingOptionType' + shipping_profile_id: + type: string + title: shipping_profile_id + description: The ID of the associated shipping profile. + shipping_profile: + $ref: '#/components/schemas/AdminShippingProfile' + rules: + type: array + description: The shipping option's rules. + items: + $ref: '#/components/schemas/AdminShippingOptionRule' + prices: + type: array + description: The shipping option's prices. If the `price_type` is `calculated`, this array will be empty since the price is calculated by the fulfillment provider during checkout. + items: + $ref: '#/components/schemas/AdminShippingOptionPrice' + data: + type: object + description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. AdminShippingOptionDeleteResponse: type: object - description: SUMMARY + description: The details of the shipping option's deletion. x-schemaName: AdminShippingOptionDeleteResponse required: - id @@ -52859,10 +53577,101 @@ components: deleted: type: boolean title: deleted - description: Whether the Shipping Option was deleted. + description: Whether the shipping option was deleted. + AdminShippingOptionPrice: + type: object + description: The details of the shipping option's price. + x-schemaName: AdminShippingOptionPrice + required: + - price_rules + - rules_count + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at + properties: + price_rules: + type: array + description: The price's rules. + items: + $ref: '#/components/schemas/AdminShippingOptionPriceRule' + rules_count: + type: number + title: rules_count + description: The number of rules the price has. + 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. + example: usd + 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 minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity that the cart's items must not surpass for this price to apply. + price_set_id: + type: string + title: price_set_id + description: The ID of the price set this price belongs to. + created_at: + type: string + format: date-time + title: created_at + description: The date the price was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the price was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the price was deleted. + AdminShippingOptionPriceRule: + type: object + description: The details of a shipping option price's rule. + x-schemaName: AdminShippingOptionPriceRule + required: + - id + - value + properties: + id: + type: string + title: id + description: The price rule's ID. + value: + type: string + title: value + description: The price rule's value. AdminShippingOptionResponse: type: object - description: SUMMARY + description: The shipping option's details. x-schemaName: AdminShippingOptionResponse required: - shipping_option @@ -52871,7 +53680,7 @@ components: $ref: '#/components/schemas/AdminShippingOption' AdminShippingOptionRule: type: object - description: The updated's details. + description: The shipping option rule's details. x-schemaName: AdminShippingOptionRule required: - id @@ -52886,52 +53695,144 @@ components: id: type: string title: id - description: The updated's ID. + description: The shipping option rule's ID. attribute: type: string title: attribute - description: The updated's attribute. + description: The shipping option rule's attribute. + example: is_return operator: type: string title: operator - description: The updated's operator. + description: The shipping option rule's operator. + example: eq value: oneOf: - type: string title: value - description: The updated's value. + description: The rule's value. + example: '"true"' - type: array - description: The updated's value. + description: The rule's values. items: type: string title: value - description: The value's details. + description: A rule's value + example: '"true"' shipping_option_id: type: string title: shipping_option_id - description: The updated's shipping option id. + description: The ID of the shipping option this rule is for. created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The date the shipping option rule was created. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The date the shipping option rule was updated. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The date the shipping option rule was deleted. + AdminShippingOptionType: + type: object + description: The shipping option's details. + x-schemaName: AdminShippingOptionType + required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The shipping option's ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The type's shipping option id. AdminShippingProfile: type: object - description: The shipping option's shipping profile. + description: The shipping profile's details.. x-schemaName: AdminShippingProfile + properties: + id: + type: string + title: id + description: The shipping profile's ID. + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata, holds custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping profile was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping profile was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping profile was deleted. + required: + - id + - name + - type + - metadata + - created_at + - updated_at + - deleted_at AdminShippingProfileDeleteResponse: type: object - description: SUMMARY + description: The details of the shipping profile's deletion. x-schemaName: AdminShippingProfileDeleteResponse required: - id @@ -52950,10 +53851,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Shipping Profile was deleted. + description: Whether the shipping profile was deleted. AdminShippingProfileResponse: type: object - description: SUMMARY + description: The shipping profile's details. x-schemaName: AdminShippingProfileResponse required: - shipping_profile @@ -52962,7 +53863,7 @@ components: $ref: '#/components/schemas/AdminShippingProfile' AdminStockLocation: type: object - description: The parent's location. + description: The stock location's details. x-schemaName: AdminStockLocation required: - id @@ -52980,31 +53881,79 @@ components: address_id: type: string title: address_id - description: The location's address id. + description: The ID of the associated address. address: $ref: '#/components/schemas/AdminStockLocationAddress' sales_channels: type: array - description: The location's sales channels. + description: The sales channels associated with the location. items: $ref: '#/components/schemas/AdminSalesChannel' fulfillment_providers: type: array - description: The location's fulfillment providers. + description: The fulfillment providers associated with the location. items: $ref: '#/components/schemas/AdminFulfillmentProvider' fulfillment_sets: type: array - description: The location's fulfillment sets. + description: The fulfillment sets associated with the location. items: type: object AdminStockLocationAddress: type: object - description: The location's address. + description: The details of the stock location address. x-schemaName: AdminStockLocationAddress + properties: + id: + type: string + title: id + description: The address's ID. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + required: + - id + - address_1 + - address_2 + - company + - country_code + - city + - phone + - postal_code + - province AdminStockLocationDeleteResponse: type: object - description: SUMMARY + description: The details of the stock location's deletion. x-schemaName: AdminStockLocationDeleteResponse required: - id @@ -53023,10 +53972,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Stock Location was deleted. + description: Whether the stock location was deleted. AdminStockLocationListResponse: type: object - description: SUMMARY + description: The paginated list of stock locations. x-schemaName: AdminStockLocationListResponse required: - limit @@ -53037,23 +53986,23 @@ components: limit: type: number title: limit - description: The stock location's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The stock location's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The stock location's count. + description: The total number of items. stock_locations: type: array - description: The stock location's stock locations. + description: The list of stock locations. items: $ref: '#/components/schemas/AdminStockLocation' AdminStockLocationResponse: type: object - description: SUMMARY + description: The stock location's details. x-schemaName: AdminStockLocationResponse required: - stock_location @@ -53091,31 +54040,31 @@ components: default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the sales channel used by default in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the region used by default in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the stock location used by default in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The store's created at. + description: The date the store was created. updated_at: type: string format: date-time title: updated_at - description: The store's updated at. + description: The date the store was updated. AdminStoreCurrency: type: object - description: The supported currency's supported currencies. + description: The details of a store's currency. x-schemaName: AdminStoreCurrency required: - id @@ -53130,39 +54079,40 @@ components: id: type: string title: id - description: The supported currency's ID. + description: The currency's ID. currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd store_id: type: string title: store_id - description: The supported currency's store id. + description: The ID of the store this currency belongs to. is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether this currency is the default in the store. currency: $ref: '#/components/schemas/AdminCurrency' created_at: type: string format: date-time title: created_at - description: The supported currency's created at. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The supported currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The supported currency's deleted at. + description: The date the currency was deleted. AdminStoreListResponse: type: object - description: SUMMARY + description: The paginated list of stores. x-schemaName: AdminStoreListResponse required: - limit @@ -53173,23 +54123,23 @@ components: limit: type: number title: limit - description: The store's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The store's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The store's count. + description: The total number of items. stores: type: array - description: The store's stores. + description: The list of stores. items: $ref: '#/components/schemas/AdminStore' AdminStoreResponse: type: object - description: SUMMARY + description: The store's details. x-schemaName: AdminStoreResponse required: - store @@ -53198,7 +54148,7 @@ components: $ref: '#/components/schemas/AdminStore' AdminTaxRate: type: object - description: The tax rate's parent. + description: The tax rate's details. x-schemaName: AdminTaxRate required: - id @@ -53219,63 +54169,66 @@ components: id: type: string title: id - description: The parent's ID. + description: The tax rate's ID. rate: type: number title: rate - description: The parent's rate. + description: The rate to charge. + example: 10 code: type: string title: code - description: The parent's code. + description: The code the tax rate is identified by. name: type: string title: name - description: The parent's name. + description: The tax rate's name. metadata: type: object - description: The parent's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. tax_region_id: type: string title: tax_region_id - description: The parent's tax region id. + description: The ID of the tax region this rate belongs to. is_combinable: type: boolean title: is_combinable - description: The parent's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates is_default: type: boolean title: is_default - description: The parent's is default. + description: Whether this tax rate is the default in the tax region. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the tax rate was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the tax rate was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the tax rate was deleted. created_by: type: string title: created_by - description: The parent's created by. + description: The ID of the user that created the tax rate. tax_region: $ref: '#/components/schemas/AdminTaxRegion' rules: type: array - description: The parent's rules. + description: The tax rate's rules. items: $ref: '#/components/schemas/AdminTaxRateRule' AdminTaxRateDeleteResponse: type: object - description: SUMMARY + description: The details of the tax rate deletion. x-schemaName: AdminTaxRateDeleteResponse required: - id @@ -53294,10 +54247,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Tax Rate was deleted. + description: Whether the tax rate was deleted. AdminTaxRateResponse: type: object - description: SUMMARY + description: The tax rate's details. x-schemaName: AdminTaxRateResponse required: - tax_rate @@ -53306,7 +54259,7 @@ components: $ref: '#/components/schemas/AdminTaxRate' AdminTaxRateRule: type: object - description: The rule's rules. + description: The tax rate rule's details. x-schemaName: AdminTaxRateRule required: - reference @@ -53315,26 +54268,22 @@ components: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of a record in the table that this rule references. + example: ptyp_1 AdminTaxRegion: type: object - description: The parent's tax region. + description: The tax region's details. 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 @@ -53348,67 +54297,44 @@ components: 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. + example: us 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. + description: The tax region's metadata, can hold custom key-value pairs. parent_id: type: string title: parent_id - description: The tax region's parent id. + description: The ID of the parent tax region. created_at: type: string format: date-time title: created_at - description: The tax region's created at. + description: The date the tax region was created. updated_at: type: string format: date-time title: updated_at - description: The tax region's updated at. + description: The date the tax region was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tax region's deleted at. + description: The date the tax region was deleted. created_by: type: string title: created_by - description: The tax region's created by. + description: The ID of the user that created the tax region. tax_rates: type: array - description: The tax region's tax rates. + description: The tax region's rates. items: type: object parent: @@ -53420,7 +54346,7 @@ components: type: object AdminTaxRegionDeleteResponse: type: object - description: SUMMARY + description: The details of the tax region deletion. x-schemaName: AdminTaxRegionDeleteResponse required: - id @@ -53439,10 +54365,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Tax Region was deleted. + description: Whether the tax region was deleted. AdminTaxRegionResponse: type: object - description: SUMMARY + description: The tax region's details. x-schemaName: AdminTaxRegionResponse required: - tax_region @@ -53451,7 +54377,7 @@ components: $ref: '#/components/schemas/AdminTaxRegion' AdminUpdateApiKey: type: object - description: SUMMARY + description: The details to update in an API key. x-schemaName: AdminUpdateApiKey required: - title @@ -53459,10 +54385,10 @@ components: title: type: string title: title - description: The api key's title. + description: The API key's title. AdminUpdateCollection: type: object - description: SUMMARY + description: The details to update in a collection. x-schemaName: AdminUpdateCollection properties: title: @@ -53475,10 +54401,10 @@ components: description: The collection's handle. metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. AdminUpdateCustomerGroup: type: object - description: SUMMARY + description: The details to update in a customer group. x-schemaName: AdminUpdateCustomerGroup properties: name: @@ -53487,10 +54413,10 @@ components: description: The customer group's name. metadata: type: object - description: The customer group's metadata. + description: The customer group's metadata, can hold custom key-value pairs. AdminUpdatePriceList: type: object - description: SUMMARY + description: the details to update in a price list. x-schemaName: AdminUpdatePriceList properties: title: @@ -53504,11 +54430,11 @@ components: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -53524,72 +54450,77 @@ components: rules: type: object description: The price list's rules. + example: + customer_group_id: + - cusgrp_123 AdminUpdatePricePreference: type: object - description: SUMMARY + description: The details to update in the price preference. x-schemaName: AdminUpdatePricePreference properties: attribute: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices are tax inclusive for this price preference. AdminUpdateProduct: type: object - description: The update's details. + description: The product's details. x-schemaName: AdminUpdateProduct properties: title: type: string title: title - description: The update's title. + description: The product's title. subtitle: type: string title: subtitle - description: The update's subtitle. + description: The product's subtitle. description: type: string title: description - description: The update's description. + description: The product's description. is_giftcard: type: boolean title: is_giftcard - description: The update's is giftcard. + description: Whether the product is a gift card. discountable: type: boolean title: discountable - description: The update's discountable. + description: Whether discounts can be applied on the product. images: type: array - description: The update's images. + description: The product's images. items: type: object - description: The image's images. + description: The image's details. required: - url properties: url: type: string title: url - description: The image's url. + description: The image's URL. thumbnail: type: string title: thumbnail - description: The update's thumbnail. + description: The product's thumbnail URL. handle: type: string title: handle - description: The update's handle. + description: The product's unique handle. status: type: string - description: The update's status. + description: The product's status. enum: - draft - proposed @@ -53598,17 +54529,17 @@ components: type_id: type: string title: type_id - description: The update's type id. + description: The ID of the product's type. collection_id: type: string title: collection_id - description: The update's collection id. + description: The ID of the product's collection. categories: type: array - description: The update's categories. + description: The product's categories. items: type: object - description: The category's categories. + description: The product's category. required: - id properties: @@ -53618,10 +54549,10 @@ components: description: The category's ID. tags: type: array - description: The update's tags. + description: The product's tags. items: type: object - description: The tag's tags. + description: The product's tag. required: - id properties: @@ -53631,181 +54562,22 @@ components: description: The tag's ID. options: type: array - description: The update's options. + description: The product's options. items: $ref: '#/components/schemas/AdminUpdateProductOption' variants: type: array - description: The update's variants. + description: The product's variants. You can add new variants or update existing ones, passing their IDs in the object. items: 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. + - $ref: '#/components/schemas/AdminCreateProductVariant' + - $ref: '#/components/schemas/AdminUpdateProductVariant' sales_channels: type: array - description: The update's sales channels. + description: The sales channels that the product is available in. items: type: object - description: The sales channel's sales channels. + description: The sales channel's details. required: - id properties: @@ -53816,137 +54588,205 @@ components: weight: type: number title: weight - description: The update's weight. + description: The product's weight. length: type: number title: length - description: The update's length. + description: The product's length. height: type: number title: height - description: The update's height. + description: The product's height. width: type: number title: width - description: The update's width. + description: The product's width. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product's MID code. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product's origin country. material: type: string title: material - description: The update's material. + description: The product's material. metadata: type: object - description: The update's metadata. + description: The product's metadata, can hold custom key-value pairs. AdminUpdateProductOption: type: object - description: SUMMARY + description: The details to update in a product option. x-schemaName: AdminUpdateProductOption properties: title: type: string title: title - description: The product's title. + description: The option's title. values: type: array - description: The product's values. + description: The option's values. items: type: string title: values - description: The value's values. + description: An option value. AdminUpdateProductVariant: type: object - description: The update's details. + description: The properties to update of a product variant. x-schemaName: AdminUpdateProductVariant properties: title: type: string title: title - description: The update's title. + description: The product variant's title. sku: type: string title: sku - description: The update's sku. + description: The product variant's SKU. ean: type: string title: ean - description: The update's ean. + description: The product variant's EAN. upc: type: string title: upc - description: The update's upc. + description: The product variant's UPC. barcode: type: string title: barcode - description: The update's barcode. + description: The product variant's barcode. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product variant's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product variant's MID code. allow_backorder: type: boolean title: allow_backorder - description: The update's allow backorder. + description: Whether customers can order the variant even if it's not in stock. manage_inventory: type: boolean title: manage_inventory - description: The update's manage inventory. + description: Whether the Medusa application manages the variant's inventory. If disabled, the product variant is always considered in stock. variant_rank: type: number title: variant_rank - description: The update's variant rank. + description: The product variant's rank among its siblings. weight: type: number title: weight - description: The update's weight. + description: The product variant's weight. length: type: number title: length - description: The update's length. + description: The product variant's length. height: type: number title: height - description: The update's height. + description: The product variant's height. width: type: number title: width - description: The update's width. + description: The product variant's width. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product variant's origin country. material: type: string title: material - description: The update's material. + description: The product variant's material. metadata: type: object - description: The update's metadata. + description: The product variant's metadata, can hold custom key-value pairs. prices: type: array - description: The update's prices. + description: The product variant's prices. items: $ref: '#/components/schemas/AdminCreateProductVariantPrice' options: type: object - description: The update's options. + description: The product variant's options. + AdminUpdatePromotionRule: + type: object + description: The properties to update in a buy rule. + required: + - id + - values + properties: + id: + type: string + title: id + description: The buy rule's ID. + operator: + type: string + description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id + values: + oneOf: + - type: string + title: values + description: The attribute's value. + example: prod_123 + - type: array + description: The allowed attribute values. + items: + type: string + title: values + description: An attribute value. + example: prod_123 + x-schemaName: AdminUpdatePromotionRule + AdminUpdateReturnReason: + type: object + description: The details to update in a return reason. + x-schemaName: AdminUpdateReturnReason + properties: + label: + type: string + title: label + description: The return reason's label. + value: + type: string + title: value + description: The return reason's value. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata, can hold custom key-value pairs. + required: + - value + - label AdminUpdateSalesChannel: type: object - description: SUMMARY + description: The properties to update in the sales channel. x-schemaName: AdminUpdateSalesChannel properties: name: @@ -53960,13 +54800,57 @@ components: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. + AdminUpdateShippingOptionRule: + type: object + description: The properties to update in the shipping option rule. + required: + - id + - operator + - attribute + - value + properties: + id: + type: string + title: id + description: The rule's ID. + operator: + type: string + description: The operator used to check whether a rule applies. + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The name of a property or table that the rule applies to. + example: customer_group + value: + oneOf: + - type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 + - type: array + description: Values of the attribute that enable this rule. + items: + type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 + x-schemaName: AdminUpdateShippingOptionRule AdminUpdateStockLocation: type: object - description: SUMMARY + description: The properties to update in a stock location. x-schemaName: AdminUpdateStockLocation properties: name: @@ -53975,7 +54859,7 @@ components: description: The stock location's name. address: type: object - description: The stock location's address. + description: The stock location's address. Pass this property if you're creating a new address to associate with the location. required: - address_1 - country_code @@ -53983,11 +54867,11 @@ components: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -54000,6 +54884,7 @@ components: type: string title: country_code description: The address's country code. + example: us phone: type: string title: phone @@ -54015,13 +54900,13 @@ components: address_id: type: string title: address_id - description: The stock location's address id. + description: The ID of an existing stock location address to associate the stock location with. metadata: type: object - description: The stock location's metadata. + description: The stock location's metadata, can hold custom key-value pairs. AdminUpdateStore: type: object - description: SUMMARY + description: The properties to update in a store. x-schemaName: AdminUpdateStore properties: name: @@ -54033,56 +54918,57 @@ components: description: The store's supported currencies. items: type: object - description: The supported currency's supported currencies. + description: A store currency. required: - currency_code properties: currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether the currency is the default in the store. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The supported currency's is tax inclusive. + description: Whether prices using this currency are tax inclusive. default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the default sales channel in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the default region in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the default stock location in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. AdminUpdateTaxRate: type: object - description: SUMMARY + description: The properties to update in the tax rate. x-schemaName: AdminUpdateTaxRate properties: rate: type: number title: rate - description: The tax rate's rate. + description: The rate to charge. code: type: string title: code - description: The tax rate's code. + description: The code that the tax rate is identified by. rules: type: array description: The tax rate's rules. items: type: object - description: The rule's rules. + description: A tax rate rule. required: - reference - reference_id @@ -54090,11 +54976,13 @@ components: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of the record in the table that the rule references. + example: ptyp_123 name: type: string title: name @@ -54102,17 +54990,19 @@ components: is_default: type: boolean title: is_default - description: The tax rate's is default. + description: Whether the tax rate is the default in the store. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates metadata: type: object - description: The tax rate's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. AdminUpdateUser: type: object - description: SUMMARY + description: The properties to update in a user. x-schemaName: AdminUpdateUser properties: first_name: @@ -54126,10 +55016,10 @@ components: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. AdminUpdateVariantInventoryItem: type: object - description: SUMMARY + description: The properties to update of the variant's inventory item association. x-schemaName: AdminUpdateVariantInventoryItem required: - required_quantity @@ -54137,10 +55027,10 @@ components: required_quantity: type: number title: required_quantity - description: The product's required quantity. + description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. AdminUpsertStockLocationAddress: type: object - description: The stock location's address. + description: The details of the stock location address to create. x-schemaName: AdminUpsertStockLocationAddress required: - address_1 @@ -54149,11 +55039,11 @@ components: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -54162,6 +55052,7 @@ components: type: string title: country_code description: The address's country code. + example: usd city: type: string title: city @@ -54213,28 +55104,28 @@ components: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The user's created at. + description: The date the user was created. updated_at: type: string format: date-time title: updated_at - description: The user's updated at. + description: The date the user was updated. deleted_at: type: string format: date-time title: deleted_at - description: The user's deleted at. + description: The date the user was deleted. AdminUserDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted user. x-schemaName: AdminUserDeleteResponse required: - id @@ -54253,10 +55144,10 @@ components: deleted: type: boolean title: deleted - description: Whether the User was deleted. + description: Whether the user was deleted. AdminUserListResponse: type: object - description: SUMMARY + description: The paginated list of users. x-schemaName: AdminUserListResponse required: - limit @@ -54267,23 +55158,23 @@ components: limit: type: number title: limit - description: The user's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The user's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The user's count. + description: The total number of items. users: type: array - description: The user's users. + description: The list of users. items: $ref: '#/components/schemas/AdminUser' AdminUserResponse: type: object - description: SUMMARY + description: The user's details. x-schemaName: AdminUserResponse required: - user @@ -54292,7 +55183,7 @@ components: $ref: '#/components/schemas/AdminUser' AdminWorkflowExecution: type: object - description: The workflows execution's workflow execution. + description: The workflows execution's details. x-schemaName: AdminWorkflowExecution required: - id @@ -54311,11 +55202,11 @@ components: workflow_id: type: string title: workflow_id - description: The workflow execution's workflow id. + description: The ID of the workflow. transaction_id: type: string title: transaction_id - description: The workflow execution's transaction id. + description: The workflow execution's transaction ID. execution: $ref: '#/components/schemas/AdminWorkflowExecutionExecution' context: @@ -54335,30 +55226,160 @@ components: type: string format: date-time title: created_at - description: The workflow execution's created at. + description: The date the workflow execution was created. updated_at: type: string format: date-time title: updated_at - description: The workflow execution's updated at. + description: The date the workflow execution was updated. deleted_at: type: string format: date-time title: deleted_at - description: The workflow execution's deleted at. + description: The date the workflow execution was deleted. AdminWorkflowExecutionExecution: type: object - description: The workflow execution's execution. + description: The workflow execution's steps details. x-schemaName: AdminWorkflowExecutionExecution required: - steps properties: steps: type: object - description: The execution's steps. + description: The execution's steps. Each object key is a step ID, and the value is the object whose properties are shown below. + required: + - id + - invoke + - definition + - compensate + - depth + - startedAt + additionalProperties: + type: object + properties: + id: + type: string + title: id + description: The step's ID. + invoke: + type: object + description: The state of the step's invokation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The invokation step's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The invokation step's state. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + definition: + type: object + description: The step's definition details. + x-schemaName: WorkflowExecutionDefinition + properties: + async: + type: boolean + title: async + description: Whether the step is async. + compensateAsync: + type: boolean + title: compensateAsync + description: Whether the compensation function of the step is async. + noCompensation: + type: boolean + title: noCompensation + description: Whether the step doesn't have a compensation function. + continueOnPermanentFailure: + type: boolean + title: continueOnPermanentFailure + description: Whether the step continues executing even if its status is changed to failed. + maxRetries: + type: number + title: maxRetries + description: The maximum number of times to retry the step. + noWait: + type: boolean + title: noWait + description: Whether the workflow shouldn't wait for the step to finish before moving to the next step. + default: false + retryInterval: + type: number + title: retryInterval + description: The interval in seconds between retry attempts when the step fails. + retryIntervalAwaiting: + type: number + title: retryIntervalAwaiting + description: The interval in seconds to retry a step even if its status is `waiting_response`. + saveResponse: + type: boolean + title: saveResponse + description: Whether the step's response is stored. + timeout: + type: number + title: timeout + description: The maximum time in seconds to wait for this step to complete. If the step exceeds this time, the step's state is changed to `timeout`, but the step continues executing. + compensate: + type: object + description: The state of the step's compensation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The compensation function's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The compensation function's status. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + depth: + type: number + title: depth + description: The step's depth in the workflow's execution. + startedAt: + type: number + title: startedAt + description: The timestamp the step started executing. AdminWorkflowExecutionResponse: type: object - description: SUMMARY + description: The workflow execution's details. x-schemaName: AdminWorkflowExecutionResponse required: - workflow_execution @@ -54367,7 +55388,7 @@ components: $ref: '#/components/schemas/AdminWorkflowExecution' ApiKeyResponse: type: object - description: The api key's details. + description: The API key's details. x-schemaName: ApiKeyResponse required: - id @@ -54384,46 +55405,47 @@ components: id: type: string title: id - description: The api key's ID. + description: The API key's ID. token: type: string title: token - description: The api key's token. + description: The API key's token. redacted: type: string title: redacted - description: The api key's redacted. + description: The redacted form of the API key's token. This is useful when showing portion of the token. For example `sk_...123`. title: type: string title: title - description: The api key's title. + description: The API key's title. type: type: string + description: The API key's type. `secret` API keys are used for authenticating admin users, and `publishable` API key are used for storefronts and similar clients to scope requests to sales channels. enum: - secret - publishable last_used_at: type: string title: last_used_at - description: The api key's last used at. + description: The date the API key was last used. format: date-time created_by: type: string title: created_by - description: The api key's created by. + description: The ID of the user that created the API key. created_at: type: string title: created_at - description: The api key's created at. + description: The date the API key was created. format: date-time revoked_by: type: string title: revoked_by - description: The api key's revoked by. + description: The ID of the user that revoked the API key. revoked_at: type: string title: revoked_at - description: The api key's revoked at. + description: The date the API key was revoked. format: date-time AuthAdminSessionResponse: type: object @@ -54443,7 +55465,7 @@ components: required: - location properties: - token: + location: type: string title: location description: The location to redirect the user to for further authentication with the third-party provider. @@ -54469,71 +55491,9 @@ components: title: user description: The logged-in customer. $ref: '#/components/schemas/StoreCustomer' - 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 - description: The application method's type. - enum: - - fixed - - percentage - target_type: - type: string - description: The application method's target type. - enum: - - items - - shipping_methods - - order - allocation: - type: string - description: The application method's allocation. - enum: - - each - - across - 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 parent's calculated price. + description: The calculated price's details. x-schemaName: BaseCalculatedPriceSet required: - id @@ -54548,126 +55508,310 @@ components: is_calculated_price_price_list: type: boolean title: is_calculated_price_price_list - description: The calculated price's is calculated price price list. + description: Whether the calculated price belongs to a price list. is_calculated_price_tax_inclusive: type: boolean title: is_calculated_price_tax_inclusive - description: The calculated price's is calculated price tax inclusive. + description: Whether the calculated price is tax inclusive. calculated_amount: type: number title: calculated_amount - description: The calculated price's calculated amount. + description: The amount of the calculated price, or `null` if there isn't a calculated price. This is the amount shown to the customer. calculated_amount_with_tax: type: number title: calculated_amount_with_tax - description: The calculated price's calculated amount with tax. + description: The calculated price's amount with taxes applied. calculated_amount_without_tax: type: number title: calculated_amount_without_tax - description: The calculated price's calculated amount without tax. + description: The calculated price's amount without taxes applied. is_original_price_price_list: type: boolean title: is_original_price_price_list - description: The calculated price's is original price price list. + description: Whether the original price belongs to a price list. is_original_price_tax_inclusive: type: boolean title: is_original_price_tax_inclusive - description: The calculated price's is original price tax inclusive. + description: Whether the original price is tax inclusive. original_amount: type: number title: original_amount - description: The calculated price's original amount. + description: The amount of the original price, or `null` if there isn't an original price. This amount is useful to compare with the `calculated_amount`, such as to check for discounted value. currency_code: type: string title: currency_code description: The calculated price's currency code. + example: usd calculated_price: type: object description: The calculated price's details. + properties: + id: + type: string + title: id + description: The calculated price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity original_price: type: object - description: The calculated price's original price. + description: The original price's details. + properties: + id: + type: string + title: id + description: The original price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity BaseCapture: type: object - description: The capture's captures. + description: The details of a captured payment. x-schemaName: BaseCapture - BaseCart: - type: object - description: The item's cart. - x-schemaName: BaseCart - BaseCartAddress: - type: object - description: The parent's billing address. - x-schemaName: BaseCartAddress required: - id + - amount - created_at - - updated_at + - payment 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. + description: The payment capture's ID. + amount: + type: number + title: amount + description: The captured amount. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the capture was created. + created_by: + type: string + title: created_by + description: The ID of the user that captured the payment. + payment: + type: object + BaseCart: + type: object + description: The item's cart. + x-schemaName: BaseCart + 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: + type: object + 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 billing address's updated at. + description: The cart's updated at. + original_item_total: + type: number + title: original_item_total + description: The cart's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The cart's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The cart's original item tax total. + item_total: + type: number + title: item_total + description: The cart's item total. + item_subtotal: + type: number + title: item_subtotal + description: The cart's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The cart's item tax total. + original_total: + type: number + title: original_total + description: The cart's original total. + original_subtotal: + type: number + title: original_subtotal + description: The cart's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The cart's original tax total. + total: + type: number + title: total + description: The cart's total. + subtotal: + type: number + title: subtotal + description: The cart's subtotal. + tax_total: + type: number + title: tax_total + description: The cart's tax total. + discount_total: + type: number + title: discount_total + description: The cart's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The cart's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The cart's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The cart's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The cart's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The cart's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. + BaseCartAddress: + type: object + description: The cart's shipping address. + x-schemaName: BaseCartAddress BaseCartLineItem: type: object - description: The item's items. + description: The tax line's item. x-schemaName: BaseCartLineItem required: - id @@ -54708,17 +55852,9 @@ components: 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' + type: number + title: quantity + description: The item's quantity. product: $ref: '#/components/schemas/BaseProduct' product_id: @@ -54783,34 +55919,18 @@ components: 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' + type: number + title: compare_at_unit_price + description: The item's compare at unit price. 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' + type: number + title: unit_price + description: The item's unit price. tax_lines: type: array description: The item's tax lines. items: - $ref: '#/components/schemas/BaseLineItemTaxLine' + type: object adjustments: type: array description: The item's adjustments. @@ -54841,140 +55961,52 @@ components: title: deleted_at description: The item's deleted at. 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' + type: number + title: original_total + description: The item's original total. 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' + type: number + title: original_subtotal + description: The item's original subtotal. 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' + type: number + title: original_tax_total + description: The item's original tax total. 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' + type: number + title: item_total + description: The item's item total. 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' + type: number + title: item_subtotal + description: The item's item subtotal. 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' + type: number + title: item_tax_total + description: The item's item tax total. 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' + type: number + title: total + description: The item's total. 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' + type: number + title: subtotal + description: The item's subtotal. 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' + type: number + title: tax_total + description: The item's tax total. 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' + type: number + title: discount_total + description: The item's discount total. 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' + type: number + title: discount_tax_total + description: The item's discount tax total. BaseCartShippingMethod: type: object - description: The shipping method's shipping methods. + description: A cart's shipping method. x-schemaName: BaseCartShippingMethod required: - id @@ -55000,7 +56032,7 @@ components: cart_id: type: string title: cart_id - description: The shipping method's cart id. + description: The ID of the cart this shipping method belongs to. name: type: string title: name @@ -55010,31 +56042,25 @@ components: 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' + 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. + description: Whether the shipping method's amount is tax inclusive. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: The shipping method's data, useful for fulfillment handling by third-party services. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -55042,122 +56068,54 @@ components: $ref: '#/components/schemas/BaseShippingMethodTaxLine' adjustments: type: array - description: The shipping method's adjustments. + description: The shipping method's adjustments, such as applied promotions. items: $ref: '#/components/schemas/BaseShippingMethodAdjustment' created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. 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' + type: string + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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' + type: string + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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' + type: string + title: original_tax_total + description: The total taxes applied on the shipping method's amount including promotions. 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' + type: string + title: total + description: The shipping method's total amount including taxes and promotions. 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' + type: string + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. 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' + type: string + title: tax_total + description: The total taxes applied on the shipping method's amount including promotions. 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' + type: string + title: discount_total + description: The total amount discounted. 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 + type: string + title: discount_total + description: The taxes applied on the discounted amount. BaseClaimItem: type: object - description: The claim item's claim items. + description: The claim item's details. x-schemaName: BaseClaimItem required: - id @@ -55175,22 +56133,22 @@ components: claim_id: type: string title: claim_id - description: The claim item's claim id. + description: The ID of the claim this item belongs to. order_id: type: string title: order_id - description: The claim item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The claim item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The claim item's quantity. + description: The quantity claimed. reason: type: string - description: The claim item's reason. + description: The claim's reason. enum: - missing_item - wrong_item @@ -55198,59 +56156,83 @@ components: - other raw_quantity: type: object - description: The claim item's raw quantity. + description: The quantity claimed. + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + required: + - value metadata: type: object - description: The claim item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The claim item's created at. + description: The date the claim was created. updated_at: type: string format: date-time title: updated_at - description: The claim item's updated at. + description: The date the claim was updated. BaseCollection: type: object - description: The product's collection. + description: The collection's details. x-schemaName: BaseCollection - BaseCustomer: + BaseCustomerAddress: type: object - description: The customer's details. - x-schemaName: BaseCustomer + description: The customer's address. + x-schemaName: BaseCustomerAddress required: - id - - email - - default_billing_address_id - - default_shipping_address_id - - company_name + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company - first_name - last_name - - addresses + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at properties: id: type: string title: id - description: The customer's ID. - email: + description: The address's ID. + address_name: type: string - title: email - description: The customer's email. - format: email - default_billing_address_id: + title: address_name + description: The address's name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: Whether the address is the default shipping address. + is_default_billing: + type: boolean + title: is_default_billing + description: Whether the address is the default billing address. + customer_id: type: string - title: default_billing_address_id - description: The ID of the address used as the default billing address. - default_shipping_address_id: + title: customer_id + description: The ID of the customer that this address belongs to. + company: type: string - title: default_shipping_address_id - description: The ID of the address used as the default shipping address. - company_name: - type: string - title: company_name - description: The customer's company name. + title: company + description: The customer's company. first_name: type: string title: first_name @@ -55259,44 +56241,51 @@ components: type: string title: last_name description: The customer's last name. - addresses: - type: array - description: The customer's addresses. - items: - $ref: '#/components/schemas/BaseCustomerAddress' + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + 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 customer's phone. + description: The address's phone. metadata: type: object - description: The customer's metadata, used to store custom key-value pairs. - created_by: - type: string - title: created_by - description: The ID of the user that created this customer, if available. + description: The address's metadata, used to store custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The customer's creation date. + description: The address's creation date. updated_at: type: string format: date-time title: updated_at - description: The customer's update date. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The customer's deletion date. - BaseCustomerAddress: - type: object - description: The address's addresses. - x-schemaName: BaseCustomerAddress + description: The address's update date. BaseExchangeItem: type: object - description: The additional item's additional items. + description: The item's details. x-schemaName: BaseExchangeItem required: - id @@ -55310,39 +56299,39 @@ components: id: type: string title: id - description: The additional item's ID. + description: The item's ID. exchange_id: type: string title: exchange_id - description: The additional item's exchange id. + description: The ID of the exchange this item belongs to. order_id: type: string title: order_id - description: The additional item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The additional item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The additional item's quantity. + description: The item's quantity. metadata: type: object - description: The additional item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The additional item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The additional item's updated at. + description: The date the item was updated. BaseFulfillmentProvider: type: object - description: The shipping option's provider. + description: The fulfillment provider's details. x-schemaName: BaseFulfillmentProvider required: - id @@ -55355,22 +56344,369 @@ components: is_enabled: type: boolean title: is_enabled - description: The provider's is enabled. + description: Whether the provider is enabled. BaseLineItemAdjustment: type: object - description: The adjustment's adjustments. + description: The adjustment's details. x-schemaName: BaseLineItemAdjustment + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the cart this adjustment belongs to. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at BaseLineItemTaxLine: type: object - description: The tax line's tax lines. + description: The tax line's details x-schemaName: BaseLineItemTaxLine + properties: + item: + $ref: '#/components/schemas/BaseCartLineItem' + item_id: + type: string + title: item_id + description: The ID of the item the tax line applies on. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the associated tax rate. + code: + type: string + title: code + description: The code the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at BaseOrder: type: object - description: The order change's order. + description: The order's details. x-schemaName: BaseOrder + 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' + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' + customer: + $ref: '#/components/schemas/AdminCustomer' + shipping_address: + $ref: '#/components/schemas/AdminOrderAddress' + billing_address: + $ref: '#/components/schemas/AdminOrderAddress' + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The ID of the region associated with the order. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order is placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: number + title: display_id + description: The order's display ID. + 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 + description: The order's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillment_status: + type: string + description: The order's fulfillment status. + 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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the order's items including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The total of the order's items excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the order's items excluding promotions. + item_total: + type: number + title: item_total + description: The total of the order's items including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The total of the order's items excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order's items including promotions. + original_total: + type: number + title: original_total + description: The order's total excluding promotions, including taxes. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The order's tax total, excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The order's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The order's discount or promotions total. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total of order's discount or promotion. + 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 tax total of the order's gift card. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The tax total of the order's shipping. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The tax total of the order's shipping excluding promotions. BaseOrderAddress: type: object - description: The exchange's billing address. + description: An order address x-schemaName: BaseOrderAddress required: - id @@ -55381,215 +56717,153 @@ components: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer this address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us + country: + $ref: '#/components/schemas/AdminRegionCountry' province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. 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 - description: The order change's change type. - enum: - - return - - exchange - - claim - - edit - - return_request - 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' + description: The date the address was updated. BaseOrderChangeAction: type: object description: The action's actions. x-schemaName: BaseOrderChangeAction + properties: + order_change: + type: object + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change this action belongs to. + order_id: + type: string + title: order_id + description: The ID of the associated order. + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + title: action + description: The applied action. + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the order change action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change action was updated. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: '#/components/schemas/BaseOrder' + required: + - order_change + - id + - order_change_id + - order_id + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at + - return_id + - claim_id + - exchange_id + - order BaseOrderFulfillment: type: object description: The fulfillment's fulfillments. @@ -55615,55 +56889,129 @@ components: location_id: type: string title: location_id - description: The fulfillment's location id. + description: The ID of the location the items are fulfilled from. packed_at: type: string title: packed_at - description: The fulfillment's packed at. + description: The date the items were packed. format: date-time shipped_at: type: string title: shipped_at - description: The fulfillment's shipped at. + description: The date the items were shipped. format: date-time delivered_at: type: string title: delivered_at - description: The fulfillment's delivered at. + description: The date the items were delivered. format: date-time canceled_at: type: string title: canceled_at - description: The fulfillment's canceled at. + description: The date the items were canceled. format: date-time data: type: object - description: The fulfillment's data. + description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property provider_id: type: string title: provider_id - description: The fulfillment's provider id. + description: The ID of the fulfillment provider used to handle the fulfillment. shipping_option_id: type: string title: shipping_option_id - description: The fulfillment's shipping option id. + description: The ID of the associated shipping option. metadata: type: object - description: The fulfillment's metadata. + description: The fulfillment's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The fulfillment's created at. + description: The date the fulfillment was created. updated_at: type: string format: date-time title: updated_at - description: The fulfillment's updated at. + description: The date the fulfillment was updated. BaseOrderItemDetail: type: object description: The item's detail. x-schemaName: BaseOrderItemDetail + required: + - id + - item_id + - item + - quantity + - fulfilled_quantity + - delivered_quantity + - shipped_quantity + - return_requested_quantity + - return_received_quantity + - return_dismissed_quantity + - written_off_quantity + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: the detail's ID. + item_id: + type: string + title: id + description: the ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + delivered_quantity: + type: number + title: fulfilled_quantity + description: The item's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + return_received_quantity: + type: number + title: return_received_quantity + description: The item's quantity that's returned and added to the underlying variant's stocked quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The item's quantity that's returned but damaged. So, it's not added to the underlying variant's stocked quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed from the order. + metadata: + type: object + title: metadata + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the detail was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the detail was updated. BaseOrderLineItem: type: object description: The item's items. @@ -55723,19 +57071,19 @@ components: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The URL of the item's thumbnail. variant: $ref: '#/components/schemas/BaseProductVariant' variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated variant. product: $ref: '#/components/schemas/BaseProduct' product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -55755,7 +57103,7 @@ components: product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the collection the item's product belongs to. product_handle: type: string title: product_handle @@ -55763,7 +57111,7 @@ components: variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -55774,23 +57122,25 @@ components: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The values of the item variant's options. + example: + Color: Blue requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item is tax inclusive. compare_at_unit_price: type: number title: compare_at_unit_price - description: The item's compare at unit price. + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -55815,78 +57165,233 @@ components: type: string format: date-time title: created_at - description: The item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The item's updated at. + description: The date the item was updated. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. original_total: type: number title: original_total - description: The item's original total. + description: The item's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The item's original subtotal. + description: The item's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The item's original tax total. + description: The total taxes of the item, excluding promotions. item_total: type: number title: item_total - description: The item's item total. + description: The total taxes of the item, including promotions. item_subtotal: type: number title: item_subtotal - description: The item's item subtotal. + description: The item's total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The item's item tax total. + description: The total taxes of the item, including promotions. total: type: number title: total - description: The item's total. + description: The item's total, including taxes and promotions. subtotal: type: number title: subtotal - description: The item's subtotal. + description: The item's subtotal excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The item's tax total. + description: The tax total of the item including promotions. discount_total: type: number title: discount_total - description: The item's discount total. + description: The total discount amount of the item. discount_tax_total: type: number title: discount_tax_total - description: The item's discount tax total. + description: The total taxes applied on the discounted amount. refundable_total: type: number title: refundable_total - description: The item's refundable total. + description: The total refundable amount of the item's total. refundable_total_per_unit: type: number title: refundable_total_per_unit - description: The item's refundable total per unit. + description: The total refundable amount of the item's total for a single quantity. BaseOrderLineItemAdjustment: type: object - description: The adjustment's adjustments. + description: The adjustment's details. x-schemaName: BaseOrderLineItemAdjustment + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion that this applies on the order's item. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at BaseOrderLineItemTaxLine: type: object description: The tax line's tax lines. x-schemaName: BaseOrderLineItemTaxLine + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the associated line item. + total: + type: number + title: total + description: The tax line's total including promotions. + subtotal: + type: number + title: subtotal + description: The tax line's subtotal excluding promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + BaseOrderShippingDetail: + type: object + description: Details of changes to a shipping method. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The ID of the new changes to the shipping method. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method. + shipping_method: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + return_id: + type: string + title: return_id + description: The ID of the associated return. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method change was updated. BaseOrderShippingMethod: type: object - description: The shipping method's shipping methods. + description: The shipping method's details. x-schemaName: BaseOrderShippingMethod required: - id @@ -55915,7 +57420,7 @@ components: order_id: type: string title: order_id - description: The shipping method's order id. + description: The ID of the order the shipping method belongs to. name: type: string title: name @@ -55931,17 +57436,19 @@ components: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping method's is tax inclusive. + description: Whether the shipping method's amount includes applied taxes. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: The shipping method's data, useful for fulfillment provider handling its fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -55953,122 +57460,172 @@ components: 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' + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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' + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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' + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. 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' + type: number + title: total + description: The shipping method's total including taxes and promotions. 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' + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. 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' + type: number + title: tax_total + description: The shipping method's tax total including promotions. 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' + type: number + title: discount_total + description: The total discounts applied on the shipping method. 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' + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. + detail: + $ref: '#/components/schemas/BaseOrderShippingDetail' BaseOrderShippingMethodAdjustment: type: object description: The adjustment's adjustments. x-schemaName: BaseOrderShippingMethodAdjustment + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at BaseOrderShippingMethodTaxLine: type: object - description: The tax line's tax lines. + description: The tax line's details. x-schemaName: BaseOrderShippingMethodTaxLine + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider handling the tax calculation. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at BaseOrderSummary: type: object - description: The order's summary. + description: The order's summary details. x-schemaName: BaseOrderSummary required: - total @@ -56079,77 +57636,52 @@ components: - 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. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The summary's subtotal. + description: The order's total excluding taxes, including promotions. total_tax: type: number title: total_tax - description: The summary's total tax. + description: The order's total taxes. ordered_total: type: number title: ordered_total - description: The summary's ordered total. + description: The order's total when it was placed. fulfilled_total: type: number title: fulfilled_total - description: The summary's fulfilled total. + description: The total of the fulfilled items of the order. returned_total: type: number title: returned_total - description: The summary's returned total. + description: The total of the order's returned items. return_request_total: type: number title: return_request_total - description: The summary's return request total. + description: The total of the items requested to be returned. 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. + description: The total of the items removed from the order. paid_total: type: number title: paid_total - description: The summary's paid total. + description: The total amount paid. refunded_total: type: number title: refunded_total - description: The summary's refunded total. + description: The total amount refunded. BaseOrderTransaction: type: object - description: The transaction's transactions. + description: An order transaction's details. x-schemaName: BaseOrderTransaction required: - id @@ -56169,7 +57701,7 @@ components: order_id: type: string title: order_id - description: The transaction's order id. + description: The ID of the order this transaction belongs to. amount: type: number title: amount @@ -56178,34 +57710,127 @@ components: type: string title: currency_code description: The transaction's currency code. + example: usd reference: type: string title: reference - description: The transaction's reference. + description: The name of a table that this transaction references. If this transaction is for captured payment, its value is `capture`. If this transaction is for refunded payment, its value is `refund`. + enum: + - capture + - refund reference_id: type: string title: reference_id - description: The transaction's reference id. + description: The ID of the referenced record in the referenced table. metadata: type: object - description: The transaction's metadata. + description: The transaction's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The transaction's created at. + description: The date that the transaction was created. updated_at: type: string format: date-time title: updated_at - description: The transaction's updated at. + description: The date that the transaction was updated. BasePayment: type: object - description: The payment's payments. + description: The payment's details. x-schemaName: BasePayment + required: + - id + - amount + - currency_code + - provider_id + properties: + id: + type: string + title: id + description: The payment's ID. + amount: + type: number + title: amount + description: The payment's amount. + authorized_amount: + type: number + title: authorized_amount + description: The amount authorized of the payment. + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The ID of the payment provider used to process this payment. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order_edit_id: + type: string + title: order_edit_id + description: The ID of the associated order edit. + customer_id: + type: string + title: customer_id + description: ID of the associated customer. + data: + type: object + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment + created_at: + type: string + format: date-time + title: created_at + description: The date the payment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the payment was updated. + captured_at: + type: string + format: date-time + title: captured_at + description: The date the payment was captured. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. + captured_amount: + type: number + title: captured_amount + description: The captured amount of the payment. + refunded_amount: + type: number + title: captured_amount + description: The refunded amount of the payment. + captures: + type: array + description: The details of payment captures. + items: + $ref: '#/components/schemas/BaseCapture' + refunds: + type: array + description: The details of payment refunds. + items: + $ref: '#/components/schemas/BaseRefund' + payment_collection: + type: object + payment_session: + type: object BasePaymentCollection: type: object - description: The payment collection's payment collections. + description: The payment collection's details. x-schemaName: BasePaymentCollection required: - id @@ -56226,77 +57851,41 @@ components: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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' + type: number + title: amount + description: The total amount to be paid. 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' + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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' + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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' + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -56308,7 +57897,7 @@ components: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: The payment provider used to process the collection's payments and sessions. items: $ref: '#/components/schemas/BasePaymentProvider' payment_sessions: @@ -56325,10 +57914,72 @@ components: type: object description: The payment provider's payment providers. x-schemaName: BasePaymentProvider + required: + - id + properties: + id: + type: string + title: id + description: The payment provider's ID. BasePaymentSession: type: object - description: The payment session's payment sessions. + description: The payment session's details. x-schemaName: BasePaymentSession + properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: The payment session's data, useful for the payment provider processing the payment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: '#/components/schemas/BasePayment' + required: + - id + - amount + - currency_code + - provider_id + - data + - status BaseProduct: type: object description: The parent's product. @@ -56455,7 +58106,7 @@ components: type: array description: The product's variants. items: - $ref: '#/components/schemas/BaseProductVariant' + type: object options: type: array description: The product's options. @@ -56498,34 +58149,62 @@ components: x-schemaName: BaseProductCategory BaseProductImage: type: object - description: The image's images. + description: The image's details. x-schemaName: BaseProductImage - BaseProductOption: - type: object - description: The option's options. - x-schemaName: BaseProductOption - BaseProductOptionValue: - type: object - description: The option's options. - x-schemaName: BaseProductOptionValue + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. required: - id - - value + - url + BaseProductOption: + type: object + description: The product option's details. + x-schemaName: BaseProductOption properties: id: type: string title: id description: The option's ID. - value: + title: type: string - title: value - description: The option's value. - option: - $ref: '#/components/schemas/BaseProductOption' - option_id: + title: title + description: The option's title. + product: + type: object + product_id: type: string - title: option_id - description: The option's option id. + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' metadata: type: object description: The option's metadata. @@ -56544,14 +58223,182 @@ components: format: date-time title: deleted_at description: The option's deleted at. + required: + - id + - title + BaseProductOptionValue: + type: object + description: The product option value's details. + x-schemaName: BaseProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. BaseProductTag: type: object description: The tag's tags. x-schemaName: BaseProductTag BaseProductVariant: type: object - description: The variant's variants. + description: The product variant's details. x-schemaName: BaseProductVariant + required: + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The variant's ID. + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN code. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's out of stock. + manage_inventory: + type: boolean + title: manage_inventory + description: Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. This is only included if you pass in the `fields` query parameter a `+variants.inventory_quantity` parameter. + hs_code: + type: string + title: hs_code + description: The variant's HS code. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + mid_code: + type: string + title: mid_code + description: The variant's MID code. + material: + type: string + title: material + description: The variant's material. + 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. + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its sibling variants. + options: + type: array + description: The variant's option values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The ID of the product that the variant belongs to. + calculated_price: + $ref: '#/components/schemas/BaseCalculatedPriceSet' + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. BasePromotion: type: object description: The application method's promotion. @@ -56594,7 +58441,7 @@ components: $ref: '#/components/schemas/BasePromotionRuleValue' BasePromotionRuleValue: type: object - description: The value's values. + description: The rule value's details. x-schemaName: BasePromotionRuleValue required: - id @@ -56606,14 +58453,49 @@ components: value: type: string title: value - description: The value's details. + description: The value. BaseRefund: type: object - description: The refund's refunds. + description: The refund's details. x-schemaName: BaseRefund + required: + - id + - amount + - created_at + - payment + properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + type: object + refund_reason: + $ref: '#/components/schemas/RefundReason' BaseRegion: type: object - description: The parent's region. + description: The region's details. x-schemaName: BaseRegion required: - id @@ -56661,15 +58543,41 @@ components: description: The region's updated at. BaseRegionCountry: type: object - description: The country's countries. + description: The country's details. x-schemaName: BaseRegionCountry - BaseReturnItem: - type: object - description: The item's items. - x-schemaName: BaseReturnItem + properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. + required: + - id BaseRuleOperatorOptions: type: object - description: The operator's operators. + description: The operator's details. x-schemaName: BaseRuleOperatorOptions required: - id @@ -56680,22 +58588,137 @@ components: type: string title: id description: The operator's ID. + example: in value: type: string title: value description: The operator's value. + example: in label: type: string title: label description: The operator's label. + example: In BaseShippingMethodAdjustment: type: object - description: The adjustment's adjustments. + description: The adjustment's details. x-schemaName: BaseShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method the adjustment is applied on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. BaseShippingMethodTaxLine: type: object - description: The tax line's tax lines. + description: The tax line's details. x-schemaName: BaseShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of this shipping method the tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider that calculated the taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. CampaignResponse: type: object description: The campaign's details. @@ -56771,293 +58794,60 @@ components: description: The budget's used. CreateAddress: type: object - description: The cart's shipping address. + description: The address to create. x-schemaName: CreateAddress properties: customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. - CreateCartAddress: - type: object - description: The cart's billing address. - x-schemaName: CreateCartAddress - properties: - 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. - CreateCartCreateLineItem: - type: object - description: The item's items. - x-schemaName: CreateCartCreateLineItem - required: - - quantity - - variant_id - properties: - quantity: - type: string - title: quantity - description: The item's quantity. - variant_id: - type: string - title: variant_id - description: The item's variant 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. - 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. - is_giftcard: - type: boolean - title: is_giftcard - description: The item's is giftcard. - compare_at_unit_price: - type: string - title: compare_at_unit_price - description: The item's compare at unit price. - unit_price: - type: string - title: unit_price - description: The item's unit price. - 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 - x-schemaName: CreateOrderReturnReason - required: - - value - - label - properties: - 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. - parent_return_reason_id: - type: string - title: parent_return_reason_id - description: The return reason's parent return reason id. - metadata: - type: object - description: The return reason's metadata. + description: The address's metadata, can hold custom key-value pairs. CustomerGroupInCustomerFilters: type: object - description: The customer's groups. + description: Filter by customer groups to get their associated customers. x-schemaName: CustomerGroupInCustomerFilters required: - id @@ -57070,27 +58860,27 @@ components: oneOf: - type: string title: id - description: The group's ID. + description: Filter by a group's ID. - type: array - description: The group's ID. + description: Filter by group IDs. items: type: string title: id - description: The id's ID. + description: A group's ID. name: oneOf: - type: string title: name - description: The group's name. + description: Filter by a group's name. - type: array - description: The group's name. + description: Filter by group names. items: type: string title: name - description: The name's details. + description: A group's name. created_at: type: object - description: The group's created at. + description: Filter by the group's creation date. properties: $and: type: array @@ -57110,7 +58900,7 @@ components: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -57205,7 +58995,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The group's updated at. + description: Filter by the group's update date. properties: $and: type: array @@ -57225,7 +59015,7 @@ components: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -57320,7 +59110,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The group's deleted at. + description: Filter by the group's deletion date. properties: $and: type: array @@ -57340,7 +59130,7 @@ components: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -57467,78 +59257,13 @@ components: - unexpected_state - invalid_argument - unknown_error - File: - type: object - description: The product's file. - x-schemaName: File - required: - - lastModified - - name - - webkitRelativePath - - size - - type - - arrayBuffer - - stream - - text - properties: - lastModified: - type: number - title: lastModified - description: The file's lastmodified. - name: - type: string - title: name - description: The file's name. - webkitRelativePath: - type: string - title: webkitRelativePath - description: The file's webkitrelativepath. - size: - type: number - title: size - description: The file's size. - type: - type: string - title: type - description: The file's type. - arrayBuffer: - type: object - description: The file's arraybuffer. - slice: - type: object - description: The file's slice. - stream: - type: object - description: The file's stream. - text: - type: object - description: The file's text. - FileList: - type: object - description: SUMMARY - x-schemaName: FileList - required: - - length - - item - - __@iterator@258 - properties: - length: - type: number - title: length - description: The upload's length. - item: - type: object - description: The upload's item. - __@iterator@258: - type: object - description: The upload's @iterator@258. IBigNumber: type: object description: The shipping method's discount tax total. x-schemaName: IBigNumber InventoryLevel: type: object - description: The inventory level's inventory levels. + description: The inventory level's details x-schemaName: InventoryLevel required: - id @@ -57556,11 +59281,11 @@ components: inventory_item_id: type: string title: inventory_item_id - description: The inventory level's inventory item id. + description: The ID of the associated inventory item. location_id: type: string title: location_id - description: The inventory level's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity @@ -57579,14 +59304,307 @@ components: description: The inventory level's incoming quantity. metadata: type: object - description: The inventory level's metadata. + description: The inventory level's metadata, can hold custom key-value pairs. Order: type: object - description: The transaction's order. + description: The order change's order. x-schemaName: Order + required: + - id + - version + - status + - currency_code + - 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_subtotal + - 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's ID. + version: + type: number + title: version + description: The order's version. + order_change: + type: object + status: + type: string + description: The order's status. + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The ID of the region the order belongs to. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order was placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + example: usd + shipping_address: + $ref: '#/components/schemas/OrderAddress' + billing_address: + $ref: '#/components/schemas/OrderAddress' + items: + type: array + description: The order's items. + items: + $ref: '#/components/schemas/OrderLineItem' + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: '#/components/schemas/OrderShippingMethod' + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/OrderTransaction' + summary: + type: object + description: The order's summary. + metadata: + type: object + description: The order's metadata, can hold custom key-value pairs. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the order was canceled. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The order items' total including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order items' total excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The taxes total for order items, excluding promotions. + item_total: + type: number + title: item_total + description: The order items' total including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The order items' total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order items including promotions. + original_total: + type: number + title: original_total + description: The order's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the order including promotions. + discount_subtotal: + type: number + title: discount_subtotal + description: The total discount excluding taxes. + discount_total: + type: number + title: discount_total + description: The total discount including taxes. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total applied on the discount. + 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 including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The total taxes of the order's shipping including taxes. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The total taxes of the order's shipping excluding promotions. + raw_original_item_total: + type: object + description: The order's raw original item total. + raw_original_item_subtotal: + type: object + description: The order's raw original item subtotal. + raw_original_item_tax_total: + type: object + description: The order's raw original item tax total. + raw_item_total: + type: object + description: The order's raw item total. + raw_item_subtotal: + type: object + description: The order's raw item subtotal. + raw_item_tax_total: + type: object + description: The order's raw item tax total. + raw_original_total: + type: object + description: The order's raw original total. + raw_original_subtotal: + type: object + description: The order's raw original subtotal. + raw_original_tax_total: + type: object + description: The order's raw original tax total. + raw_total: + type: object + description: The order's raw total. + raw_subtotal: + type: object + description: The order's raw subtotal. + raw_tax_total: + type: object + description: The order's raw tax total. + raw_discount_total: + type: object + description: The order's raw discount total. + raw_discount_tax_total: + type: object + description: The order's raw discount tax total. + raw_gift_card_total: + type: object + description: The order's raw gift card total. + raw_gift_card_tax_total: + type: object + description: The order's raw gift card tax total. + raw_shipping_total: + type: object + description: The order's raw shipping total. + raw_shipping_subtotal: + type: object + description: The order's raw shipping subtotal. + raw_shipping_tax_total: + type: object + description: The order's raw shipping tax total. + raw_original_shipping_total: + type: object + description: The order's raw original shipping total. + raw_original_shipping_subtotal: + type: object + description: The order's raw original shipping subtotal. + raw_original_shipping_tax_total: + type: object + description: The order's raw original shipping tax total. OrderAddress: type: object - description: The order preview's billing address. + description: The address's details. x-schemaName: OrderAddress required: - id @@ -57596,67 +59614,68 @@ components: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The billing address's updated at. + description: The date the address was updated. OrderChange: type: object - description: The order preview's order change. + description: The order change's details. x-schemaName: OrderChange required: - id @@ -57691,10 +59710,10 @@ components: version: type: number title: version - description: The order change's version. + description: The order change's version. This will be the order's version when the change is applied. change_type: type: string - description: The order change's change type. + description: The order change's type. enum: - return - exchange @@ -57703,23 +59722,23 @@ components: order_id: type: string title: order_id - description: The order change's order id. + description: The ID of the order this change applies on. return_id: type: string title: return_id - description: The order change's return id. + description: The ID of the associated return. exchange_id: type: string title: exchange_id - description: The order change's exchange id. + description: The ID of the associated exchange. claim_id: type: string title: claim_id - description: The order change's claim id. + description: The ID of the associated claim. order: type: object return_order: - $ref: '#/components/schemas/Return' + type: object exchange: $ref: '#/components/schemas/OrderExchange' claim: @@ -57731,111 +59750,188 @@ components: $ref: '#/components/schemas/OrderChangeAction' status: type: string - title: status description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined requested_by: type: string title: requested_by - description: The order change's requested by. + description: The ID of the user that requested the change. 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 + type: string + title: requested_at + description: The date the order change was requested. + format: date-time confirmed_by: type: string title: confirmed_by - description: The order change's confirmed by. + description: The ID of the user that confirmed the order change. 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 + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time declined_by: type: string title: declined_by - description: The order change's declined by. + description: The ID of the user that declined the order change. declined_reason: type: string title: declined_reason - description: The order change's declined reason. + description: The reason the order change was declined. metadata: type: object - description: The order change's metadata. + description: The order change's metadata, can hold custom key-value pairs. 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 + type: string + title: declined_at + description: The date the order change was declined. + format: date-time canceled_by: type: string title: canceled_by - description: The order change's canceled by. + description: The ID of the user that canceled the order change. 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 + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time created_at: type: string format: date-time title: created_at - description: The order change's created at. + description: The date the order change was created. updated_at: type: string format: date-time title: updated_at - description: The order change's updated at. + description: The date the order change was updated. OrderChangeAction: type: object - description: The action's actions. + description: The order change action's details. x-schemaName: OrderChangeAction + required: + - id + - order_change_id + - order_change + - order_id + - return_id + - claim_id + - exchange_id + - order + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: '#/components/schemas/Order' + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. 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 - OrderLineItemAdjustment: - type: object - description: The adjustment's adjustments. - x-schemaName: OrderLineItemAdjustment - OrderLineItemTaxLine: - type: object - description: The tax line's tax lines. - x-schemaName: OrderLineItemTaxLine - OrderPreview: - type: object - description: The order edit's order preview. - x-schemaName: OrderPreview required: - - order_change - - status + - order_id + - claim_items + - additional_items - currency_code - - version - 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 @@ -57858,6 +59954,1704 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + properties: + id: + type: string + title: id + description: The claim's ID. + order_id: + type: string + title: order_id + description: The ID of the order associated with the claim. + claim_items: + type: array + description: The order items targetted by the claim. + items: + $ref: '#/components/schemas/BaseClaimItem' + additional_items: + type: array + description: The outbound or new items of the claim. + items: + $ref: '#/components/schemas/BaseClaimItem' + return: + type: object + return_id: + type: string + title: return_id + description: The ID of the associated return. + no_notification: + type: boolean + title: no_notification + description: Whether the customer should be notified about changes in the claim. + refund_amount: + type: number + title: refund_amount + description: The amount to be refunded. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + region_id: + type: string + title: region_id + description: The ID of the region associated with the claim. + customer_id: + type: string + title: customer_id + description: The ID of the customer associated with the claim's order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the claim's order is created in. + email: + type: string + title: email + description: The email associated with the claim's order. + format: email + display_id: + type: number + 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 + description: The claim's payment status. + 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 + description: The claim's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + description: Learn more about transactions of orders and associated models. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The claim's metadata, used to store custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The claim's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's update date. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the associated order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the associated order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the original items in the associated order. + item_total: + type: number + title: item_total + description: The total of the claim's items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the claim's items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the claim's items. + original_total: + type: number + title: original_total + description: The associated order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The associated order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The associated order's original tax total. + total: + type: number + title: total + description: The associated order'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 associated order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The associated order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The associated order's original shipping tax total. + OrderExchange: + type: object + description: The order change's exchange. + x-schemaName: OrderExchange + 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 ID of the order the exchange is created for. + return_items: + type: array + description: The items returned (inbound) by the exchange. + items: + $ref: '#/components/schemas/AdminReturnItem' + additional_items: + type: array + description: The new items (outbound) sent by the exchange. + items: + $ref: '#/components/schemas/BaseExchangeItem' + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer notifications when the exchange is updated. + difference_due: + type: number + title: difference_due + description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. + return: + description: the return associated with the exchange. + $ref: '#/components/schemas/AdminReturn' + return_id: + type: string + title: return_id + description: The ID of the associated exchange. + 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 ID of the associated order's region. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the associated order belongs to. + email: + type: string + title: email + description: The email used when placing the order. + format: email + display_id: + type: number + title: display_id + description: The exchange's display ID. + shipping_address: + description: The shipping address to send new items to. + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + description: The customer's billing address. + $ref: '#/components/schemas/BaseOrderAddress' + shipping_methods: + type: array + description: The shipping methods used to send the new (outbound) items. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + description: The exchange's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments of new (outbound) items. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + description: The exchange's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + description: The totals summary of the exchange. + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The exchange's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date that the exchange was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date that the exchange was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The total tax of the original items in the order. + item_total: + type: number + title: item_total + description: The total of the exchange's new items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the exchange's new items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the exchange's new items. + original_total: + type: number + title: original_total + description: The total of the order. + original_subtotal: + type: number + title: original_subtotal + description: The subtotal of the order. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order. + total: + type: number + title: total + description: The total of the exchange. + subtotal: + type: number + title: subtotal + description: The subtotal of the exchange. + tax_total: + type: number + title: tax_total + description: The tax total of the exchange. + discount_total: + type: number + title: discount_total + description: The discount total of the exchange. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on discount of the exchange. + gift_card_total: + type: number + title: gift_card_total + description: The gift cards total of the exchange. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The total taxes on the gift card of the exchange. + 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 order's shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's shipping tax total. + OrderItem: + type: object + description: The order item's detail. + x-schemaName: OrderItem + required: + - id + - item_id + - item + - quantity + - raw_quantity + - fulfilled_quantity + - raw_fulfilled_quantity + - delivered_quantity + - raw_delivered_quantity + - shipped_quantity + - raw_shipped_quantity + - return_requested_quantity + - raw_return_requested_quantity + - return_received_quantity + - raw_return_received_quantity + - return_dismissed_quantity + - raw_return_dismissed_quantity + - written_off_quantity + - raw_written_off_quantity + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The item's ID. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + raw_fulfilled_quantity: + type: object + description: The item's raw fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The item's delivered quantity. + raw_delivered_quantity: + type: object + description: The item's raw delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + raw_shipped_quantity: + type: object + description: The item's raw shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + raw_return_requested_quantity: + type: object + description: The item's raw return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The item's quantity that's received through a return. + raw_return_received_quantity: + type: object + description: The item's raw return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The item's quantity that's returned but dismissed because it's damaged. + raw_return_dismissed_quantity: + type: object + description: The item's raw return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed due to an order change. + raw_written_off_quantity: + type: object + description: The item's raw written off quantity. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + OrderLineItem: + type: object + description: The order line item's details. + 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 URL. + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the associated product's type. + product_collection: + type: string + title: product_collection + description: The ID of the associated product's 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 associated variant's values for the associated product's options. + example: + Color: Red + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item's price includes taxes. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw compare at unit price's value. + - type: number + title: value + description: The raw compare at unit price's value. + unit_price: + type: number + title: unit_price + description: The item's price for a single quantity. + raw_unit_price: + type: object + description: The item's raw unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw unit price's value. + - type: number + title: value + description: The raw unit price's value. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/OrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/OrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/OrderItem' + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes and promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. + item_total: + type: number + title: item_total + description: The item's total for a single quantity, including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The item's total for a single quantity, excluding taxes and including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of a single quantity of the item, including promotions. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the item, including promotions. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total amount of the item that can be refunded. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total amount that can be refunded of a single quantity of the item. + raw_original_total: + type: object + description: The item'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 item'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 item'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_item_total: + type: object + description: The item'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 item'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 item'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_total: + type: object + description: The item'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 item'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 item'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 item'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 item'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_refundable_total: + type: object + description: The item's raw refundable total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total's value. + - type: number + title: value + description: The raw refundable total's value. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total per unit's value. + - type: number + title: value + description: The raw refundable total per unit's value. + OrderLineItemAdjustment: + type: object + description: The line item adjustment's details. + x-schemaName: OrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + OrderLineItemTaxLine: + type: object + description: The line item tax line's details. + x-schemaName: OrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the line item that the tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax lines. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + OrderReturnItem: + type: object + description: The item's items. + x-schemaName: OrderReturnItem + required: + - id + - quantity + - received_quantity + - damaged_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 received quantity of the item. This quantity is added to the stocked inventory quantity of the item. + damaged_quantity: + type: number + title: damaged_quantity + description: The received damaged quantity of the item, which isn't added to the stocked inventory quantity of the item. + reason_id: + type: string + title: reason_id + description: The ID of the return reason associated with the item. + note: + type: string + title: note + description: A note about why the item was returned. + item_id: + type: string + title: item_id + description: The ID of the associated order item. + return_id: + type: string + title: return_id + description: The ID of the return this return item belongs to. + metadata: + type: object + description: The return item's metadata, can hold custom key-value pairs. + OrderShippingMethod: + type: object + description: The shipping method's details. + 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 ID of the order that the shipping method belongs to. + 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. + raw_amount: + type: object + description: The shipping method's raw amount. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw amount's value. + - type: number + title: value + description: The raw amount's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the shipping method's amount includes taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: The shipping method's data, useful for the fulfillment provider handling the fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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 date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's subtotal excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the shipping method excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the shipping method, including promotions. + discount_total: + type: number + title: discount_total + description: The shipping method's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes of the discount amount. + raw_original_total: + type: object + description: The shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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. + OrderShippingMethodAdjustment: + type: object + description: The shipping method adjustment's details. + x-schemaName: OrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion this adjustment applies. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + OrderShippingMethodTaxLine: + type: object + description: The shipping method tax line's details. + x-schemaName: OrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method that this tax line is for. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + OrderTransaction: + type: object + description: The transaction's details. + x-schemaName: OrderTransaction + 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 ID of the order this transaction belongs to. + amount: + type: number + title: amount + description: The transaction's amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + example: usd + reference: + type: string + title: reference + description: The name of a table that this transaction references. If this transaction is for captured payment, its value is `capture`. If this transaction is for refunded payment, its value is `refund`. + enum: + - capture + - refund + reference_id: + type: string + title: reference_id + description: The ID of the referenced record in the referenced table. + metadata: + type: object + description: The transaction's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date that the transaction was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date that the transaction was updated. + RefundReason: + type: object + description: The refund reason's details. + x-schemaName: RefundReason + 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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund reason was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the refund reason was updated. + RefundReasonResponse: + type: object + description: The refund reason's details. + x-schemaName: RefundReasonResponse + required: + - refund_reason + properties: + refund_reason: + $ref: '#/components/schemas/AdminRefundReason' + Return: + type: object + description: The return's details. + x-schemaName: Return + required: + - id + - status + - order_id + - items + - currency_code + - 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 + - discount_subtotal - raw_original_item_total - raw_original_item_subtotal - raw_original_item_tax_total @@ -57881,1660 +61675,251 @@ components: - raw_original_shipping_subtotal - raw_original_shipping_tax_total properties: - order_change: - $ref: '#/components/schemas/OrderChange' - items: - type: array - description: The order preview's items. - items: - allOf: - - type: object - description: The item's items. - x-schemaName: OrderLineItem - required: - - id - - title - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - - raw_unit_price - - quantity - - raw_quantity - - detail - - created_at - - updated_at - - original_total - - original_subtotal - - original_tax_total - - item_total - - item_subtotal - - item_tax_total - - total - - subtotal - - tax_total - - discount_total - - discount_tax_total - - refundable_total - - refundable_total_per_unit - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_refundable_total - - raw_refundable_total_per_unit - properties: - id: - type: string - title: id - description: The item's ID. - title: - type: string - title: title - description: The item's title. - subtitle: - type: string - title: subtitle - description: The item's subtitle. - thumbnail: - type: string - title: thumbnail - description: The item's thumbnail. - variant_id: - type: string - title: variant_id - description: The item's variant id. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - raw_compare_at_unit_price: - type: object - description: The item's raw compare at unit price. - unit_price: - type: number - title: unit_price - description: The item's unit price. - raw_unit_price: - type: object - description: The item's raw unit price. - quantity: - type: number - title: quantity - description: The item's quantity. - raw_quantity: - type: object - description: The item's raw quantity. - tax_lines: - type: array - description: The item's tax lines. - items: - $ref: '#/components/schemas/OrderLineItemTaxLine' - adjustments: - type: array - description: The item's adjustments. - items: - $ref: '#/components/schemas/OrderLineItemAdjustment' - detail: - $ref: '#/components/schemas/OrderItem' - created_at: - type: string - format: date-time - title: created_at - description: The item's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The item's updated at. - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: '#/components/schemas/IBigNumber' - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The item's original subtotal. - - type: number - title: original_subtotal - description: The item's original subtotal. - - type: string - title: original_subtotal - description: The item's original subtotal. - - $ref: '#/components/schemas/IBigNumber' - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The item's original tax total. - - type: number - title: original_tax_total - description: The item's original tax total. - - type: string - title: original_tax_total - description: The item's original tax total. - - $ref: '#/components/schemas/IBigNumber' - item_total: - oneOf: - - type: string - title: item_total - description: The item's item total. - - type: number - title: item_total - description: The item's item total. - - type: string - title: item_total - description: The item's item total. - - $ref: '#/components/schemas/IBigNumber' - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The item's item subtotal. - - type: number - title: item_subtotal - description: The item's item subtotal. - - type: string - title: item_subtotal - description: The item's item subtotal. - - $ref: '#/components/schemas/IBigNumber' - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The item's item tax total. - - type: number - title: item_tax_total - description: The item's item tax total. - - type: string - title: item_tax_total - description: The item's item tax total. - - $ref: '#/components/schemas/IBigNumber' - total: - oneOf: - - type: string - title: total - description: The item's total. - - type: number - title: total - description: The item's total. - - type: string - title: total - description: The item's total. - - $ref: '#/components/schemas/IBigNumber' - subtotal: - oneOf: - - type: string - title: subtotal - description: The item's subtotal. - - type: number - title: subtotal - description: The item's subtotal. - - type: string - title: subtotal - description: The item's subtotal. - - $ref: '#/components/schemas/IBigNumber' - tax_total: - oneOf: - - type: string - title: tax_total - description: The item's tax total. - - type: number - title: tax_total - description: The item's tax total. - - type: string - title: tax_total - description: The item's tax total. - - $ref: '#/components/schemas/IBigNumber' - discount_total: - oneOf: - - type: string - title: discount_total - description: The item's discount total. - - type: number - title: discount_total - description: The item's discount total. - - type: string - title: discount_total - description: The item's discount total. - - $ref: '#/components/schemas/IBigNumber' - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The item's discount tax total. - - type: number - title: discount_tax_total - description: The item's discount tax total. - - type: string - title: discount_tax_total - description: The item's discount tax total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total: - oneOf: - - type: string - title: refundable_total - description: The item's refundable total. - - type: number - title: refundable_total - description: The item's refundable total. - - type: string - title: refundable_total - description: The item's refundable total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total_per_unit: - oneOf: - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: number - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - $ref: '#/components/schemas/IBigNumber' - raw_original_total: - type: object - description: The item's raw original total. - raw_original_subtotal: - type: object - description: The item's raw original subtotal. - raw_original_tax_total: - type: object - description: The item's raw original tax total. - raw_item_total: - type: object - description: The item's raw item total. - raw_item_subtotal: - type: object - description: The item's raw item subtotal. - raw_item_tax_total: - type: object - description: The item's raw item tax total. - raw_total: - type: object - description: The item's raw total. - raw_subtotal: - type: object - description: The item's raw subtotal. - raw_tax_total: - type: object - description: The item's raw tax total. - raw_discount_total: - type: object - description: The item's raw discount total. - raw_discount_tax_total: - type: object - description: The item's raw discount tax total. - raw_refundable_total: - type: object - description: The item's raw refundable total. - raw_refundable_total_per_unit: - type: object - description: The item's raw refundable total per unit. - - 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: OrderChangeAction - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - allOf: - - 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. - - 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: OrderChangeAction - status: - type: string - description: The order preview's status. - enum: - - canceled - - requires_action - - pending - - completed - - draft - - archived - currency_code: - type: string - title: currency_code - description: The order preview's currency code. - version: - type: number - title: version - description: The order preview's version. id: type: string title: id - description: The order preview's ID. + description: The return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. + order_id: + type: string + title: order_id + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/OrderReturnItem' region_id: type: string title: region_id - description: The order preview's region id. + description: The ID of the region this return belongs to. customer_id: type: string title: customer_id - description: The order preview's customer id. + description: The ID of the customer that placed the order. sales_channel_id: type: string title: sales_channel_id - description: The order preview's sales channel id. + description: The ID of the associated order's sales channel. email: type: string title: email - description: The order preview's email. + description: The email of the customer that placed the order. format: email + currency_code: + type: string + title: currency_code + description: The return's currency code. + example: usd shipping_address: $ref: '#/components/schemas/OrderAddress' billing_address: $ref: '#/components/schemas/OrderAddress' + shipping_methods: + type: array + description: The return's shipping methods. + items: + $ref: '#/components/schemas/OrderShippingMethod' transactions: type: array - description: The order preview's transactions. + description: The return'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 - - pending_difference - - raw_pending_difference - 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 - pending_difference: - oneOf: - - type: string - title: pending_difference - description: The summary's pending difference. - - type: number - title: pending_difference - description: The summary's pending difference. - - type: string - title: pending_difference - description: The summary's pending difference. - - type: object - description: The summary's pending difference. - x-schemaName: IBigNumber - raw_pending_difference: - type: object - description: The summary's raw pending difference. + description: The return's summary. metadata: type: object - description: The order preview's metadata. + description: The return's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The order preview's created at. + description: The date the return was created. updated_at: type: string format: date-time title: updated_at - description: The order preview's updated at. + description: The date the return was updated. 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' + type: number + title: original_item_total + description: The return's original item total. 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' + type: number + title: original_item_subtotal + description: The return's original item subtotal. 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' + type: number + title: original_item_tax_total + description: The return's original item tax total. 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' + type: number + title: item_total + description: The return's item total. 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' + type: number + title: item_subtotal + description: The return's item subtotal. 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' + type: number + title: item_tax_total + description: The return's item tax total. 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' + type: number + title: original_total + description: The return's original total. 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' + type: number + title: original_subtotal + description: The return's original subtotal. 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' + type: number + title: original_tax_total + description: The return's original tax total. 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' + type: number + title: total + description: The return's total. 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' + type: number + title: subtotal + description: The return's subtotal. 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' + type: number + title: tax_total + description: The return's tax total. 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' + type: number + title: discount_total + description: The return's discount total. 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' + type: number + title: discount_tax_total + description: The return's discount tax total. 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' + type: number + title: gift_card_total + description: The return's gift card total. 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' + type: number + title: gift_card_tax_total + description: The return's gift card tax total. 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' + type: number + title: shipping_total + description: The return's shipping total. 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' + type: number + title: shipping_subtotal + description: The return's shipping subtotal. 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' + type: number + title: shipping_tax_total + description: The return's shipping tax total. 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' + type: number + title: original_shipping_total + description: The return's original shipping total. 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' + type: number + title: original_shipping_subtotal + description: The return's original shipping subtotal. 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' + type: number + title: original_shipping_tax_total + description: The return's original shipping tax total. + order_change: + $ref: '#/components/schemas/OrderChange' 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 + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time + discount_subtotal: + type: number + title: discount_subtotal + description: The return's discount subtotal. 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. + description: The return's raw original item total. 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. + description: The return's raw original item subtotal. 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. + description: The return's raw original item tax total. 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. + description: The return's raw item total. 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. + description: The return's raw item subtotal. 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. + description: The return's raw item tax total. 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. + description: The return's raw original total. 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. + description: The return's raw original subtotal. 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. + description: The return's raw original tax total. 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. + description: The return's raw total. 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. + description: The return's raw subtotal. 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. + description: The return's raw tax total. 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. + description: The return's raw discount total. 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. + description: The return's raw discount tax total. 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. + description: The return's raw gift card total. 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. + description: The return's raw gift card tax total. 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. + description: The return's raw shipping total. 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. + description: The return's raw shipping subtotal. 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. + description: The return's raw shipping tax total. 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. + description: The return's raw original shipping total. 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. + description: The return's raw original shipping subtotal. 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. - 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 + description: The return's raw original shipping tax total. StoreAddCartLineItem: type: object - description: SUMMARY + description: The details of the line item to add. x-schemaName: StoreAddCartLineItem required: - variant_id @@ -59543,30 +61928,21 @@ components: variant_id: type: string title: variant_id - description: The cart's variant id. + description: The ID of the product variant to add to the cart. quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. - StoreCalculateCartTaxes: - type: object - description: SUMMARY - x-schemaName: StoreCalculateCartTaxes - properties: - fields: - type: string - title: fields - description: The cart's fields. + description: The item's metadata, can hold custom key-value pairs. StoreCart: type: object - description: The cart's parent. + description: The cart's details. x-schemaName: StoreCart required: - - id - currency_code + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -59593,326 +61969,151 @@ components: id: type: string title: id - description: The parent's ID. + description: The cart's ID. region: - $ref: '#/components/schemas/BaseRegion' + $ref: '#/components/schemas/StoreRegion' region_id: type: string title: region_id - description: The parent's region id. + description: The ID of the region the cart belongs to. customer_id: type: string title: customer_id - description: The parent's customer id. + description: The ID of the customer the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The parent's sales channel id. + description: The ID of the cart's sales channel. Only products that belong to the same sales channel can be added to the cart. The created order will be associated with the same sales channel. email: type: string title: email - description: The parent's email. + description: The email of the customer the cart belongs to. format: email currency_code: type: string title: currency_code - description: The parent's currency code. + description: The cart's currency code. + example: usd shipping_address: - $ref: '#/components/schemas/BaseCartAddress' + $ref: '#/components/schemas/StoreCartAddress' billing_address: - $ref: '#/components/schemas/BaseCartAddress' + $ref: '#/components/schemas/StoreCartAddress' items: type: array - description: The parent's items. + description: The cart's items. items: - $ref: '#/components/schemas/BaseCartLineItem' + $ref: '#/components/schemas/StoreCartLineItem' shipping_methods: type: array - description: The parent's shipping methods. + description: The cart's shipping methods. items: - $ref: '#/components/schemas/BaseCartShippingMethod' + $ref: '#/components/schemas/StoreCartShippingMethod' payment_collection: - $ref: '#/components/schemas/BasePaymentCollection' + $ref: '#/components/schemas/StorePaymentCollection' metadata: type: object - description: The parent's metadata. + description: The cart's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the cart was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the cart was updated. original_item_total: - oneOf: - - type: string - title: original_item_total - description: The parent's original item total. - - type: number - title: original_item_total - description: The parent's original item total. - - type: string - title: original_item_total - description: The parent's original item total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_item_total + description: The cart items' total including taxes, excluding promotions. original_item_subtotal: - oneOf: - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - type: number - title: original_item_subtotal - description: The parent's original item subtotal. - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_item_subtotal + description: The cart items' total excluding taxes, including promotions. original_item_tax_total: - oneOf: - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - type: number - title: original_item_tax_total - description: The parent's original item tax total. - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_item_tax_total + description: The cart items' tax total excluding promotions. item_total: - oneOf: - - type: string - title: item_total - description: The parent's item total. - - type: number - title: item_total - description: The parent's item total. - - type: string - title: item_total - description: The parent's item total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: item_total + description: The cart items' total including taxes and promotions. item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The parent's item subtotal. - - type: number - title: item_subtotal - description: The parent's item subtotal. - - type: string - title: item_subtotal - description: The parent's item subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: item_subtotal + description: The cart items' total excluding taxes, including promotions. item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The parent's item tax total. - - type: number - title: item_tax_total - description: The parent's item tax total. - - type: string - title: item_tax_total - description: The parent's item tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: item_tax_total + description: The cart items' tax total including promotions. original_total: - oneOf: - - type: string - title: original_total - description: The parent's original total. - - type: number - title: original_total - description: The parent's original total. - - type: string - title: original_total - description: The parent's original total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_total + description: The cart's total including taxes, excluding promotions. original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The parent's original subtotal. - - type: number - title: original_subtotal - description: The parent's original subtotal. - - type: string - title: original_subtotal - description: The parent's original subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_subtotal + description: The cart's total excluding taxes, including promotions. original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The parent's original tax total. - - type: number - title: original_tax_total - description: The parent's original tax total. - - type: string - title: original_tax_total - description: The parent's original tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_tax_total + description: The cart's tax total excluding promotions. total: - oneOf: - - type: string - title: total - description: The parent's total. - - type: number - title: total - description: The parent's total. - - type: string - title: total - description: The parent's total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: total + description: The cart's total including taxes and promotions. subtotal: - oneOf: - - type: string - title: subtotal - description: The parent's subtotal. - - type: number - title: subtotal - description: The parent's subtotal. - - type: string - title: subtotal - description: The parent's subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: subtotal + description: The cart's total excluding taxes, including promotions. tax_total: - oneOf: - - type: string - title: tax_total - description: The parent's tax total. - - type: number - title: tax_total - description: The parent's tax total. - - type: string - title: tax_total - description: The parent's tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: tax_total + description: The cart's tax total including promotions. discount_total: - oneOf: - - type: string - title: discount_total - description: The parent's discount total. - - type: number - title: discount_total - description: The parent's discount total. - - type: string - title: discount_total - description: The parent's discount total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: discount_total + description: The cart's discount total. discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - type: number - title: discount_tax_total - description: The parent's discount tax total. - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: discount_tax_total + description: The tax total applied on the discounted amount. gift_card_total: - oneOf: - - type: string - title: gift_card_total - description: The parent's gift card total. - - type: number - title: gift_card_total - description: The parent's gift card total. - - type: string - title: gift_card_total - description: The parent's gift card total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: gift_card_total + description: The total gift card amount applied on the cart. gift_card_tax_total: - oneOf: - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: number - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: gift_card_tax_total + description: The total taxes applied on the gift card amount. shipping_total: - oneOf: - - type: string - title: shipping_total - description: The parent's shipping total. - - type: number - title: shipping_total - description: The parent's shipping total. - - type: string - title: shipping_total - description: The parent's shipping total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: shipping_total + description: The cart's shipping total including taxes and promotions. shipping_subtotal: - oneOf: - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: number - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. shipping_tax_total: - oneOf: - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - type: number - title: shipping_tax_total - description: The parent's shipping tax total. - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: shipping_tax_total + description: The total taxes applied on the cart's shipping amount. original_shipping_total: - oneOf: - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - type: number - title: original_shipping_total - description: The parent's original shipping total. - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_shipping_total + description: The cart's shipping total including taxes, excluding promotions. original_shipping_subtotal: - oneOf: - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: number - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. original_shipping_tax_total: - oneOf: - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: number - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_shipping_tax_total + description: The total taxes applied on the cart's shipping amount. StoreCartAddress: type: object - description: The cart's billing address. + description: The address's details. x-schemaName: StoreCartAddress required: - id @@ -59922,97 +62123,90 @@ components: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: - oneOf: - - type: string - title: created_at - description: The billing address's created at. - - type: string - title: created_at - description: The billing address's created at. - format: date-time + type: string + title: created_at + description: The date the address was created. + format: date-time updated_at: - oneOf: - - type: string - title: updated_at - description: The billing address's updated at. - - type: string - title: updated_at - description: The billing address's updated at. - format: date-time + type: string + title: updated_at + description: The date the address was updated. + format: date-time StoreCartLineItem: type: object - description: The item's items. + description: The item's details. x-schemaName: StoreCartLineItem required: - - id - - title - - quantity - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - cart - - cart_id - - original_total - - original_subtotal - - original_tax_total + - title + - id - item_total - item_subtotal - item_tax_total + - original_total + - original_subtotal + - original_tax_total - total - subtotal - tax_total - discount_total - discount_tax_total + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - cart_id properties: id: type: string @@ -60029,25 +62223,17 @@ components: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The item's thumbnail URL. 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' + type: number + title: quantity + description: The item's quantity. product: - $ref: '#/components/schemas/BaseProduct' + $ref: '#/components/schemas/StoreProduct' product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -60063,25 +62249,25 @@ components: product_type: type: string title: product_type - description: The item's product type. + description: The ID of the associated product's type. product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the associated product's collection. product_handle: type: string title: product_handle description: The item's product handle. variant: - $ref: '#/components/schemas/BaseProductVariant' + $ref: '#/components/schemas/StoreProductVariant' variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -60092,230 +62278,517 @@ components: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The associated variant's value for the product's options. + example: + Color: Red requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item's price includes taxes. 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' + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. 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' + type: number + title: unit_price + description: The price of a single quantity of the item. tax_lines: type: array description: The item's tax lines. items: - $ref: '#/components/schemas/BaseLineItemTaxLine' + allOf: + - type: object + description: The tax line's details. + x-schemaName: BaseLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + item_id: + type: string + title: item_id + description: The ID of the line item this tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + description: The tax line's details adjustments: type: array description: The item's adjustments. items: - $ref: '#/components/schemas/BaseLineItemAdjustment' + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseLineItemAdjustment + required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + item_id: + type: string + title: item_id + description: The ID of the item that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + description: The adjustment's details. cart: - $ref: '#/components/schemas/BaseCart' + type: object cart_id: type: string title: cart_id - description: The item's cart id. + description: The ID of the cart that the line item belongs to. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string title: created_at - description: The item's created at. + description: The date the item was created. format: date-time updated_at: type: string title: updated_at - description: The item's updated at. + description: The date the item was updated. format: date-time deleted_at: type: string title: deleted_at - description: The item's deleted at. + description: The date the item was deleted. 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' + type: number + title: original_total + description: The item's total including taxes, excluding promotions. 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' + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. 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' + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. 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' + type: number + title: original_tax_total + description: The item's total including taxes and promotions. 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' + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. 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' + type: number + title: item_tax_total + description: The total taxes of the item including promotions. 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' + type: number + title: total + description: The item's total including taxes and promotions. 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' + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. 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' + type: number + title: tax_total + description: The total taxes of the item including promotions. 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' + type: number + title: discount_total + description: The total discount of the item. 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' + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. StoreCartResponse: type: object - description: SUMMARY + description: The cart's details. x-schemaName: StoreCartResponse required: - cart properties: cart: $ref: '#/components/schemas/StoreCart' + StoreCartShippingMethod: + type: object + description: A cart's shipping method. + x-schemaName: StoreCartShippingMethod + 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 ID of the cart this shipping method belongs to. + 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: Whether the shipping method's amount is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: The shipping method's data, useful for fulfillment handling by third-party services. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's details + x-schemaName: BaseShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments, such as applied promotions. + items: + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + description: The adjustment's details. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes applied on the shipping method's amount including promotions. + total: + type: number + title: total + description: The shipping method's total amount including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes applied on the shipping method's amount including promotions. + discount_total: + type: number + title: discount_total + description: The total amount discounted. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discounted amount. StoreCollection: type: object description: The collection's details. x-schemaName: StoreCollection required: - - id - title + - metadata + - id - handle - created_at - updated_at - deleted_at - - metadata properties: id: type: string @@ -60333,28 +62806,28 @@ components: type: string format: date-time title: created_at - description: The collection's created at. + description: The date the collection was created. updated_at: type: string format: date-time title: updated_at - description: The collection's updated at. + description: The date the collection was updated. deleted_at: type: string format: date-time title: deleted_at - description: The collection's deleted at. + description: The date the collection was deleted. products: type: array description: The collection's products. items: - $ref: '#/components/schemas/AdminProduct' + type: object metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. StoreCollectionResponse: type: object - description: SUMMARY + description: The collection's details. x-schemaName: StoreCollectionResponse required: - collection @@ -60363,13 +62836,13 @@ components: $ref: '#/components/schemas/StoreCollection' StoreCreateCart: type: object - description: SUMMARY + description: The details of the cart to be created. x-schemaName: StoreCreateCart properties: region_id: type: string title: region_id - description: The cart's region id. + description: The ID of the cart's region. This affects the prices and currency of the cart. shipping_address: $ref: '#/components/schemas/StoreCartAddress' billing_address: @@ -60377,12 +62850,13 @@ components: email: type: string title: email - description: The cart's email. + description: The email of the cart's customer. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: The cart's currency code. If not provided, the region's currency is used. This affects prices in the cart, as well. + example: usd items: type: array description: The cart's items. @@ -60391,13 +62865,13 @@ components: sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The ID of the sales channel that cart is created in. Only products available in that sales channel can be added to the cart. If not provided, the store's default sales channel is associated with the cart instead. metadata: type: object - description: The cart's metadata. + description: The cart's metadata, can hold custom key-value pairs. StoreCreateCustomer: type: object - description: SUMMARY + description: The details of the customer to create. x-schemaName: StoreCreateCustomer required: - email @@ -60425,10 +62899,10 @@ components: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. StoreCreatePaymentCollection: type: object - description: SUMMARY + description: The details of the payment collection to create. x-schemaName: StoreCreatePaymentCollection required: - cart_id @@ -60436,10 +62910,10 @@ components: cart_id: type: string title: cart_id - description: The payment collection's cart id. + description: The ID of the cart this payment collection is for. StoreCreateReturn: type: object - description: SUMMARY + description: The details of the return to create. x-schemaName: StoreCreateReturn required: - order_id @@ -60449,7 +62923,7 @@ components: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. items: type: array description: The return's items. @@ -60460,18 +62934,18 @@ components: note: type: string title: note - description: The return's note. + description: A note with more details about the return. receive_now: type: boolean title: receive_now - description: The return's receive now. + description: Whether to mark the return as received. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location that items are returned to. StoreCreateReturnItem: type: object - description: The item's items. + description: The details of the line item to create. x-schemaName: StoreCreateReturnItem required: - id @@ -60488,14 +62962,14 @@ components: reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. note: type: string title: note - description: The item's note. + description: A note with more details about the returned item. StoreCreateReturnShipping: type: object - description: The return's return shipping. + description: The return's shipping details. x-schemaName: StoreCreateReturnShipping required: - option_id @@ -60503,11 +62977,11 @@ components: option_id: type: string title: option_id - description: The return shipping's option id. + description: The ID of the shipping option to use. price: type: number title: price - description: The return shipping's price. + description: The shipping's price. StoreCurrency: type: object description: The currency's details. @@ -60519,7 +62993,6 @@ components: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at @@ -60528,6 +63001,7 @@ components: type: string title: code description: The currency's code. + example: usd symbol: type: string title: symbol @@ -60548,39 +63022,24 @@ components: 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. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The currency's deleted at. + description: The date the currency was deleted. StoreCurrencyListResponse: type: object - description: SUMMARY + description: The paginated list of currencies. x-schemaName: StoreCurrencyListResponse required: - limit @@ -60591,23 +63050,23 @@ components: limit: type: number title: limit - description: The currency's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The currency's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The currency's count. + description: The total count of items. currencies: type: array - description: The currency's currencies. + description: The list of currencies. items: $ref: '#/components/schemas/StoreCurrency' StoreCurrencyResponse: type: object - description: SUMMARY + description: The currency's details. x-schemaName: StoreCurrencyResponse required: - currency @@ -60616,81 +63075,77 @@ components: $ref: '#/components/schemas/StoreCurrency' StoreCustomer: type: object - description: The customer's parent. + description: The customer's details. x-schemaName: StoreCustomer required: + - addresses - id - email - - default_billing_address_id - - default_shipping_address_id - company_name - first_name - last_name - - addresses + - default_billing_address_id + - default_shipping_address_id properties: id: type: string title: id - description: The parent's ID. + description: The customer's ID. email: type: string title: email - description: The parent's email. + description: The customer's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The parent's default billing address id. + description: The ID of the address used for billing by default. default_shipping_address_id: type: string title: default_shipping_address_id - description: The parent's default shipping address id. + description: The ID of the address used for shipping by default. company_name: type: string title: company_name - description: The parent's company name. + description: The customer's company name. first_name: type: string title: first_name - description: The parent's first name. + description: The customer's first name. last_name: type: string title: last_name - description: The parent's last name. + description: The customer's last name. addresses: type: array - description: The parent's addresses. + description: The customer's addresses. items: - $ref: '#/components/schemas/BaseCustomerAddress' + $ref: '#/components/schemas/StoreCustomerAddress' phone: type: string title: phone - description: The parent's phone. + description: The customer's phone. metadata: type: object - description: The parent's metadata. - created_by: - type: string - title: created_by - description: The parent's created by. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + description: The customer's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the customer was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the customer was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the customer was deleted. StoreCustomerAddress: type: object - description: The customer's address. + description: The customer address's details x-schemaName: StoreCustomerAddress required: - id @@ -60719,19 +63174,19 @@ components: address_name: type: string title: address_name - description: The address's address name. + description: The address's name. is_default_shipping: type: boolean title: is_default_shipping - description: The address's is default shipping. + description: Whether the address is used for shipping by default. is_default_billing: type: boolean title: is_default_billing - description: The address's is default billing. + description: Whether the address is used for billing by default. customer_id: type: string title: customer_id - description: The address's customer id. + description: The ID of the customer the address belongs to. company: type: string title: company @@ -60747,11 +63202,11 @@ components: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. city: type: string title: city @@ -60760,6 +63215,7 @@ components: type: string title: country_code description: The address's country code. + example: usd province: type: string title: province @@ -60774,20 +63230,20 @@ components: description: The address's phone. metadata: type: object - description: The address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The address's updated at. + description: The date the address was updated. StoreCustomerAddressListResponse: type: object - description: SUMMARY + description: The paginated list of customer addresses. x-schemaName: StoreCustomerAddressListResponse required: - limit @@ -60798,23 +63254,23 @@ components: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The customer's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer's count. + description: The total number of items. addresses: type: array - description: The customer's addresses. + description: The list of addresses. items: $ref: '#/components/schemas/StoreCustomerAddress' StoreCustomerAddressResponse: type: object - description: SUMMARY + description: The address's details. x-schemaName: StoreCustomerAddressResponse required: - address @@ -60823,7 +63279,7 @@ components: $ref: '#/components/schemas/StoreCustomerAddress' StoreCustomerResponse: type: object - description: SUMMARY + description: The customer's details. x-schemaName: StoreCustomerResponse required: - customer @@ -60832,7 +63288,7 @@ components: $ref: '#/components/schemas/StoreCustomer' StoreOrder: type: object - description: The cart's order. + description: The order's details. x-schemaName: StoreOrder required: - id @@ -60884,28 +63340,29 @@ components: region_id: type: string title: region_id - description: The order's region id. + description: The ID of the associated region. customer_id: type: string title: customer_id - description: The order's customer id. + description: The ID of the customer that placed the order. sales_channel_id: type: string title: sales_channel_id - description: The order's sales channel id. + description: The ID of the sales channel the order was placed in. email: type: string title: email - description: The order's email. + description: The email of the customer that placed the order. format: email currency_code: type: string title: currency_code description: The order's currency code. + example: usd display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. shipping_address: $ref: '#/components/schemas/BaseOrderAddress' billing_address: @@ -60956,74 +63413,69 @@ components: - 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. + description: The order's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The order's created at. + description: The date the order was created. updated_at: type: string format: date-time title: updated_at - description: The order's updated at. + description: The date the order was updated. original_item_total: type: number title: original_item_total - description: The order's original item total. + description: The order items' total including taxes, excluding promotions. original_item_subtotal: type: number title: original_item_subtotal - description: The order's original item subtotal. + description: The order items' total excluding taxes, including promotions. original_item_tax_total: type: number title: original_item_tax_total - description: The order's original item tax total. + description: The total taxes applied on the order items, excluding promotions. item_total: type: number title: item_total - description: The order's item total. + description: The order items' total including taxes and promotions. item_subtotal: type: number title: item_subtotal - description: The order's item subtotal. + description: The order items' total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The order's item tax total. + description: The total taxes applied on the order's items, including promotions. original_total: type: number title: original_total - description: The order's original total. + description: The order's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The order's original subtotal. + description: The order's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The order's original tax total. + description: The total taxes of the order excluding promotions. total: type: number title: total - description: The order's total. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The order's subtotal. + description: The order's total excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The order's tax total. + description: The tax totals of the order including promotions. discount_total: type: number title: discount_total @@ -61031,7 +63483,7 @@ components: discount_tax_total: type: number title: discount_tax_total - description: The order's discount tax total. + description: The total taxes applied on the discounted amount. gift_card_total: type: number title: gift_card_total @@ -61039,34 +63491,34 @@ components: gift_card_tax_total: type: number title: gift_card_tax_total - description: The order's gift card tax total. + description: The total taxes applied on the gift card's amount. shipping_total: type: number title: shipping_total - description: The order's shipping total. + description: The order's shipping total including taxes and promotions. shipping_subtotal: type: number title: shipping_subtotal - description: The order's shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. shipping_tax_total: type: number title: shipping_tax_total - description: The order's shipping tax total. + description: The total taxes of the order's shipping including promotions. original_shipping_total: type: number title: original_shipping_total - description: The order's original shipping total. + description: The order's shipping total including taxes, excluding promotions. original_shipping_subtotal: type: number title: original_shipping_subtotal - description: The order's original shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. original_shipping_tax_total: type: number title: original_shipping_tax_total - description: The order's original shipping tax total. + description: The total taxes of the order's shipping excluding promotions. StoreOrderResponse: type: object - description: SUMMARY + description: The order's details. x-schemaName: StoreOrderResponse required: - order @@ -61078,12 +63530,12 @@ components: description: The payment collection's details. x-schemaName: StorePaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -61096,77 +63548,41 @@ components: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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' + type: number + title: amount + description: The total amount to be paid. 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' + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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' + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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' + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -61178,14 +63594,14 @@ components: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: The payment provider used to process the collection's payments and sessions. items: - $ref: '#/components/schemas/BasePaymentProvider' + $ref: '#/components/schemas/StorePaymentProvider' payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: '#/components/schemas/BasePaymentSession' + $ref: '#/components/schemas/StorePaymentSession' payments: type: array description: The payment collection's payments. @@ -61193,7 +63609,7 @@ components: $ref: '#/components/schemas/BasePayment' StorePaymentCollectionResponse: type: object - description: SUMMARY + description: The payment collection's details. x-schemaName: StorePaymentCollectionResponse required: - payment_collection @@ -61202,7 +63618,7 @@ components: $ref: '#/components/schemas/StorePaymentCollection' StorePaymentProvider: type: object - description: The payment provider's payment providers. + description: The payment provider's details x-schemaName: StorePaymentProvider required: - id @@ -61211,20 +63627,78 @@ components: type: string title: id description: The payment provider's ID. + StorePaymentSession: + type: object + description: The payment session's details. + x-schemaName: StorePaymentSession + properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: The payment session's data, useful for the payment provider processing the payment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: '#/components/schemas/BasePayment' + required: + - id + - amount + - currency_code + - provider_id + - data + - status StoreProduct: type: object description: The product's details. x-schemaName: StoreProduct required: + - variants + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - - variants - handle - subtitle - is_giftcard @@ -61238,9 +63712,10 @@ components: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: categories: @@ -61270,7 +63745,7 @@ components: type: array description: The product's options. items: - $ref: '#/components/schemas/BaseProductOption' + $ref: '#/components/schemas/StoreProductOption' description: type: string title: description @@ -61281,22 +63756,22 @@ components: description: The product's ID. metadata: type: object - description: The product's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The product's updated at. + description: The date the product was updated. variants: type: array description: The product's variants. items: - $ref: '#/components/schemas/BaseProductVariant' + $ref: '#/components/schemas/StoreProductVariant' handle: type: string title: handle @@ -61308,11 +63783,11 @@ components: is_giftcard: type: boolean title: is_giftcard - description: The product's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The product's thumbnail. + description: The product's thumbnail URL. width: type: number title: width @@ -61332,59 +63807,57 @@ components: hs_code: type: string title: hs_code - description: The product's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The product's mid code. + description: The product's MID code. material: type: string title: material description: The product's material. collection: - $ref: '#/components/schemas/BaseCollection' + $ref: '#/components/schemas/StoreCollection' collection_id: type: string title: collection_id - description: The product's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The product's type id. + description: The ID of the product's type. tags: type: array description: The product's tags. items: - $ref: '#/components/schemas/BaseProductTag' + $ref: '#/components/schemas/StoreProductTag' images: type: array description: The product's images. items: - $ref: '#/components/schemas/BaseProductImage' + $ref: '#/components/schemas/StoreProductImage' discountable: type: boolean title: discountable - description: The product's discountable. + description: Whether the product can be discounted. external_id: type: string title: external_id - description: The product's external id. + description: The ID of the product in an external service or system. deleted_at: type: string format: date-time title: deleted_at - description: The product's deleted at. + description: The date the product was deleted. StoreProductCategory: type: object - description: The category's categories. + description: The category's details. x-schemaName: StoreProductCategory required: - id - name - description - handle - - is_active - - is_internal - rank - parent_category_id - parent_category @@ -61414,14 +63887,6 @@ components: type: string title: handle description: The category's handle. - 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 @@ -61429,35 +63894,35 @@ components: parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. parent_category: - $ref: '#/components/schemas/BaseProductCategory' + type: object category_children: type: array - description: The category's category children. + description: The category's children. items: - $ref: '#/components/schemas/BaseProductCategory' + type: object metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. StoreProductCategoryListResponse: type: object - description: SUMMARY + description: The paginated list of product categories. x-schemaName: StoreProductCategoryListResponse required: - limit @@ -61468,111 +63933,328 @@ components: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: '#/components/schemas/StoreProductCategory' StoreProductCategoryResponse: type: object - description: SUMMARY + description: The product category's details. x-schemaName: StoreProductCategoryResponse required: - product_category properties: product_category: $ref: '#/components/schemas/StoreProductCategory' + StoreProductImage: + type: object + description: The image's details. + x-schemaName: StoreProductImage + required: + - id + - url + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. + StoreProductOption: + type: object + description: The product option's details. + x-schemaName: StoreProductOption + properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The ID of the product this option belongs to. + values: + type: array + description: The option's values. + items: + $ref: '#/components/schemas/StoreProductOptionValue' + metadata: + type: object + description: The option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the product option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the product option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the product option was deleted. + required: + - title + - id + StoreProductOptionValue: + type: object + description: The product option value's details. + x-schemaName: StoreProductOptionValue + required: + - value + - id + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. StoreProductResponse: type: object - description: SUMMARY + description: The product's details. x-schemaName: StoreProductResponse required: - product properties: product: $ref: '#/components/schemas/StoreProduct' - StoreProductVariantParams: + StoreProductTag: type: object - description: The product's variants. - x-schemaName: StoreProductVariantParams + description: The tag's details. + x-schemaName: StoreProductTag properties: - q: - type: string - title: q - description: The variant's q. id: - oneOf: - - type: string - title: id - description: The variant's ID. - - type: array - description: The variant's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The date the tag was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tag was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the tag was deleted. + metadata: type: object + description: The tag's metadata, can hold custom key-value pairs. + required: + - id + - value + - created_at + - updated_at + StoreProductVariant: + type: object + description: The variant's details. + x-schemaName: StoreProductVariant + properties: + options: + type: array description: The variant's options. - limit: - type: number - title: limit - description: The variant's limit. - offset: - type: number - title: offset - description: The variant's offset. - order: - type: string - title: order - description: The variant's order. - fields: - type: string - title: fields - description: The variant's fields. - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or + $ref: '#/components/schemas/StoreProductOptionValue' + product: + type: object + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. + id: + type: string + title: id + description: The variant's ID. + width: + type: number + title: width + description: The variant's width. + weight: + type: number + title: weight + description: The variant's weight. + height: + type: number + title: height + description: The variant's height. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + 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. + material: + type: string + title: material + description: The variant's material. + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + product_id: + type: string + title: product_id + description: The ID of the product this variant belongs to. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's not in stock. + manage_inventory: + type: boolean + title: manage_inventory + description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock. + externalDocs: + url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter. + externalDocs: + url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its siblings. + calculated_price: + $ref: '#/components/schemas/BaseCalculatedPriceSet' + required: + - options + - length + - title + - id + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - created_at + - updated_at + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory StoreRegion: type: object description: The region's details. @@ -61594,10 +64276,11 @@ components: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are calculated automatically during checkout for carts that belong to this region. countries: type: array description: The region's countries. @@ -61610,30 +64293,62 @@ components: $ref: '#/components/schemas/AdminPaymentProvider' metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. + StoreRegionCountry: + type: object + description: The country's details. + x-schemaName: StoreRegionCountry + required: + - id + properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's ISO 2 code. + example: us + iso_3: + type: string + title: iso_3 + description: The country's ISO 3 codel. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. StoreReturn: type: object description: The return's details. x-schemaName: StoreReturn required: - - id - - order_id - - order_version - - display_id - items - - received_at + - order_id + - id - created_at + - display_id - canceled_at + - received_at properties: id: type: string @@ -61642,7 +64357,7 @@ components: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. status: type: string title: status @@ -61650,49 +64365,88 @@ components: exchange_id: type: string title: exchange_id - description: The return's exchange id. + description: The ID of the associated exchange. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. 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. + description: The ID of the associated claim. 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. + description: The return's display ID. refund_amount: type: number title: refund_amount - description: The return's refund amount. + description: The return's refunded amount. items: type: array description: The return's items. items: - $ref: '#/components/schemas/BaseReturnItem' + $ref: '#/components/schemas/StoreReturnItem' received_at: type: string title: received_at - description: The return's received at. + description: The date the return was received. created_at: type: string format: date-time title: created_at - description: The return's created at. + description: The date the return was created. canceled_at: type: string title: canceled_at - description: The return's canceled at. + description: The date the return was updated. + StoreReturnItem: + type: object + description: The return item's details. + x-schemaName: StoreReturnItem + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + received_quantity: + type: number + title: received_quantity + description: The item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. + reason_id: + type: string + title: reason_id + description: The ID of the item's reason. + note: + type: string + title: note + description: A note with more details on why the item is returned. + item_id: + type: string + title: item_id + description: The ID of the item in the order. + return_id: + type: string + title: return_id + description: The ID of the return this item belongs to. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + required: + - id + - quantity + - received_quantity + - damaged_quantity + - item_id + - return_id StoreReturnReason: type: object description: The return reason's details. @@ -61722,20 +64476,20 @@ components: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. StoreReturnReasonResponse: type: object - description: SUMMARY + description: The return reason's details. x-schemaName: StoreReturnReasonResponse required: - return_reason @@ -61744,7 +64498,7 @@ components: $ref: '#/components/schemas/StoreReturnReason' StoreReturnResponse: type: object - description: SUMMARY + description: The return's details. x-schemaName: StoreReturnResponse required: - return @@ -61753,7 +64507,7 @@ components: $ref: '#/components/schemas/StoreReturn' StoreShippingOption: type: object - description: The shipping option's shipping options. + description: The shipping option's details. x-schemaName: StoreShippingOption required: - id @@ -61780,30 +64534,30 @@ components: description: The shipping option's name. price_type: type: string - description: The shipping option's price type. + description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider. enum: - flat - calculated service_zone_id: type: string title: service_zone_id - description: The shipping option's service zone id. + description: The ID of the service zone the shipping option belongs to. provider_id: type: string title: provider_id - description: The shipping option's provider id. + description: The ID of the fulfillment provider handling this option. 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. + description: The ID of the shipping option's type. type: - type: object + $ref: '#/components/schemas/StoreShippingOptionType' shipping_profile_id: type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: The ID of the associated shipping profile. amount: type: number title: amount @@ -61811,16 +64565,18 @@ components: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping option's is tax inclusive. + description: Whether the amount includes taxes. data: type: object - description: The shipping option's data. + description: The shipping option's data, useful for the provider handling fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping option's metadata. + description: The shipping option's metadata, can hold custom key-value pairs. StoreShippingOptionListResponse: type: object - description: SUMMARY + description: The shipping option's details. x-schemaName: StoreShippingOptionListResponse required: - shipping_options @@ -61830,9 +64586,58 @@ components: description: The shipping option's shipping options. items: $ref: '#/components/schemas/StoreShippingOption' + StoreShippingOptionType: + type: object + description: The shipping option type's details. + x-schemaName: StoreShippingOptionType + required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The type's ID. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + created_at: + type: string + format: date-time + title: created_at + description: The date the type was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the type was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the type was deleted. StoreUpdateCartLineItem: type: object - description: SUMMARY + description: The details to update in the line item. x-schemaName: StoreUpdateCartLineItem required: - quantity @@ -61840,13 +64645,13 @@ components: quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. + description: The item's metadata, can hold custom key-value pairs. StoreUpdateCustomer: type: object - description: SUMMARY + description: The details to update in the customer. x-schemaName: StoreUpdateCustomer properties: company_name: @@ -61867,7 +64672,7 @@ components: description: The customer's phone. UpdateAddress: type: object - description: The cart's shipping address. + description: The details to update in the address. x-schemaName: UpdateAddress required: - id @@ -61875,88 +64680,90 @@ components: id: type: string title: id - description: The shipping address's ID. + description: The ID of an existing address to update. customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer that this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: usd province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. + description: The address's metadata, can hold custom key-value pairs. UpdateCartData: type: object - description: SUMMARY + description: The details to update in a cart. x-schemaName: UpdateCartData properties: region_id: type: string title: region_id - description: The cart's region id. + description: The ID of the associated region. This can affect the prices and currency code of the cart. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The ID of the customer that the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The ID of the associated sales channel. Only products available in this channel can be added to the cart. email: type: string title: email - description: The cart's email. + description: The email of the customer that the cart belongs to. format: email currency_code: type: string title: currency_code description: The cart's currency code. + example: usd shipping_address_id: type: string title: shipping_address_id - description: The cart's shipping address id. + description: The ID of the cart's shipping address. billing_address_id: type: string title: billing_address_id - description: The cart's billing address id. + description: The ID of the cart's billing address. billing_address: oneOf: - $ref: '#/components/schemas/CreateAddress' @@ -61967,31 +64774,7 @@ components: - $ref: '#/components/schemas/UpdateAddress' metadata: type: object - description: The cart's metadata. - UpdateOrderReturnReason: - type: object - description: SUMMARY - x-schemaName: UpdateOrderReturnReason - properties: - id: - type: string - title: id - description: The return reason's ID. - label: - type: string - title: label - description: The return reason's label. - value: - type: string - title: value - description: The return reason's value. - description: - type: string - title: description - description: The return reason's description. - metadata: - type: object - description: The return reason's metadata. + description: The cart's metadata, ca hold custom key-value pairs. WorkflowExecutionContext: type: object description: The workflow execution's context. @@ -62003,6 +64786,30 @@ components: data: type: object description: The context's data. + properties: + invoke: + type: object + description: The step's invokation details. + required: + - output + additionalProperties: + type: object + properties: + output: + type: object + description: The invokation's details. + required: + - output + - compensateInput + properties: + output: + description: the step's output + compensateInput: + description: the compensation function's input. + payload: + description: the payload of the transaction. + required: + - invoke compensate: type: object description: The context's compensate. @@ -62011,7 +64818,23 @@ components: description: The context's errors. items: type: object - description: The error's errors. + description: The error's details. + properties: + error: + type: object + description: The error's details. + action: + type: string + title: action + description: The error's action. + handlerType: + type: string + title: handlerType + description: The error's handler type. + required: + - error + - action + - handlerType responses: default_error: description: Default Error diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index 594d270e42..77b4b47175 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -791,6 +791,9 @@ paths: $ref: paths/admin_orders_{id}_fulfillments.yaml /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_cancel.yaml + /admin/orders/{id}/fulfillments/{fulfillment_id}/mark-as-delivered: + $ref: >- + paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: $ref: paths/admin_orders_{id}_fulfillments_{fulfillment_id}_shipments.yaml /admin/orders/{id}/preview: 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 dd867df70d..568e6a9ca4 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -61,6 +67,8 @@ 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 `-`. + externalDocs: + url: '#pagination' - name: q in: query description: A search term to search the API keys' searchable properties. 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 afc2b5dfe5..62af33d9c8 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -173,7 +177,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 024a93055a..039390fbed 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 3dca03240c..eec86ab182 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 87152bdab2..c8fd7e5b19 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -152,6 +158,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 baf0046e4d..3bdda8009b 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -236,7 +240,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 4450fa7f19..e954d0a13b 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 f3f7a69f78..9cd68bbd30 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -1052,6 +1058,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml index 20da5de270..d21e89c4bf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 cf7ba477d5..26b84a35c1 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 19ed08493e..114a4d338d 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 @@ -49,6 +49,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -138,6 +140,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 5bcfe59002..9beca3cfda 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 300d782f8f..dd5afb6b94 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 72e02bf0d9..19a476f498 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -139,6 +141,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 2af4716ee3..2e7b61df2c 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 7c5c13a537..fcb218598a 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -139,6 +141,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 96e2788654..83bb3918ea 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -67,10 +69,6 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} x-workflow: confirmClaimRequestWorkflow delete: operationId: DeleteClaimsIdRequest 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 74415e9378..067e0a76cd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -1008,6 +1014,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml index de5e87c71a..3ab169011c 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 3b9e95929f..379f8f4296 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 9d26c52d07..59bcf94d82 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 1a221b3187..6e8ceb89c7 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 e0ca398f63..6d7bd5e4c0 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -984,7 +990,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of customer groups. required: - limit - offset @@ -993,23 +999,25 @@ get: limit: type: number title: limit - description: The customer group's limit. + description: The maximum number of items retrieved. offset: type: number title: offset - description: The customer group's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The customer group's count. + description: The total number of items - type: object - description: SUMMARY + description: The paginated list of customer groups. required: - customer_groups properties: customer_groups: type: array - description: The customer group's customer groups. + description: The list of customer groups. items: $ref: ../components/schemas/AdminCustomerGroup.yaml '400': @@ -1056,6 +1064,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml index eb6f53c273..ac44c21cda 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -173,7 +177,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 9da4308c50..2e0b29c201 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 f94a36d7cf..3257225bba 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -4245,6 +4251,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml index c24e0823fc..55c4c2746e 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -216,7 +220,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -246,4 +250,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - x-workflow: deleteCustomersWorkflow + x-workflow: removeCustomerAccountWorkflow 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 93a823f862..25d0afad19 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -46,6 +48,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -54,6 +58,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -273,6 +279,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml index 758825d498..2f68bf067b 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 @@ -44,6 +44,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -120,6 +122,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -286,6 +290,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -306,7 +312,7 @@ delete: schema: allOf: - type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -325,11 +331,11 @@ delete: title: deleted description: Whether the Customer was deleted. - type: object - description: SUMMARY + description: The deletion's details. properties: parent: $ref: ../components/schemas/AdminCustomer.yaml - description: SUMMARY + description: The deletion's details. '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 7b15807b8a..6905726051 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -1792,7 +1798,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of draft orders. required: - limit - offset @@ -1801,17 +1807,19 @@ get: limit: type: number title: limit - description: The draft order's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The draft order's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The draft order's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of draft orders. required: - draft_orders properties: @@ -1863,6 +1871,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml index 8ad927980b..60c99496b7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -965,7 +971,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of exchanges. required: - limit - offset @@ -974,22 +980,27 @@ get: limit: type: number title: limit - description: The exchange's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The exchange's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The exchange's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of exchanges. required: - exchanges properties: exchanges: - $ref: ../components/schemas/AdminExchange.yaml + type: array + description: The exchange's exchanges. + items: + $ref: ../components/schemas/AdminExchange.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -1036,6 +1047,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml index 03f70a8737..add4963043 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 index c2032f38b4..02cc9541b4 100644 --- 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 @@ -88,32 +88,6 @@ delete: 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. security: - api_token: [] - cookie_auth: [] 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 index f19538a075..8b648e2618 100644 --- 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 index c964f6a4a5..c58dc9f9b5 100644 --- 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 @@ -38,6 +38,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 index 7e1d6bf824..ad303775b3 100644 --- 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -139,6 +141,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 index fef326d741..56c7620b20 100644 --- 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 index 08584a355a..a2c8b97688 100644 --- 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -139,6 +141,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml index c8af8f8867..cf53fe9f42 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_request.yaml @@ -36,6 +36,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -67,10 +69,6 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmExchangeRequestWorkflow - requestBody: - content: - application/json: - schema: {} delete: operationId: DeleteExchangesIdRequest summary: Cancel Exchange Request 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 52866320b9..7202110f41 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 @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 a8ac2c6556..bc2c4a19cd 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml index b3818abc68..8f0d5c6e15 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 @@ -43,6 +43,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -119,6 +121,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 cb5f9615af..b9ebf98d02 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml @@ -30,6 +30,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 cdafcd144e..38244f3f3d 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 @@ -41,6 +41,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 710685b90c..0d36b5187d 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 4205442b00..7a7f0db043 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -453,7 +459,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of inventory items. required: - limit - offset @@ -462,17 +468,19 @@ get: limit: type: number title: limit - description: The inventory item's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The inventory item's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The inventory item's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of inventory items. required: - inventory_items properties: @@ -525,6 +533,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 8355133ce8..e8eb37307f 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -234,7 +238,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 50e14869e0..d1a1c18666 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 @@ -39,6 +39,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -47,6 +49,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -55,6 +59,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -124,7 +130,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of inventory levels. required: - limit - offset @@ -133,17 +139,19 @@ get: limit: type: number title: limit - description: The inventory item's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The inventory item's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The inventory item's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of inventory levels. required: - inventory_levels properties: @@ -203,6 +211,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 69aaabad70..3b0a543601 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 @@ -45,6 +45,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -142,6 +144,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -162,7 +166,7 @@ delete: schema: allOf: - type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -181,11 +185,11 @@ delete: title: deleted description: Whether the Inventory Item was deleted. - type: object - description: SUMMARY + description: The deletion's details. properties: parent: $ref: ../components/schemas/AdminInventoryItem.yaml - description: SUMMARY + description: The deletion's details. '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 7ada91ddf1..62f2552bea 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -625,6 +631,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: 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 3607317e41..64cea246bc 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -90,7 +92,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 03a174f039..4ad9ac0517 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 @@ -36,6 +36,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -62,8 +64,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} x-workflow: refreshInviteTokensWorkflow 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 8a56018b8f..f07d42df6f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 61d7382295..5efed48a92 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml index c0e27ac3ee..0a2d11193c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}.yaml @@ -28,7 +28,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 2c433debbd..6cf7ae83c0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 3dca89586e..0e37c2481e 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -107,6 +109,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -137,7 +141,3 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} 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 bb0909904c..a428b3e187 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 @@ -36,15 +36,12 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/AdminArchiveOrder.yaml x-codeSamples: - lang: Shell label: cURL 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 4c7b0f915f..b1674af161 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 @@ -44,6 +44,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -74,8 +76,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} x-workflow: cancelOrderWorkflow 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 f3b4ae8c45..bf1d14b98e 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 @@ -36,6 +36,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 ae1e4b00e6..4151b488b9 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 2f4c2fc2aa..df44b78163 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 @@ -44,6 +44,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml new file mode 100644 index 0000000000..b79b30aedf --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered.yaml @@ -0,0 +1,79 @@ +post: + operationId: PostOrdersIdFulfillmentsFulfillment_idMarkAsDelivered + summary: Mark a Fulfillment as Delivered. + x-sidebar-summary: Mark Delivered + description: Mark an order's fulfillment as delivered. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - name: fulfillment_id + in: path + description: The fulfillment'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. + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_orders_{id}_fulfillments_{fulfillment_id}_mark-as-delivered/post.sh + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminOrderResponse.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: markOrderFulfillmentAsDeliveredWorkflow 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 b53454d5fd..7cbf9eabf1 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 @@ -43,6 +43,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml index 399a10837b..c6e59cd860 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml @@ -30,6 +30,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml index 3341da699e..d63a70115a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections_{id}_mark-as-paid.yaml @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 93cb2a6991..41ce909fcb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 aacc37c9c5..101129f669 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 @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 8db16e1342..f02f4cd6b0 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 f0416be21c..0a5173fac3 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 @@ -38,6 +38,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 cd8dbfde7d..24babdfee5 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 @@ -38,6 +38,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 87b15b482f..3b35970d71 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -475,6 +481,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 aab1d0e6a3..ff2994956f 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 ef71b0b817..8291f9266d 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 @@ -30,8 +30,8 @@ post: description: A price's details. required: - currency_code - - amount - variant_id + - amount properties: currency_code: type: string 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 208c7f58e6..0b4eab62f0 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 @@ -36,6 +36,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-preferences.yaml index e40cecea5c..e127c8d1db 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 @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -202,6 +208,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 320f4fd56b..2d8228d946 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories.yaml index 63d15f4a03..eb519ae0dd 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 @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -689,6 +695,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 9cc82ddf45..d437b79bf8 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: include_ancestors_tree in: query description: >- @@ -130,6 +132,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml index d2742e7f43..f5e3c3a03b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}_products.yaml @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index 9a95a6b97f..6594acf9f0 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -598,6 +604,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 171b7050e2..92d7dff185 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 381f310e1f..d3ca9089e5 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -598,6 +604,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -606,7 +614,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/AdminCreateProduct.yaml + $ref: ../components/schemas/AdminCreateProductType.yaml x-codeSamples: - lang: Shell label: cURL 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 d3b6031ab5..ea56fefcae 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml index 6faaaf761d..e6cf2db0c5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-variants.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -563,7 +569,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of product variants. required: - limit - offset @@ -572,17 +578,19 @@ get: limit: type: number title: limit - description: The product variant's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product variant's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The product variant's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of product variants. required: - variants properties: 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 f0a098bb85..41ee94d129 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -48,6 +50,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -673,6 +677,522 @@ get: type: string title: collection_id description: A product collection's ID. + - name: variants + in: query + description: Filter the retrieved products' variants. + required: false + schema: + type: object + description: Filter the retrieved products' variants. + x-schemaName: AdminProductVariantParams + properties: + q: + type: string + title: q + description: Search term to apply on the variant's searchable properties. + id: + oneOf: + - type: string + title: id + description: Filter by a variant's ID. + - type: array + description: Filter by variant IDs. + items: + type: string + title: id + description: A variant's ID. + manage_inventory: + type: boolean + title: manage_inventory + description: >- + Filter by whether the Medusa application manages the variant's + inventory. + allow_backorder: + type: boolean + title: allow_backorder + description: >- + Filter by whether the variant can be ordered even if it's out of + stock. + created_at: + type: object + description: Filter by the variant's creation date. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by an exact match. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers + and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful + for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + updated_at: + type: object + description: The variant's updated at. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by an exact match. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers + and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful + for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + deleted_at: + type: object + description: The variant's deleted at. + properties: + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's + content is the same type as the expected query parameters. + items: + type: object + title: $or + $eq: + oneOf: + - type: string + title: $eq + description: Filter by an exact match. + - type: array + description: Filter by an exact match. + items: + type: string + title: $eq + description: Filter by an exact match. + $ne: + type: string + title: $ne + description: Filter by values not equal to this parameter. + $in: + type: array + description: Filter by values in this array. + items: + type: string + title: $in + description: Filter by values in this array. + $nin: + type: array + description: Filter by values not in this array. + items: + type: string + title: $nin + description: Filter by values not in this array. + $not: + oneOf: + - type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + - type: object + description: >- + Filter by values not matching the conditions in this + parameter. + - type: array + description: >- + Filter by values not matching the conditions in this + parameter. + items: + type: string + title: $not + description: >- + Filter by values not matching the conditions in this + parameter. + $gt: + type: string + title: $gt + description: >- + Filter by values greater than this parameter. Useful for + numbers and dates only. + $gte: + type: string + title: $gte + description: >- + Filter by values greater than or equal to this parameter. + Useful for numbers and dates only. + $lt: + type: string + title: $lt + description: >- + Filter by values less than this parameter. Useful for numbers + and dates only. + $lte: + type: string + title: $lte + description: >- + Filter by values less than or equal to this parameter. Useful + for numbers and dates only. + $like: + type: string + title: $like + description: Apply a `like` filter. Useful for strings only. + $re: + type: string + title: $re + description: Apply a regex filter. Useful for strings only. + $ilike: + type: string + title: $ilike + description: >- + Apply a case-insensitive `like` filter. Useful for strings + only. + $fulltext: + type: string + title: $fulltext + description: Filter to apply on full-text properties. + $overlap: + type: array + description: >- + Filter arrays that have overlapping values with this + parameter. + items: + type: string + title: $overlap + description: >- + Filter arrays that have overlapping values with this + parameter. + $contains: + type: array + description: >- + Filter arrays that contain some of the values of this + parameter. + items: + type: string + title: $contains + description: >- + Filter arrays that contain some of the values of this + parameter. + $contained: + type: array + description: Filter arrays that contain all values of this parameter. + items: + type: string + title: $contained + description: Filter arrays that contain all values of this parameter. + $exists: + type: boolean + title: $exists + description: >- + Filter by whether a value for this parameter exists (not + `null`). + limit: + type: number + title: limit + description: Limit the number of items returned in the list. + offset: + type: number + title: offset + description: The number of items to skip when retrieving a list. + order: + 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 `-`. + fields: + 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. + $and: + type: array + description: >- + Join query parameters with an AND condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $and + $or: + type: array + description: >- + Join query parameters with an OR condition. Each object's content + is the same type as the expected query parameters. + items: + type: object + title: $or security: - api_token: [] - cookie_auth: [] @@ -766,6 +1286,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 fd104b4b4c..cee0aff78b 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 @@ -30,6 +30,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 f734a31486..0e648decf1 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 @@ -40,6 +40,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 7de396a05b..8e6c98aca3 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 67b6b9a439..0ccd5a09f3 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 @@ -39,6 +39,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -47,6 +49,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -55,6 +59,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -230,6 +236,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 a20c09545a..ccd7d7fbb7 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 @@ -43,6 +43,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -118,6 +120,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -213,6 +217,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 763569a35b..82c7ae4d56 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 @@ -39,6 +39,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -47,6 +49,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -55,6 +59,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -649,6 +655,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 3b4cca0b7f..7581b8cc47 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 c989c00f32..1041e8b9a8 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 @@ -36,9 +36,9 @@ post: The associations to create between a product variant and an inventory item. required: - - required_quantity - - inventory_item_id - variant_id + - inventory_item_id + - required_quantity properties: required_quantity: type: number @@ -63,9 +63,9 @@ post: type: object description: Update a product variant's association with an inventory item. required: - - required_quantity - - inventory_item_id - variant_id + - inventory_item_id + - required_quantity properties: required_quantity: type: number @@ -90,8 +90,8 @@ post: type: object description: Delete a product variant's association with an inventory item. required: - - inventory_item_id - variant_id + - inventory_item_id properties: inventory_item_id: type: string 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 d5016ce4b4..36f10db280 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 @@ -43,6 +43,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -118,6 +120,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -211,6 +215,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 12e691370d..b6a7614f2d 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 @@ -45,6 +45,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 a009c5037f..96cd064bc8 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 @@ -51,6 +51,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -139,6 +141,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml index e1563247be..645a150e4e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -652,6 +658,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 c89f2dd132..c240da2171 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml @@ -1,10 +1,10 @@ get: operationId: GetPromotionsRuleAttributeOptionsRule_type summary: List Rule Attribute Options of a Rule Type - x-sidebar-summary: List Rule Attribute Options + x-sidebar-summary: List Potential Rule Attributes description: > - Retrieve a list of attributes for the promotion and application method types - specified in the query parameters. + Retrieve a list of potential rule attributes for the promotion and + application method types specified in the query parameters. Only the attributes of the rule type specified in the path parameter are retrieved: @@ -14,8 +14,11 @@ get: - If `rule_type` is `target-rules`, the target rules' attributes of the - application method's type are retrieved. - If `rule_type` is `buy-rules`, - the buy rules' attributes of the application method's type are retrieved. + application method's type are retrieved. + + + - If `rule_type` is `buy-rules`, the buy rules' attributes of the + application method's type are retrieved. x-authenticated: true parameters: - name: rule_type 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 75c2e6bd64..e715dd2981 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 @@ -35,6 +35,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -43,6 +45,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 d0888f62bd..bcddaa0eec 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -285,7 +289,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 6a69a1a091..293cc98958 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -54,103 +56,12 @@ post: type: array description: The buy rules to create. items: - type: object - description: A buy rule's details. - required: - - operator - - attribute - - values - properties: - operator: - type: string - description: >- - The operator used to check whether the buy rule applies on - a cart. For example, `eq` means that the cart's value for - the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: >- - The attribute to compare against when checking whether a - promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: ../components/schemas/AdminCreatePromotionRule.yaml update: type: array description: The buy rules to update. items: - type: object - description: The properties to update in a buy rule. - required: - - id - - values - properties: - id: - type: string - title: id - description: The buy rule's ID. - operator: - type: string - description: >- - The operator used to check whether the buy rule applies on - a cart. For example, `eq` means that the cart's value for - the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: >- - The attribute to compare against when checking whether a - promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: ../components/schemas/AdminUpdatePromotionRule.yaml delete: type: array description: The buy rules to delete. 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 d44381ccec..dc3fc4b608 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -52,103 +54,12 @@ post: type: array description: The rules to create. items: - type: object - description: A rule's details. - required: - - operator - - attribute - - values - properties: - operator: - type: string - description: >- - The operator used to check whether the rule applies on a - cart. For example, `eq` means that the cart's value for - the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: >- - The attribute to compare against when checking whether a - promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: ../components/schemas/AdminCreatePromotionRule.yaml update: type: array description: The rules to update. items: - type: object - description: The properties to update in a rule. - required: - - id - - values - properties: - id: - type: string - title: id - description: The rule's ID. - operator: - type: string - description: >- - The operator used to check whether the rule applies on a - cart. For example, `eq` means that the cart's value for - the specified attribute must match the specified value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: >- - The attribute to compare against when checking whether a - promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: ../components/schemas/AdminUpdatePromotionRule.yaml delete: type: array description: The rules to delete. 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 5b3ce4053d..e7ca92bc4e 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -52,105 +54,12 @@ post: type: array description: The target rules to create. items: - type: object - description: A target rule's details. - required: - - operator - - attribute - - values - properties: - operator: - type: string - description: >- - The operator used to check whether the target rule applies - on a cart. For example, `eq` means that the cart's value - for the specified attribute must match the specified - value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: >- - The attribute to compare against when checking whether a - promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: ../components/schemas/AdminCreatePromotionRule.yaml update: type: array description: The target rules to update. items: - type: object - description: The properties to update in a target rule. - required: - - id - - values - properties: - id: - type: string - title: id - description: The target rule's ID. - operator: - type: string - description: >- - The operator used to check whether the target rule applies - on a cart. For example, `eq` means that the cart's value - for the specified attribute must match the specified - value. - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: >- - The attribute to compare against when checking whether a - promotion can be applied on a cart. - example: items.product.id - values: - oneOf: - - type: string - title: values - description: The attribute's value. - example: prod_123 - - type: array - description: The allowed attribute values. - items: - type: string - title: values - description: An attribute value. - example: prod_123 + $ref: ../components/schemas/AdminUpdatePromotionRule.yaml delete: type: array description: The target rules to delete. 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 9a352b1e9e..2edfdcb24a 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 @@ -57,6 +57,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml index 394eb15694..879a2b51dc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -130,7 +136,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of refund reasons. required: - limit - offset @@ -139,17 +145,19 @@ get: limit: type: number title: limit - description: The refund reason's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The refund reason's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The refund reason's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of refund reasons. required: - refund_reasons properties: @@ -202,6 +210,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml index 77f2837a6d..cf3994ce94 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -182,7 +186,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 690746812d..35f0c8b621 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -643,6 +649,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 b4abe775dc..847a9cc879 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -209,7 +213,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 b43eb4502a..1f36008aad 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -656,9 +662,9 @@ get: properties: reservations: type: array - description: The list of reservations`. + description: The list of reservations. items: - $ref: ../components/schemas/ReservationResponse.yaml + $ref: ../components/schemas/AdminReservation.yaml '400': $ref: ../components/responses/400_error.yaml '401': @@ -703,6 +709,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 d04362a2bb..92606bf617 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -189,7 +193,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 d8a5bb3dc8..f1281300d7 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -656,6 +662,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -664,7 +672,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/CreateOrderReturnReason.yaml + $ref: ../components/schemas/AdminCreateReturnReason.yaml x-codeSamples: - lang: Shell label: cURL 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 f62004d79e..01ab5f31ed 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -114,7 +118,7 @@ post: content: application/json: schema: - $ref: ../components/schemas/UpdateOrderReturnReason.yaml + $ref: ../components/schemas/AdminUpdateReturnReason.yaml x-codeSamples: - lang: Shell label: cURL 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 34604b2318..7673deb7e3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -744,7 +750,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of returns. required: - limit - offset @@ -753,17 +759,19 @@ get: limit: type: number title: limit - description: The return's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The return's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The return's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of returns. required: - returns properties: @@ -816,6 +824,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 310ff7f9cc..d438e1b432 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 ca51db616c..062844b68c 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 00b89a318b..bb04b51a19 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -140,6 +142,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 fa0ec7b8f7..9e88dd5a7d 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 525fa503e0..8837236ebc 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -140,6 +142,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 7c0b8ae15c..0d0ad2d170 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 @@ -38,6 +38,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,7 +108,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 5a56d41741..858b3b8612 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 @@ -38,6 +38,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 5a8ae2de66..935f6e8042 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 b6911a875c..e17488a1ca 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -140,6 +142,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 b9ebd7e210..d08b27696e 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -105,7 +107,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 cd0b03af8c..02e60cb178 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 097fd715ad..3af59f04dc 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 @@ -50,6 +50,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -139,6 +141,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml b/www/apps/api-reference/specs/admin/paths/admin_sales-channels.yaml index e00afd0bda..3249aac7f7 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -681,6 +687,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 3431c8ff42..378ab89945 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 6f03d37217..2aab7320ba 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 5b8a8a51ac..6f0ea7d91a 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -699,6 +705,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -707,7 +715,7 @@ post: content: application/json: schema: - type: object + $ref: ../components/schemas/AdminCreateShippingOption.yaml x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml index 3405df4b55..08513874be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-options_{id}.yaml @@ -1,3 +1,74 @@ +get: + operationId: GetShippingOptionsId + summary: Get a Shipping Option + description: >- + Retrieve a shipping option by its ID. You can expand the shipping option's + relations or select the fields that should be returned. + x-authenticated: true + parameters: + - name: id + in: path + description: The shipping option'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. + externalDocs: + url: '#select-fields-and-relations' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_shipping-options_{id}/get.sh + tags: + - Shipping Options + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminShippingOptionResponse.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: PostShippingOptionsId summary: Update a Shipping Option @@ -36,6 +107,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -83,9 +156,9 @@ post: type: object description: The shipping option's type. required: - - label - - description - code + - description + - label properties: label: type: string 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 c1ac56daf2..25ab2c2135 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -52,89 +54,12 @@ post: type: array description: The shipping option rules to create. items: - type: object - description: A shipping option's details. - required: - - operator - - attribute - - value - properties: - operator: - type: string - description: The operator used to check whether a rule applies. - enum: - - in - - eq - - ne - - gt - - gte - - lt - - lte - - nin - attribute: - type: string - title: attribute - description: The name of a property or table that the rule applies to. - example: customer_group - value: - oneOf: - - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 - - type: array - description: Values of the attribute that enable this rule. - items: - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 + $ref: ../components/schemas/AdminCreateShippingOptionRule.yaml update: type: array description: The shipping option rules to update. items: - type: object - description: The properties to update in the shipping option rule. - required: - - id - - operator - - attribute - - value - properties: - id: - type: string - title: id - description: The rule's ID. - operator: - type: string - description: The operator used to check whether a rule applies. - enum: - - in - - eq - - ne - - gt - - gte - - lt - - lte - - nin - attribute: - type: string - title: attribute - description: The name of a property or table that the rule applies to. - example: customer_group - value: - oneOf: - - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 - - type: array - description: Values of the attribute that enable this rule. - items: - type: string - title: value - description: A value of the attribute that enables this rule. - example: cusgroup_123 + $ref: ../components/schemas/AdminUpdateShippingOptionRule.yaml delete: type: array description: The shipping option rules to delete. 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 60c63fd4ac..89bb7a961d 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 @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -632,6 +638,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml index 27c24877e5..ffdfec9d5c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 395387e451..f8c3bcb3e2 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -628,6 +634,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 fd6be91a01..554aae548a 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 7f2ca773f3..1128042ca1 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 @@ -39,6 +39,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 06f52381f2..39380fbe8f 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -48,8 +50,8 @@ post: type: object description: The fulfillment set to create. required: - - name - type + - name properties: name: type: string 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 4214bee893..064a9130ec 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 aadc3e0eac..2c4393b857 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 bde1e1c649..c7f099324a 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 ba36270fe5..09bd34f1a2 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -725,6 +731,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 fbbeb5fc98..f847a610ce 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -106,6 +108,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 08492f371a..4eb96f5a02 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml index e9f6ac95a0..3599577007 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 @@ -43,6 +43,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -62,7 +64,7 @@ delete: schema: allOf: - type: object - description: SUMMARY + description: The deletion's details. required: - id - object @@ -81,11 +83,11 @@ delete: title: deleted description: Whether the Tax Rate was deleted. - type: object - description: SUMMARY + description: The deletion's details. properties: parent: $ref: ../components/schemas/AdminTaxRate.yaml - description: SUMMARY + description: The deletion's details. '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 5cd91fe59e..1fb3400525 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -1348,6 +1354,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 4665375a12..2fb88968af 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 5b95840d16..287992e323 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -13,17 +13,17 @@ post: schema: oneOf: - type: object - description: The files to upload. + description: The files to upload required: - files properties: files: type: array - description: The files to upload. + description: The upload's files. items: oneOf: - type: object - description: A file's details. + description: The file's files. required: - name - content @@ -35,9 +35,23 @@ post: content: type: string title: content - description: The file's base64 content. - - $ref: ../components/schemas/File.yaml - - $ref: ../components/schemas/FileList.yaml + description: The file's content. + - type: object + description: A File to upload. + externalDocs: + url: >- + https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: files + - type: array + description: list of files to upload. + items: + type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: FileList description: The files to upload. x-codeSamples: - lang: Shell 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 da16d8793f..38e004bc37 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] @@ -98,7 +100,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - id - object 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 eb21679829..c8f628af72 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 961feeb3b0..1b5353b617 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 @@ -30,6 +30,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL 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 b51d726fe0..5a5c6b2cea 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -102,6 +104,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -172,4 +176,4 @@ delete: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - x-workflow: deleteUsersWorkflow + x-workflow: removeUserAccountWorkflow 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 7b383f8028..615ad701a0 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 @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 8b152cec49..c6810694c7 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] 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 a95e0cc9ba..fdb82c7247 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 @@ -44,6 +44,8 @@ post: required: - workflowId - transactionId + - hasFinished + - hasFailed properties: workflowId: type: string @@ -56,6 +58,18 @@ post: later to track the workflow execution's progress or succeed / fail its steps. title: transactionId + parentStepIdempotencyKey: + type: string + title: parentStepIdempotencyKey + description: The idempotency key of the workflow execution. + hasFinished: + type: boolean + title: hasFinished + description: Whether the workflow execution has finished. + hasFailed: + type: boolean + title: hasFailed + description: Whether the workflow execution has failed. '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 af9c014b68..1025661871 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 @@ -43,6 +43,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/auth_session.yaml b/www/apps/api-reference/specs/admin/paths/auth_session.yaml index a46c808ceb..29f77a9c93 100644 --- a/www/apps/api-reference/specs/admin/paths/auth_session.yaml +++ b/www/apps/api-reference/specs/admin/paths/auth_session.yaml @@ -51,7 +51,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - success properties: diff --git a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}.yaml b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}.yaml index fd6cdfff63..687918b219 100644 --- a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}.yaml +++ b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}.yaml @@ -36,14 +36,10 @@ post: label: EmailPass Provider source: $ref: ../code_samples/Shell/auth_user_{auth_provider}/post.sh - - lang: Shell + - lang: Bash label: Google Provider source: - $ref: ../code_samples/Shell/auth_user_{auth_provider}/post.sh - - lang: Shell - label: GitHub Provider - source: - $ref: ../code_samples/Shell/auth_user_{auth_provider}/post.sh + $ref: ../code_samples/Bash/auth_user_{auth_provider}/post.sh tags: - Auth responses: diff --git a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_callback.yaml b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_callback.yaml index c04b43814c..68811d1b95 100644 --- a/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_callback.yaml +++ b/www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_callback.yaml @@ -33,10 +33,10 @@ post: label: Google Provider source: $ref: ../code_samples/Shell/auth_user_{auth_provider}_callback/post.sh - - lang: Shell + - lang: Bash label: GitHub Provider source: - $ref: ../code_samples/Shell/auth_user_{auth_provider}_callback/post.sh + $ref: ../code_samples/Bash/auth_user_{auth_provider}_callback/post.sh tags: - Auth responses: diff --git a/www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}/post.sh b/www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}/post.sh new file mode 100644 index 0000000000..7e8c2ac303 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}/post.sh @@ -0,0 +1 @@ +curl -X POST '{backend_url}/auth/customer/google' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh b/www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh new file mode 100644 index 0000000000..8d755aa683 --- /dev/null +++ b/www/apps/api-reference/specs/store/code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh @@ -0,0 +1 @@ +curl -X POST '{backend_url}/auth/customer/github/callback?code=123' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}/post.sh index 8db2a19301..5a9ff33995 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}/post.sh @@ -1 +1,6 @@ -curl -X POST '{backend_url}/auth/customer/github' \ No newline at end of file +curl -X POST '{backend_url}/auth/customer/emailpass' \ +-H 'Content-Type: application/json' \ +--data-raw '{ + "email": "customer@gmail.com", + "password": "supersecret" +}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh b/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh index 8d755aa683..7624546390 100644 --- a/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh +++ b/www/apps/api-reference/specs/store/code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh @@ -1 +1 @@ -curl -X POST '{backend_url}/auth/customer/github/callback?code=123' \ No newline at end of file +curl -X POST '{backend_url}/auth/customer/google/callback?code=123' \ No newline at end of file diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminApplicationMethod.yaml similarity index 59% rename from www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminApplicationMethod.yaml index 5cbb99276e..14f4f8992f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateApplicationMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminApplicationMethod.yaml @@ -1,45 +1,40 @@ type: object description: The application method's details. -x-schemaName: AdminCreateApplicationMethod +x-schemaName: AdminApplicationMethod required: - - value - - type - - target_type + - id properties: - description: + promotion: + $ref: ./AdminPromotion.yaml + target_rules: + type: array + description: The application method's target rules. + items: + $ref: ./AdminPromotionRule.yaml + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: ./AdminPromotionRule.yaml + id: type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: >- - The discounted amount applied by the associated promotion based on the - `type`. - currency_code: - type: string - title: currency_code - description: The application method's currency code. - max_quantity: - type: number - title: max_quantity - description: >- - The max quantity allowed in the cart for the associated promotion to be - applied. + title: id + description: The application method's ID. type: type: string description: >- - The type of the application method indicating how the associated promotion - is applied. + The application method's type. If it's `fixed`, the promotion discounts a + fixed amount. If it's `percentage`, the promotion discounts a percentage. enum: - fixed - percentage target_type: type: string description: >- - The target type of the application method indicating whether the - associated promotion is applied to the cart's items, shipping methods, or - the whole order. + Which item does the promotion apply to. `items` mean the promotion applies + to the cart's items; `shipping_methods` means the promotion applies to the + cart's shipping methods; `order` means the promotion applies on the entire + order. enum: - items - shipping_methods @@ -47,28 +42,27 @@ properties: allocation: type: string description: >- - The allocation value that indicates whether the associated promotion is - applied on each item in a cart or split between the items in the cart. + How is the promotion amount discounted. `each` means the discounted amount + is applied on each applicable item; `across` means the discounted amount + is split accross the applicable items. enum: - each - across - target_rules: - type: array - description: The application method's target rules. - items: - $ref: ./AdminCreatePromotionRule.yaml - buy_rules: - type: array - description: The application method's buy rules. - items: - $ref: ./AdminCreatePromotionRule.yaml - apply_to_quantity: + value: type: number - title: apply_to_quantity + title: value + description: The amount to be discounted. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + example: usd + max_quantity: + type: number + title: max_quantity description: >- - The quantity that results from matching the `buyget` promotion's - condition. For example, if the promotion is a "Buy 2 shirts get 1 free", - the value f this attribute is `1`. + The max quantity allowed in the cart for the associated promotion to be + applied. buy_rules_min_quantity: type: number title: buy_rules_min_quantity @@ -76,3 +70,10 @@ properties: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. + apply_to_quantity: + type: number + title: apply_to_quantity + description: >- + The quantity that results from matching the `buyget` promotion's + condition. For example, if the promotion is a "Buy 2 shirts get 1 free", + the value of this attribute is `1`. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml deleted file mode 100644 index 72b7d36198..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminArchiveOrder.yaml +++ /dev/null @@ -1,10 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminArchiveOrder -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/AdminClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml index 21f60500a4..d6104bdceb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaim.yaml @@ -2,44 +2,18 @@ type: object description: The claim's details. x-schemaName: AdminClaim required: - - order_id - - claim_items - - additional_items - - currency_code + - order + - return - id - - region_id - - customer_id - - sales_channel_id - - email - - shipping_methods - - payment_status - - fulfillment_status - - summary - - metadata + - type + - order_id + - display_id + - order_version - 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 + - canceled_at + - additional_items + - claim_items properties: id: type: string @@ -60,7 +34,7 @@ properties: items: $ref: ./BaseClaimItem.yaml return: - $ref: ./Return.yaml + $ref: ./AdminReturn.yaml return_id: type: string title: return_id @@ -73,76 +47,15 @@ properties: type: number title: refund_amount description: The amount to be refunded. - currency_code: - type: string - title: currency_code - description: The claim's currency code. - region_id: - type: string - title: region_id - description: The ID of the region associated with the claim. - customer_id: - type: string - title: customer_id - description: The ID of the customer associated with the claim's order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the claim's order is created in. - email: - type: string - title: email - description: The email associated with the claim's order. - format: email display_id: type: number 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 - description: The claim's payment status. - 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 - description: The claim's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered + $ref: ./AdminOrderShippingMethod.yaml transactions: type: array description: The claim's transactions. @@ -152,8 +65,6 @@ properties: description: Learn more about transactions of orders and associated models. items: $ref: ./BaseOrderTransaction.yaml - summary: - $ref: ./BaseOrderSummary.yaml metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -167,91 +78,29 @@ properties: format: date-time title: updated_at description: The claim's update date. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the associated order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the associated order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The tax total of the original items in the associated order. - item_total: - type: number - title: item_total - description: The total of the claim's items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the claim's items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the claim's items. - original_total: - type: number - title: original_total - description: The associated order's original total. - original_subtotal: - type: number - title: original_subtotal - description: The associated order's original subtotal. - original_tax_total: - type: number - title: original_tax_total - description: The associated order's original tax total. - total: - type: number - title: total - description: The associated order'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 associated order's original shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The associated order's original shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The associated order's original shipping tax total. + order: + $ref: ./AdminOrder.yaml + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order_version: + type: string + title: order_version + description: The version of the order when the claim is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml index d3d5cf085c..8fdefc6818 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimPreviewResponse.yaml @@ -8,6 +8,6 @@ required: - claim properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.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 index eb463459db..c49a9d5d9e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimRequestResponse.yaml @@ -11,6 +11,6 @@ properties: return: $ref: ./AdminReturn.yaml order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml 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 index f91f77fa23..9688761b29 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminClaimReturnPreviewResponse.yaml @@ -8,6 +8,6 @@ required: - return properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml return: $ref: ./AdminReturn.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml index 0dd456e29b..79e31f7d86 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -2,15 +2,14 @@ type: object description: The filfillment's details. x-schemaName: AdminCreateFulfillment required: + - data + - order_id + - metadata + - items - location_id - provider_id - delivery_address - - items - labels - - order - - order_id - - data - - metadata properties: location_id: type: string @@ -75,8 +74,8 @@ properties: description: An item to fulfill. required: - title - - sku - quantity + - sku - barcode properties: title: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml index ff78bb5483..8ff435ab5c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml @@ -48,8 +48,8 @@ properties: description: A price's details. required: - currency_code - - amount - variant_id + - amount properties: currency_code: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml new file mode 100644 index 0000000000..92179c7066 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductType.yaml @@ -0,0 +1,13 @@ +type: object +description: The details of the product type to create. +x-schemaName: AdminCreateProductType +required: + - value +properties: + metadata: + type: object + description: The product's metadata, used to store custom key-value pairs. + value: + type: string + title: value + description: The product type's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml index 874a1015bb..5cbbf93868 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariant.yaml @@ -86,3 +86,8 @@ properties: the option's value. example: Color: Black + inventory_items: + type: array + description: The variant's inventory items to create. + items: + $ref: ./AdminCreateProductVariantInventoryKit.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantInventoryKit.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantInventoryKit.yaml new file mode 100644 index 0000000000..89c326e80c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantInventoryKit.yaml @@ -0,0 +1,20 @@ +type: object +description: The details of a variant's inventory item. +x-schemaName: AdminCreateProductVariantInventoryKit +required: + - inventory_item_id +properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory item's ID. + required_quantity: + type: number + title: required_quantity + description: >- + The number of units a single quantity is equivalent to. For example, if a + customer orders one quantity of the variant, Medusa checks the + availability of the quantity multiplied by the value set for + `required_quantity`. When the customer orders the quantity, Medusa + reserves the ordered quantity multiplied by the value set for + `required_quantity`. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml index e543b4f377..7209d597f8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProductVariantPrice.yaml @@ -30,3 +30,10 @@ properties: description: The price's rules. example: region_id: reg_123 + properties: + region_id: + type: string + title: region_id + description: The ID of a region. + required: + - region_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml index 93373ce220..d8ddd80848 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePromotionRule.yaml @@ -13,13 +13,13 @@ properties: example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: + - gte + - lte - gt - lt - eq - ne - in - - lte - - gte description: type: string title: description @@ -30,7 +30,7 @@ properties: description: >- The attribute to compare against when checking whether a promotion can be applied on a cart. - example: item.product.id + example: items.product.id values: oneOf: - type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/CreateOrderReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml similarity index 65% rename from www/apps/api-reference/specs/admin/components/schemas/CreateOrderReturnReason.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml index efbb641c2f..adac302423 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/CreateOrderReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateReturnReason.yaml @@ -1,6 +1,6 @@ type: object -description: SUMMARY -x-schemaName: CreateOrderReturnReason +description: The details of the return reason to create. +x-schemaName: AdminCreateReturnReason required: - value - label @@ -20,7 +20,7 @@ properties: parent_return_reason_id: type: string title: parent_return_reason_id - description: The return reason's parent return reason id. + description: The ID of the parent return reason. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml index c3e9d1c9b2..2477095764 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml @@ -2,91 +2,19 @@ type: object description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - name - - service_zone_id - - shipping_profile_id - - price_type - - provider_id - - type - - prices + - label + - description + - code properties: - name: + label: type: string - title: name - description: The shipping option's name. - service_zone_id: + title: label + description: The type's label. + description: type: string - title: service_zone_id - description: The ID of the service zone this shipping option belongs to. - shipping_profile_id: + title: description + description: The type's description. + code: type: string - title: shipping_profile_id - description: The ID of the shipping profile this shipping option belongs to. - data: - type: object - description: >- - Any data necessary for fulfillment providers to handle shipping methods - and fulfillments of this shipping option. - externalDocs: - url: >- - https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property - description: Learn more about the data property. - price_type: - type: string - description: > - The shipping option price's type. If `flat`, it means the option has a - fixed price set in the `prices` property. `calculated` means that the - shipping option's price is calculated during checkout. - enum: - - flat - - calculated - provider_id: - type: string - title: provider_id - description: >- - The ID of the fulfillment provider used to handle this shipping option and - its associated methods and fulfillments. - type: - $ref: ./AdminCreateShippingOption.yaml - prices: - type: array - description: >- - The shipping option's prices. If `price_type` is `calculated`, pass an - empty array for this property. - items: - oneOf: - - type: object - description: The price for a currency code. - x-schemaName: AdminCreateShippingOptionPriceWithCurrency - required: - - currency_code - - amount - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - - type: object - description: The price in a region. - x-schemaName: AdminCreateShippingOptionPriceWithRegion - required: - - region_id - - amount - properties: - region_id: - type: string - title: region_id - description: The ID of the region this price is used in. - amount: - type: number - title: amount - description: The price's amount. - rules: - type: array - description: The shipping option's rules. - items: - $ref: ./AdminCreateShippingOptionRule.yaml + title: code + description: The type's code. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml index 065c81d06b..8aa3b751de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRate.yaml @@ -4,6 +4,7 @@ x-schemaName: AdminCreateTaxRate required: - name - tax_region_id + - code properties: name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml index f0cdf7c039..261472a2de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateTaxRegion.yaml @@ -21,6 +21,7 @@ properties: type: object description: The tax region's default tax rate. required: + - code - name properties: rate: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml index 23e84a8328..2de3fc7b23 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateVariantInventoryItem.yaml @@ -2,8 +2,8 @@ type: object description: The details of the variant-inventory item association. x-schemaName: AdminCreateVariantInventoryItem required: - - required_quantity - inventory_item_id + - required_quantity properties: required_quantity: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml index 984e1d51cf..887204ea4d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCurrency.yaml @@ -8,7 +8,6 @@ required: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml index af16ad0bf7..7a8ef94f4f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomer.yaml @@ -3,6 +3,7 @@ description: The customer's details. x-schemaName: AdminCustomer required: - has_account + - addresses - id - email - default_billing_address_id @@ -10,7 +11,6 @@ required: - company_name - first_name - last_name - - addresses properties: id: type: string @@ -54,7 +54,7 @@ properties: type: array description: The customer's addresses. items: - $ref: ./BaseCustomerAddress.yaml + $ref: ./AdminCustomerAddress.yaml phone: type: string title: phone diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml index 3984d6eb28..ddef197fa0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroup.yaml @@ -2,9 +2,9 @@ type: object description: The customer group's details. x-schemaName: AdminCustomerGroup required: + - customers - id - name - - customers - metadata - created_at - updated_at @@ -21,7 +21,7 @@ properties: type: array description: The customer group's customers. items: - $ref: ./BaseCustomer.yaml + type: object metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml index 4ddc2deae1..85fb2eeff2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerGroupResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The customer group's details. x-schemaName: AdminCustomerGroupResponse required: - customer_group diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml index 06cde895cd..d53387f56f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCustomerResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The customer's details. x-schemaName: AdminCustomerResponse required: - customer diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml index e66c9d6ec8..31e20a4158 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -2,44 +2,14 @@ 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 + - order_id - 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 + - canceled_at + - deleted_at + - additional_items + - return_items properties: order_id: type: string @@ -67,88 +37,24 @@ properties: be refunded. If positive, additional payment is required from the customer. return: - description: the return associated with the exchange. $ref: ./AdminReturn.yaml return_id: type: string title: return_id description: The ID of the associated exchange. - 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 ID of the associated order's region. - customer_id: - type: string - title: customer_id - description: The ID of the customer that placed the order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the associated order belongs to. - email: - type: string - title: email - description: The email used when placing the order. - format: email display_id: - type: number + type: string title: display_id description: The exchange's display ID. - shipping_address: - description: The shipping address to send new items to. - $ref: ./BaseOrderAddress.yaml - billing_address: - description: The customer's billing address. - $ref: ./BaseOrderAddress.yaml shipping_methods: type: array description: The shipping methods used to send the new (outbound) items. items: $ref: ./BaseOrderShippingMethod.yaml - payment_collections: - type: array - description: The exchange's payment collections. - items: - $ref: ./BasePaymentCollection.yaml - payment_status: - type: string - description: The exchange's payment status. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - fulfillments: - type: array - description: The exchange's fulfillments of new (outbound) items. - items: - $ref: ./BaseOrderFulfillment.yaml - fulfillment_status: - type: string - description: The exchange's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered transactions: type: array description: The exchange's transactions. @@ -157,9 +63,6 @@ properties: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions items: $ref: ./BaseOrderTransaction.yaml - summary: - description: The totals summary of the exchange. - $ref: ./BaseOrderSummary.yaml metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -173,91 +76,29 @@ properties: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The total tax of the original items in the order. - item_total: - type: number - title: item_total - description: The total of the exchange's new items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the exchange's new items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the exchange's new items. - original_total: - type: number - title: original_total - description: The total of the order. - original_subtotal: - type: number - title: original_subtotal - description: The subtotal of the order. - original_tax_total: - type: number - title: original_tax_total - description: The tax total of the order. - total: - type: number - title: total - description: The total of the exchange. - subtotal: - type: number - title: subtotal - description: The subtotal of the exchange. - tax_total: - type: number - title: tax_total - description: The tax total of the exchange. - discount_total: - type: number - title: discount_total - description: The discount total of the exchange. - discount_tax_total: - type: number - title: discount_tax_total - description: The total taxes on discount of the exchange. - gift_card_total: - type: number - title: gift_card_total - description: The gift cards total of the exchange. - gift_card_tax_total: - type: number - title: gift_card_tax_total - description: The total taxes on the gift card of the exchange. - 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 order's shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The order's shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The order's shipping tax total. + order_version: + type: string + title: order_version + description: The version of the order once the exchange is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + order: + $ref: ./AdminOrder.yaml + allow_backorder: + type: boolean + title: allow_backorder + description: >- + Whether variants that are out-of-stock can still be added as additional or + outbound items. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml index 43b16c6438..2ada4ad0d5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangePreviewResponse.yaml @@ -6,6 +6,6 @@ required: - exchange properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.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 index 8c908c82e0..285bbc8842 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeRequestResponse.yaml @@ -7,10 +7,8 @@ required: - exchange properties: return: - description: The associated return's details. $ref: ./AdminReturn.yaml order_preview: - description: A preview of the order once the exchange is applied. - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml 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 index abe845366f..d8ab001ca0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeReturnResponse.yaml @@ -6,6 +6,6 @@ required: - return properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml return: $ref: ./AdminReturn.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 index 80430cd6ad..a459be7817 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillment.yaml @@ -37,10 +37,8 @@ properties: title: shipping_option_id description: The ID of the shipping option this fulfillment is created for. provider: - description: The details of the fulfillment provider using to handle this fulfillment. $ref: ./AdminFulfillmentProvider.yaml delivery_address: - description: The address to deliver the item to. $ref: ./AdminFulfillmentAddress.yaml items: type: array 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..a60a87734e 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,15 @@ type: object -description: The shipping option's provider. +description: The fulfillment provider's details. x-schemaName: AdminFulfillmentProvider +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/AdminFulfillmentSet.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml index e9131c3f4a..ba5f3c0d07 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSet.yaml @@ -1,5 +1,5 @@ type: object -description: The fulfillment set's parent. +description: The service zone's fulfillment set. x-schemaName: AdminFulfillmentSet required: - id @@ -14,34 +14,34 @@ properties: id: type: string title: id - description: The parent's ID. + description: The fulfillment set's ID. name: type: string title: name - description: The parent's name. + description: The fulfillment set's name. type: type: string title: type - description: The parent's type. + description: The fulfillment set's type. location: $ref: ./AdminStockLocation.yaml service_zones: type: array - description: The parent's service zones. + description: The fulfillment set's service zones. items: $ref: ./AdminServiceZone.yaml created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The fulfillment set's created at. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The fulfillment set's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The fulfillment set's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml index b5f823157e..e455cca7a6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminFulfillmentSetResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The fulfillment set's details. x-schemaName: AdminFulfillmentSetResponse required: - fulfillment_set diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml index fcdcef3406..c7d0be5d77 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminGeoZone.yaml @@ -1,5 +1,5 @@ type: object -description: The geo zone's details. +description: The geo zone's geo zones. x-schemaName: AdminGeoZone required: - id @@ -43,14 +43,14 @@ properties: type: string format: date-time title: created_at - description: The date the geo zone was created. + description: The geo zone's created at. updated_at: type: string format: date-time title: updated_at - description: The date the geo zone was update. + description: The geo zone's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The date the geo zone was deleted. + description: The geo zone's deleted at. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminImportProductRequest.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminImportProductRequest.yaml index 94efb6c2bd..8aac0f128a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminImportProductRequest.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminImportProductRequest.yaml @@ -5,4 +5,9 @@ required: - file properties: file: - $ref: ./File.yaml + type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: file diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml index c2c758a65c..287a08bd99 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryItem.yaml @@ -1,5 +1,5 @@ type: object -description: The inventory item's details. +description: The reservation's inventory item. x-schemaName: AdminInventoryItem required: - id @@ -12,7 +12,7 @@ properties: sku: type: string title: sku - description: The inventory item's SKU. + description: The inventory item's sku. origin_country: type: string title: origin_country @@ -20,15 +20,15 @@ properties: hs_code: type: string title: hs_code - description: The inventory item's HS code. + description: The inventory item's hs code. requires_shipping: type: boolean title: requires_shipping - description: Whether the inventory item requires shipping. + description: The inventory item's requires shipping. mid_code: type: string title: mid_code - description: The inventory item's MID code. + description: The inventory item's mid code. material: type: string title: material @@ -60,12 +60,12 @@ properties: thumbnail: type: string title: thumbnail - description: The URL of the inventory item's thumbnail. + description: The inventory item's thumbnail. metadata: type: object - description: The inventory item's metadata, can hold custom key-value pairs. + description: The inventory item's metadata. location_levels: type: array - description: The inventory item's associated inventory levels. + description: The inventory item's location levels. items: $ref: ./AdminInventoryLevel.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml index 91bd9eaab4..d7802818c2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminInventoryLevel.yaml @@ -1,5 +1,5 @@ type: object -description: The inventory level's details. +description: The location level's location levels. x-schemaName: AdminInventoryLevel required: - id @@ -9,67 +9,56 @@ required: - inventory_item_id - location_id - stocked_quantity - - raw_stocked_quantity - reserved_quantity - - raw_reserved_quantity - incoming_quantity - - raw_incoming_quantity - metadata - available_quantity properties: id: type: string title: id - description: The inventory level's ID. - inventory_item_id: - type: string - title: inventory_item_id - description: The ID of the inventory item this level belongs to. - location_id: - type: string - title: location_id - description: The ID of the stock location this level belongs to. - stocked_quantity: - type: number - title: stocked_quantity - description: >- - The quantity of the associated inventory item stocked in the associated - stock location. - reserved_quantity: - type: number - title: reserved_quantity - description: >- - The reserved quantity of the associated inventory item stocked in the - associated stock location. - incoming_quantity: - type: number - title: incoming_quantity - description: >- - The incoming quantity of the associated inventory item stocked in the - associated stock location. - metadata: - type: object - description: The location level's metadata, can hold custom key-value pairs. - inventory_item: - $ref: ./AdminInventoryItem.yaml - available_quantity: - type: number - title: available_quantity - description: >- - The quantity available for order of the associated inventory item in the - associated stock location. + description: The location level's ID. created_at: type: string format: date-time title: created_at - description: The date the inventory level was created. + description: The location level's created at. updated_at: type: string format: date-time title: updated_at - description: The date the inventory level was updated. + description: The location level's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The date the inventory level was deleted. + description: The location level's deleted at. + inventory_item_id: + type: string + title: inventory_item_id + description: The location level's inventory item id. + location_id: + type: string + title: location_id + description: The location level's location id. + stocked_quantity: + type: number + title: stocked_quantity + description: The location level's stocked quantity. + reserved_quantity: + type: number + title: reserved_quantity + description: The location level's reserved quantity. + incoming_quantity: + type: number + title: incoming_quantity + description: The location level's incoming quantity. + metadata: + type: object + description: The location level's metadata. + inventory_item: + type: object + available_quantity: + type: number + title: available_quantity + description: The location level's available quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index 4d56258b6e..e90b9b2d8f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -3,21 +3,20 @@ description: The order's details. x-schemaName: AdminOrder required: - payment_collections + - items + - shipping_methods + - currency_code - id + - created_at + - updated_at + - email - 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 @@ -50,7 +49,7 @@ properties: type: array description: The order's fulfillments. items: - $ref: ./BaseOrderFulfillment.yaml + $ref: ./AdminOrderFulfillment.yaml sales_channel: $ref: ./AdminSalesChannel.yaml customer: @@ -96,12 +95,12 @@ properties: type: array description: The order's items. items: - $ref: ./BaseOrderLineItem.yaml + $ref: ./AdminOrderLineItem.yaml shipping_methods: type: array description: The order's shipping methods. items: - $ref: ./BaseOrderShippingMethod.yaml + $ref: ./AdminOrderShippingMethod.yaml payment_status: type: string description: The order's payment status. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml new file mode 100644 index 0000000000..3297e8bcca --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml @@ -0,0 +1,142 @@ +type: object +description: The order change's details. +x-schemaName: AdminOrderChange +required: + - order + - claim + - return_order + - exchange + - actions + - status + - order_id + - metadata + - id + - created_at + - updated_at + - version + - canceled_at + - return_id + - exchange_id + - claim_id + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - declined_at + - canceled_by +properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: >- + The order change's version. This will be the order's version when the + change is applied. + change_type: + type: string + description: The order change's type. + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The ID of the order this change applies on. + return_id: + type: string + title: return_id + description: The ID of the associated return. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + return_order: + $ref: ./AdminReturn.yaml + exchange: + $ref: ./AdminExchange.yaml + claim: + $ref: ./AdminClaim.yaml + actions: + type: array + description: The order change's actions. + items: + $ref: ./AdminOrderChangeAction.yaml + status: + type: string + description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined + requested_by: + type: string + title: requested_by + description: The ID of the user that requested the change. + requested_at: + type: string + title: requested_at + description: The date the order change was requested. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The ID of the user that confirmed the order change. + confirmed_at: + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time + declined_by: + type: string + title: declined_by + description: The ID of the user that declined the order change. + declined_reason: + type: string + title: declined_reason + description: The reason the order change was declined. + metadata: + type: object + description: The order change's metadata, can hold custom key-value pairs. + declined_at: + type: string + title: declined_at + description: The date the order change was declined. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The ID of the user that canceled the order change. + canceled_at: + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The date the order change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml new file mode 100644 index 0000000000..3f93eb71ce --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml @@ -0,0 +1,104 @@ +type: object +description: The order change action's details. +x-schemaName: AdminOrderChangeAction +required: + - order_change + - order + - order_id + - internal_note + - id + - created_at + - updated_at + - return_id + - exchange_id + - claim_id + - order_change_id + - reference + - reference_id + - action + - details +properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml index 0126a1ad99..7e5bb2a7d5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangesResponse.yaml @@ -8,4 +8,4 @@ properties: type: array description: An order's changes. items: - $ref: ./BaseOrderChange.yaml + $ref: ./AdminOrderChange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml index ec43c247ff..02858b85ad 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditPreviewResponse.yaml @@ -5,4 +5,4 @@ required: - order_preview properties: order_preview: - $ref: ./OrderPreview.yaml + $ref: ./AdminOrderPreview.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditResponse.yaml index db40b31387..9cbc0f6528 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderEditResponse.yaml @@ -5,4 +5,4 @@ required: - order_change properties: order_change: - $ref: ./OrderChange.yaml + $ref: ./AdminOrderChange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml new file mode 100644 index 0000000000..e1312673f4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderFulfillment.yaml @@ -0,0 +1,79 @@ +type: object +description: The fulfillment's details. +x-schemaName: AdminOrderFulfillment +required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - requires_shipping + - 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 ID of the location the items are fulfilled from. + packed_at: + type: string + title: packed_at + description: The date the items were packed. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The date the items were shipped. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The date the items were delivered. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The date the items were canceled. + format: date-time + data: + type: object + description: >- + Data useful for the fulfillment provider handling it. This is taken from + the associated shipping option. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider used to handle the fulfillment. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + metadata: + type: object + description: The fulfillment's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the fulfillment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the fulfillment was updated. + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the fulfillment requires shipping. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml new file mode 100644 index 0000000000..41d7121777 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml @@ -0,0 +1,213 @@ +type: object +description: The item's details. +x-schemaName: AdminOrderLineItem +required: + - title + - metadata + - id + - subtitle + - thumbnail + - created_at + - updated_at + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - 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 + - 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 URL of the item's thumbnail. + variant: + $ref: ./AdminProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: ./AdminProduct.yaml + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the collection the item's product belongs to. + 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 values of the item variant's options. + example: + Color: Blue + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + 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: + type: object + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item, excluding promotions. + item_total: + type: number + title: item_total + description: The total taxes of the item, including promotions. + item_subtotal: + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of the item, including promotions. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the item including promotions. + discount_total: + type: number + title: discount_total + description: The total discount amount of the item. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total refundable amount of the item's total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total refundable amount of the item's total for a single quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml index 1d24582bdf..fef57add5b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -7,19 +7,18 @@ required: - return_requested_total - order_change - currency_code - - version - id + - created_at + - updated_at + - email + - 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 @@ -48,7 +47,7 @@ properties: title: return_requested_total description: The total of the requested return. order_change: - $ref: ./BaseOrderChange.yaml + $ref: ./AdminOrderChange.yaml items: type: array description: The order's items. @@ -120,7 +119,7 @@ properties: title: variant_id description: The ID of the associated variant. product: - $ref: ./BaseProduct.yaml + $ref: ./AdminProduct.yaml product_id: type: string title: product_id @@ -181,8 +180,8 @@ properties: description: Whether the item's price includes taxes. compare_at_unit_price: type: number - title: The original price of the item before a promotion or sale. - description: The + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -519,7 +518,7 @@ properties: type: array description: The order's fulfillments. items: - $ref: ./BaseOrderFulfillment.yaml + $ref: ./AdminOrderFulfillment.yaml fulfillment_status: type: string description: The order's fulfillment status. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml new file mode 100644 index 0000000000..ab93242120 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderShippingMethod.yaml @@ -0,0 +1,116 @@ +type: object +description: The shipping method's details. +x-schemaName: AdminOrderShippingMethod +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 ID of the order the shipping method belongs to. + 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: Whether the shipping method's amount includes applied taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: >- + The shipping method's data, useful for fulfillment provider handling its + fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The shipping method's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The total discounts applied on the shipping method. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + detail: + $ref: ./BaseOrderShippingDetail.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 index c03bcea935..2549b218cb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPayment.yaml @@ -86,8 +86,8 @@ properties: type: array description: The details of payment refunds. items: - $ref: ./BaseRefund.yaml + $ref: ./AdminRefund.yaml payment_collection: - $ref: ./BasePaymentCollection.yaml + type: object payment_session: - $ref: ./BasePaymentSession.yaml + $ref: ./AdminPaymentSession.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 index c6fa1d3cac..75d1731804 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentCollection.yaml @@ -2,12 +2,12 @@ type: object description: The payment collection's details. x-schemaName: AdminPaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -70,14 +70,14 @@ properties: The payment provider used to process the collection's payments and sessions. items: - $ref: ./BasePaymentProvider.yaml + $ref: ./AdminPaymentProvider.yaml payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: ./BasePaymentSession.yaml + $ref: ./AdminPaymentSession.yaml payments: type: array description: The payment collection's payments. items: - $ref: ./BasePayment.yaml + $ref: ./AdminPayment.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPaymentSession.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentSession.yaml new file mode 100644 index 0000000000..b87f3a855c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPaymentSession.yaml @@ -0,0 +1,61 @@ +type: object +description: The payment session's details. +x-schemaName: AdminPaymentSession +properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: >- + The payment session's data, useful for the payment provider processing the + payment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: ./BasePayment.yaml +required: + - id + - amount + - currency_code + - provider_id + - data + - status 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 f8bf5ad600..e197602dfa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -2,15 +2,15 @@ type: object description: The product's details. x-schemaName: AdminProduct required: + - variants - type + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - handle - subtitle - is_giftcard @@ -24,9 +24,10 @@ required: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: collection: @@ -73,7 +74,7 @@ properties: type: array description: The product's options. items: - $ref: ./BaseProductOption.yaml + $ref: ./AdminProductOption.yaml description: type: string title: description @@ -151,7 +152,7 @@ properties: type: array description: The product's images. items: - $ref: ./BaseProductImage.yaml + $ref: ./AdminProductImage.yaml discountable: type: boolean title: discountable diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml new file mode 100644 index 0000000000..050650545a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductImage.yaml @@ -0,0 +1,33 @@ +type: object +description: The image's details. +x-schemaName: AdminProductImage +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. +required: + - id + - url diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml index bb9c3717ae..415115c416 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOption.yaml @@ -1,5 +1,5 @@ type: object -description: The product's product option. +description: The product option's details. x-schemaName: AdminProductOption required: - id @@ -14,31 +14,31 @@ properties: title: title description: The product option's title. product: - $ref: ./BaseProduct.yaml + type: object product_id: type: string title: product_id - description: The product option's product id. + description: The ID of the product this option belongs to. values: type: array description: The product option's values. items: - $ref: ./BaseProductOptionValue.yaml + type: object metadata: type: object - description: The product option's metadata. + description: The product option's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The product option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The product option's deleted at. + description: The date the product option was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml index 0873a46f9a..0069070c06 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product option deletion. x-schemaName: AdminProductOptionDeleteResponse required: - id @@ -9,14 +9,15 @@ properties: id: type: string title: id - description: The product's ID. + description: The product option's ID. object: type: string title: object description: The name of the deleted object. + default: product_option deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product option was deleted. parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml index c609e7d1d8..79d305a5d3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product option's details. x-schemaName: AdminProductOptionResponse required: - product_option diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml new file mode 100644 index 0000000000..88175464a4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductOptionValue.yaml @@ -0,0 +1,39 @@ +type: object +description: The product option value's details. +x-schemaName: AdminProductOptionValue +required: + - id + - value +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + $ref: ./AdminProductOption.yaml + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml index 1c3d489857..5b4cd3889b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product's details. x-schemaName: AdminProductResponse required: - product diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml index c9dfaff0fb..7fc320de89 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTag.yaml @@ -1,5 +1,5 @@ type: object -description: The tag's tags. +description: The product tag's details. x-schemaName: AdminProductTag required: - id @@ -19,17 +19,17 @@ properties: type: string format: date-time title: created_at - description: The tag's created at. + description: The date the tag was created. updated_at: type: string format: date-time title: updated_at - description: The tag's updated at. + description: The date the tag was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tag's deleted at. + description: The date the tag was deleted. metadata: type: object - description: The tag's metadata. + description: The tag's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml index 33697dcfd2..b09f96dd0f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product tag deletion. x-schemaName: AdminProductTagDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product Tag was deleted. + description: Whether the product tag was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml index 40accb6692..72220d7041 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product tags. x-schemaName: AdminProductTagListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product tag's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product tag's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product tag's count. + description: The total number of items. product_tags: type: array - description: The product tag's product tags. + description: The list of 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 index 47fe1ad408..4ae92f3bef 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTagResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTagResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product tag's details. x-schemaName: AdminProductTagResponse required: - product_tag diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml index a8d58344ea..ef5f2ece56 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductType.yaml @@ -1,5 +1,5 @@ type: object -description: The parent's type. +description: The product type's details. x-schemaName: AdminProductType required: - id @@ -19,17 +19,17 @@ properties: type: string format: date-time title: created_at - description: The type's created at. + description: The date the type was created. updated_at: type: string format: date-time title: updated_at - description: The type's updated at. + description: The date the type was updated. deleted_at: type: string format: date-time title: deleted_at - description: The type's deleted at. + description: The date the type was deleted. metadata: type: object - description: The type's metadata. + description: The type's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml index 797b5fd754..4526de1ff6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product type deletion. x-schemaName: AdminProductTypeDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product Type was deleted. + description: Whether the product type was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml index 9bf9f9159f..19fa220fe9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product types. x-schemaName: AdminProductTypeListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product type's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product type's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product type's count. + description: The total number of items. product_types: type: array - description: The product type's product types. + description: The list of product types. items: $ref: ./AdminProductType.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 index 8daf16a292..d0907f2d65 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductTypeResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product type's details. x-schemaName: AdminProductTypeResponse required: - product_type 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 8e82d12e9d..702673830d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -1,8 +1,9 @@ type: object -description: The product's parent. +description: The product variant's details. x-schemaName: AdminProductVariant required: - prices + - options - id - title - sku @@ -19,116 +20,119 @@ required: - length - height - width - - options - created_at - updated_at - deleted_at properties: prices: type: array - description: The parent's prices. + description: The variant's prices. items: $ref: ./AdminPrice.yaml id: type: string title: id - description: The parent's ID. + description: The variant's ID. title: type: string title: title - description: The parent's title. + description: The variant's title. sku: type: string title: sku - description: The parent's sku. + description: The variant's SKU. barcode: type: string title: barcode - description: The parent's barcode. + description: The variant's barcode. ean: type: string title: ean - description: The parent's ean. + description: The variant's EAN code. upc: type: string title: upc - description: The parent's upc. + description: The variant's UPC. allow_backorder: type: boolean title: allow_backorder - description: The parent's allow backorder. + description: Whether the variant can be ordered even if it's out of stock. manage_inventory: type: boolean title: manage_inventory - description: The parent's manage inventory. + description: >- + Whether the Medusa application manages the variant's inventory quantity + and availablility. If disabled, the variant is always considered in stock. inventory_quantity: type: number title: inventory_quantity - description: The parent's inventory quantity. + description: >- + The variant's inventory quantity. This is only included if you pass in the + `fields` query parameter a `+variants.inventory_quantity` parameter. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The variant's HS code. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The variant's origin country. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The variant's MID code. material: type: string title: material - description: The parent's material. + description: The variant's material. weight: type: number title: weight - description: The parent's weight. + description: The variant's weight. length: type: number title: length - description: The parent's length. + description: The variant's length. height: type: number title: height - description: The parent's height. + description: The variant's height. width: type: number title: width - description: The parent's width. + description: The variant's width. variant_rank: type: number title: variant_rank - description: The parent's variant rank. + description: The variant's rank among its sibling variants. options: type: array - description: The parent's options. + description: The variant's option values. items: - $ref: ./BaseProductOptionValue.yaml + $ref: ./AdminProductOptionValue.yaml product: - $ref: ./BaseProduct.yaml + type: object product_id: type: string title: product_id - description: The parent's product id. + description: The ID of the product that the variant belongs to. calculated_price: $ref: ./BaseCalculatedPriceSet.yaml created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the variant was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the variant was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the variant was deleted. metadata: type: object - description: The parent's metadata. + description: The variant's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml index 52094f9db2..01b28d3e65 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the product variant's deletion. x-schemaName: AdminProductVariantDeleteResponse required: - id @@ -9,7 +9,7 @@ properties: id: type: string title: id - description: The product's ID. + description: The product variant's ID. object: type: string title: object @@ -17,6 +17,7 @@ properties: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product variant was deleted. + default: variant parent: $ref: ./AdminProduct.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml index 9cf2e1c985..bf33c4a708 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryBatchResponse.yaml @@ -1,5 +1,7 @@ type: object -description: SUMMARY +description: >- + The created, updated, and deleted associations between variants and inventory + items. x-schemaName: AdminProductVariantInventoryBatchResponse required: - created @@ -10,10 +12,12 @@ properties: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: The product's created. + description: The created associations between product variants and inventory items. items: type: object - description: The created's details. + description: >- + A created association between a product variant and an inventory + item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -21,32 +25,34 @@ properties: properties: productService: type: object - description: The created's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The created's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. updated: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: The product's updated. + description: The updated associations between product variants and inventory items. items: type: object - description: The updated's details. + description: >- + An updated association between a product variant and an inventory + item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -54,32 +60,34 @@ properties: properties: productService: type: object - description: The updated's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The updated's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. deleted: oneOf: - $ref: ./AdminProductVariantInventoryLink.yaml - type: array - description: SUMMARY + description: The deleted associations between product variants and inventory items. items: type: object - description: SUMMARY + description: >- + An deleted association between a product variant and an inventory + item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -87,21 +95,21 @@ properties: properties: productService: type: object - description: The deleted's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The deleted's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml index e5938e984d..d3aa5709dc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLink.yaml @@ -1,27 +1,27 @@ type: object -description: The product's ID. +description: The details of an association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - - productService - - inventoryService + - Product + - Inventory properties: - productService: + Product: type: object - description: The id's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. - inventoryService: + description: The ID of the product variant. + Inventory: type: object - description: The id's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml index ba2ab976f9..377a954ac4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantInventoryLinkDeleteResponse.yaml @@ -1,5 +1,7 @@ type: object -description: SUMMARY +description: >- + The details of the deleted associated between a product variant and an + inventory item. x-schemaName: AdminProductVariantInventoryLinkDeleteResponse required: - id @@ -13,9 +15,10 @@ properties: type: string title: object description: The name of the deleted object. + default: variant-inventory-item-link deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the association was 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 deleted file mode 100644 index 6ea415b06d..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantParams.yaml +++ /dev/null @@ -1,872 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: AdminProductVariantParams -properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. - items: - type: string - title: id - description: The id's ID. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - created_at: - type: object - description: The product's created at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers - and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful - for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers and - dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful for - numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - updated_at: - type: object - description: The product's updated at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers - and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful - for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers and - dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful for - numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - deleted_at: - type: object - description: The product's deleted at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is - the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers - and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful - for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers and - dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful for - numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - limit: - type: number - title: limit - description: The product's limit. - offset: - type: number - title: offset - description: The product's offset. - order: - type: string - title: order - description: The product's order. - fields: - type: string - title: fields - description: The product's fields. - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $or diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml index cb5298721d..8bd93d75bc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariantResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product variant's details. x-schemaName: AdminProductVariantResponse required: - variant diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml index 2a31b4ded7..78c1a5b3fb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotion.yaml @@ -4,6 +4,13 @@ x-schemaName: AdminPromotion required: - id properties: + application_method: + type: object + rules: + type: array + description: The promotion's rules. + items: + $ref: ./AdminPromotionRule.yaml id: type: string title: id @@ -12,6 +19,7 @@ properties: type: string title: code description: The promotion's code. + example: OFF50 type: type: string description: The promotion's type. @@ -21,17 +29,12 @@ properties: 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 + description: >- + Whether the promotion is applied on a cart automatically if it matches the + promotion's rules. campaign_id: type: string title: campaign_id - description: The promotion's campaign id. + description: The ID of the campaign this promotion belongs to. campaign: $ref: ./AdminCampaign.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 index 3a4255fe94..76ea15b558 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The promotion's details. x-schemaName: AdminPromotionResponse required: - promotion diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml index 010bb3dc39..30666b43dd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPromotionRule.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's details. +description: The promotion rule's details. x-schemaName: AdminPromotionRule required: - id @@ -8,18 +8,19 @@ properties: id: type: string title: id - description: The updated's ID. + description: The promotion rule's ID. description: type: string title: description - description: The updated's description. + description: The promotion rule's description. attribute: type: string title: attribute - description: The updated's attribute. + description: The promotion rule's attribute. + example: customer_group_id operator: type: string - description: The updated's operator. + description: The rule's operator. enum: - gt - lt @@ -30,6 +31,8 @@ properties: - gte values: type: array - description: The updated's values. + description: The rule's values. + example: + - cusgroup_123 items: $ref: ./BasePromotionRuleValue.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRefund.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRefund.yaml new file mode 100644 index 0000000000..229fb7729c --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRefund.yaml @@ -0,0 +1,38 @@ +type: object +description: The refund's details. +x-schemaName: AdminRefund +required: + - id + - amount + - created_at + - payment +properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + $ref: ./BasePayment.yaml + refund_reason: + $ref: ./RefundReason.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 index 3110520654..919bb56bfa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRefundReason.yaml @@ -22,14 +22,14 @@ properties: description: The refund reason's description. metadata: type: object - description: The refund reason's metadata. + description: The refund reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The refund reason's created at. + description: The date the refund reason was created. updated_at: type: string format: date-time title: updated_at - description: The refund reason's updated at. + description: The date the refund reason was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml index 0ad92660d5..96b6ff979c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegion.yaml @@ -2,9 +2,9 @@ type: object description: The region's details. x-schemaName: AdminRegion required: - - id - name - currency_code + - id properties: id: type: string @@ -18,15 +18,16 @@ properties: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are applied automatically during checkout. countries: type: array description: The region's countries. items: - $ref: ./BaseRegionCountry.yaml + $ref: ./AdminRegionCountry.yaml payment_providers: type: array description: The region's payment providers. @@ -34,14 +35,14 @@ properties: $ref: ./AdminPaymentProvider.yaml metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml index 04938da440..88ca70090b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegionCountry.yaml @@ -1,3 +1,33 @@ type: object -description: The billing address's country. +description: The country's details. x-schemaName: AdminRegionCountry +required: + - id +properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml index fc2373ff77..390c84603e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRegionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The region's details. x-schemaName: AdminRegionResponse required: - region diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml index df021b64bd..2b75d1102d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservation.yaml @@ -9,7 +9,6 @@ required: - external_id - description - inventory_item_id - - inventory_item properties: id: type: string @@ -18,11 +17,11 @@ properties: line_item_id: type: string title: line_item_id - description: The reservation's line item id. + description: The ID of the line item this reservation is for. location_id: type: string title: location_id - description: The reservation's location id. + description: The ID of the location the quantity is reserved from. quantity: type: number title: quantity @@ -30,7 +29,7 @@ properties: external_id: type: string title: external_id - description: The reservation's external id. + description: An ID in an external system description: type: string title: description @@ -38,29 +37,28 @@ properties: inventory_item_id: type: string title: inventory_item_id - description: The reservation's inventory item id. + description: The ID of the inventory item this reservation is associated with. inventory_item: - type: object - description: The reservation's inventory item. + $ref: ./AdminInventoryItem.yaml metadata: type: object - description: The reservation's metadata. + description: The reservation's metadata, can hold custom key-value pairs. created_by: type: string title: created_by - description: The reservation's created by. + description: The ID of the user that created this reservation. deleted_at: type: string format: date-time title: deleted_at - description: The reservation's deleted at. + description: The date this reservation was deleted. created_at: type: string format: date-time title: created_at - description: The reservation's created at. + description: The date this reservation was created. updated_at: type: string format: date-time title: updated_at - description: The reservation's updated at. + description: The date this reservation was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml index 42075fd8ac..4db926c72b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReservationResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The reservation's details. x-schemaName: AdminReservationResponse required: - reservation diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml index 0ef197d0f7..6ff3c2867d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturn.yaml @@ -1,12 +1,12 @@ type: object -description: The exchange's return. +description: The return's details. x-schemaName: AdminReturn required: + - items - id - order_id - order_version - display_id - - items - received_at - created_at - canceled_at @@ -15,14 +15,37 @@ properties: type: string title: id description: The return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. order_id: type: string title: order_id - description: The return's order id. - status: + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: ./AdminReturnItem.yaml + created_at: type: string - title: status - description: The return's status. + format: date-time + title: created_at + description: The date the return was created. + canceled_at: + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time exchange_id: type: string title: exchange_id @@ -46,26 +69,10 @@ properties: 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 + description: >- + Whether the customer should receive notifications about the return's + updates. 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. - canceled_at: - type: string - title: canceled_at - description: The return's canceled at. + description: The date the return was received. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml index 47cbe93e16..96691fc7ca 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnItem.yaml @@ -1,5 +1,5 @@ type: object -description: The return item's return items. +description: The return item's details. x-schemaName: AdminReturnItem required: - id @@ -20,27 +20,31 @@ properties: received_quantity: type: number title: received_quantity - description: The return item's received quantity. + description: >- + The received quantity of the item. This quantity is added to the stocked + inventory quantity of the item. damaged_quantity: type: number title: damaged_quantity - description: The return item's damaged quantity. + description: >- + The received damaged quantity of the item, which isn't added to the + stocked inventory quantity of the item. reason_id: type: string title: reason_id - description: The return item's reason id. + description: The ID of the return reason associated with the item. note: type: string title: note - description: The return item's note. + description: A note about why the item was returned. item_id: type: string title: item_id - description: The return item's item id. + description: The ID of the associated order item. return_id: type: string title: return_id - description: The return item's return id. + description: The ID of the return this return item belongs to. metadata: type: object - description: The return item's metadata. + description: The return item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml index 8b8734b2fe..a7958ba7de 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnPreviewResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of a return and a preview of the order once the return is applied. x-schemaName: AdminReturnPreviewResponse required: - order_preview diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml index 3046e2a254..7de3166b71 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReason.yaml @@ -26,14 +26,14 @@ properties: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml index 3743526610..7d69be5a27 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the return reason deletion. x-schemaName: AdminReturnReasonDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Return Reason was deleted. + description: Whether the return reason was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml index 0fa69fc517..4f931ef219 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of return reasons. x-schemaName: AdminReturnReasonListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The return reason's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The return reason's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The return reason's count. + description: The total number of items. return_reasons: type: array - description: The return reason's return reasons. + description: The list of 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 index 9b3ad0f9a4..513915d0c3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnReasonResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return reason's details. x-schemaName: AdminReturnReasonResponse required: - return_reason diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml index 8ce9535394..3e0fe4d159 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminReturnResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: AdminReturnResponse required: - return diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml index 7e99903e5b..af00ccb2fe 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRevokeApiKey.yaml @@ -1,8 +1,10 @@ type: object -description: SUMMARY +description: The details of revoking the API key. x-schemaName: AdminRevokeApiKey properties: revoke_in: type: number title: revoke_in - description: The api key's revoke in. + description: >- + The time in seconds to revoke the API key after. If not set, the API key + is revoked immediately. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml index 8ca5eaabf3..53359ab0b4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRuleAttributeOption.yaml @@ -1,39 +1,27 @@ type: object -description: The attribute's attributes. +description: The details of a potential rule attribute. x-schemaName: AdminRuleAttributeOption required: - id - value - label - - field_type - - required - - disguised - operators properties: id: type: string title: id - description: The attribute's ID. + description: The rule attribute's ID, which is a rule's `attribute` it refers to. + example: customer_group value: type: string title: value - description: The attribute's value. + description: The rule attribute's value. + example: customer.groups.id 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. + description: The rule attribute option's label. + example: Customer Group operators: type: array description: The attribute's operators. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml index cb8776ea83..fbfa2d15c8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminRuleValueOption.yaml @@ -1,20 +1,17 @@ type: object -description: The value's values. +description: The details of a potential rule value. 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. + description: The rule value's value. + example: reg_123 label: type: string title: label - description: The value's label. + description: The rule value's label. + example: Europe Region diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml index 9b497e936c..2311a9b687 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannel.yaml @@ -1,5 +1,5 @@ type: object -description: The order's sales channel. +description: The sales channel's details. x-schemaName: AdminSalesChannel required: - id @@ -26,22 +26,22 @@ properties: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The sales channel's created at. + description: The date the sales channel was created. updated_at: type: string format: date-time title: updated_at - description: The sales channel's updated at. + description: The date the sales channel was updated. deleted_at: type: string format: date-time title: deleted_at - description: The sales channel's deleted at. + description: The date the sales channel was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml index fc93322002..0c2d3161a8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of deleting a sales channel. x-schemaName: AdminSalesChannelDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Sales Channel was deleted. + description: Whether the sales channel was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml index baeb779f03..bd930a26a7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminSalesChannelResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The sales channel's details. x-schemaName: AdminSalesChannelResponse required: - sales_channel 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 d0dff34efc..425c15722a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZone.yaml @@ -1,5 +1,5 @@ type: object -description: The service zone's service zones. +description: The shipping option's service zone. x-schemaName: AdminServiceZone required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml index 488b2b6081..7f3224a432 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the service zone deletion. x-schemaName: AdminServiceZoneDeleteResponse required: - id @@ -9,14 +9,15 @@ properties: id: type: string title: id - description: The fulfillment set's ID. + description: The service zone's ID. object: type: string title: object description: The name of the deleted object. + default: service_zone deleted: type: boolean title: deleted - description: Whether the Fulfillment Set was deleted. + description: Whether the service zone was deleted. parent: $ref: ./AdminFulfillmentSet.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml index dd8ff8c8d1..32685446d3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminServiceZoneResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The service zone's details. x-schemaName: AdminServiceZoneResponse required: - service_zone diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml index 219dac6bdc..7cb57ee389 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOption.yaml @@ -1,3 +1,105 @@ type: object -description: The shipping option's shipping options. +description: The shipping option's details. x-schemaName: AdminShippingOption +required: + - id + - name + - price_type + - service_zone_id + - service_zone + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - shipping_profile + - rules + - prices + - data + - metadata + - created_at + - updated_at + - deleted_at +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 + description: >- + The shipping option's price type. If it's `flat`, the price is fixed and + is set in the `prices` property. If it's `calculated`, the price is + calculated on checkout by the associated fulfillment provider. + enum: + - calculated + - flat + service_zone_id: + type: string + title: service_zone_id + description: The ID of the service zone this option belongs to. + service_zone: + type: object + provider_id: + type: string + title: provider_id + description: >- + The ID of the provider handling fulfillments created from this shipping + option. + provider: + $ref: ./AdminFulfillmentProvider.yaml + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The ID of the associated shipping option type. + type: + $ref: ./AdminShippingOptionType.yaml + shipping_profile_id: + type: string + title: shipping_profile_id + description: The ID of the associated shipping profile. + shipping_profile: + $ref: ./AdminShippingProfile.yaml + rules: + type: array + description: The shipping option's rules. + items: + $ref: ./AdminShippingOptionRule.yaml + prices: + type: array + description: >- + The shipping option's prices. If the `price_type` is `calculated`, this + array will be empty since the price is calculated by the fulfillment + provider during checkout. + items: + $ref: ./AdminShippingOptionPrice.yaml + data: + type: object + description: >- + The shipping option's data, useful for the fulfillment provider handling + fulfillments created from this option. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml index 141ba6526b..459667c5ec 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the shipping option's deletion. x-schemaName: AdminShippingOptionDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Shipping Option was deleted. + description: Whether the shipping option was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPrice.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPrice.yaml new file mode 100644 index 0000000000..95f76292c0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPrice.yaml @@ -0,0 +1,76 @@ +type: object +description: The details of the shipping option's price. +x-schemaName: AdminShippingOptionPrice +required: + - price_rules + - rules_count + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at +properties: + price_rules: + type: array + description: The price's rules. + items: + $ref: ./AdminShippingOptionPriceRule.yaml + rules_count: + type: number + title: rules_count + description: The number of rules the price has. + 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. + example: usd + 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 minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: >- + The maximum quantity that the cart's items must not surpass for this price + to apply. + price_set_id: + type: string + title: price_set_id + description: The ID of the price set this price belongs to. + created_at: + type: string + format: date-time + title: created_at + description: The date the price was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the price was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the price was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPriceRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPriceRule.yaml new file mode 100644 index 0000000000..a705731a41 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionPriceRule.yaml @@ -0,0 +1,15 @@ +type: object +description: The details of a shipping option price's rule. +x-schemaName: AdminShippingOptionPriceRule +required: + - id + - value +properties: + id: + type: string + title: id + description: The price rule's ID. + value: + type: string + title: value + description: The price rule's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml index dba509d7fd..b0b01a94ab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping option's details. x-schemaName: AdminShippingOptionResponse required: - shipping_option diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml index ed10fb27e4..26069d9a56 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionRule.yaml @@ -1,5 +1,5 @@ type: object -description: The updated's details. +description: The shipping option rule's details. x-schemaName: AdminShippingOptionRule required: - id @@ -14,42 +14,46 @@ properties: id: type: string title: id - description: The updated's ID. + description: The shipping option rule's ID. attribute: type: string title: attribute - description: The updated's attribute. + description: The shipping option rule's attribute. + example: is_return operator: type: string title: operator - description: The updated's operator. + description: The shipping option rule's operator. + example: eq value: oneOf: - type: string title: value - description: The updated's value. + description: The rule's value. + example: '"true"' - type: array - description: The updated's value. + description: The rule's values. items: type: string title: value - description: The value's details. + description: A rule's value + example: '"true"' shipping_option_id: type: string title: shipping_option_id - description: The updated's shipping option id. + description: The ID of the shipping option this rule is for. created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The date the shipping option rule was created. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The date the shipping option rule was updated. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The date the shipping option rule was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionType.yaml new file mode 100644 index 0000000000..9aa2063d7e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingOptionType.yaml @@ -0,0 +1,48 @@ +type: object +description: The shipping option's details. +x-schemaName: AdminShippingOptionType +required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The shipping option's ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The type's shipping option id. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml index 29549d5ff2..1dc31c1b5b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfile.yaml @@ -1,3 +1,42 @@ type: object -description: The shipping option's shipping profile. +description: The shipping profile's details.. x-schemaName: AdminShippingProfile +properties: + id: + type: string + title: id + description: The shipping profile's ID. + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata, holds custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping profile was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping profile was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping profile was deleted. +required: + - id + - name + - type + - metadata + - created_at + - updated_at + - deleted_at diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml index bca17d5e8b..ed0e931fd6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the shipping profile's deletion. x-schemaName: AdminShippingProfileDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Shipping Profile was deleted. + description: Whether the shipping profile was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml index ce83a08372..00fa3dc1ab 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminShippingProfileResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping profile's details. x-schemaName: AdminShippingProfileResponse required: - shipping_profile diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml index 76f80ec99c..d9a9fedf99 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocation.yaml @@ -1,5 +1,5 @@ type: object -description: The parent's location. +description: The stock location's details. x-schemaName: AdminStockLocation required: - id @@ -17,21 +17,21 @@ properties: address_id: type: string title: address_id - description: The location's address id. + description: The ID of the associated address. address: $ref: ./AdminStockLocationAddress.yaml sales_channels: type: array - description: The location's sales channels. + description: The sales channels associated with the location. items: $ref: ./AdminSalesChannel.yaml fulfillment_providers: type: array - description: The location's fulfillment providers. + description: The fulfillment providers associated with the location. items: $ref: ./AdminFulfillmentProvider.yaml fulfillment_sets: type: array - description: The location's fulfillment sets. + description: The fulfillment sets associated with the location. 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 index 03be8aa3dd..22dc78b1d4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationAddress.yaml @@ -1,3 +1,51 @@ type: object -description: The location's address. +description: The details of the stock location address. x-schemaName: AdminStockLocationAddress +properties: + id: + type: string + title: id + description: The address's ID. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. +required: + - id + - address_1 + - address_2 + - company + - country_code + - city + - phone + - postal_code + - province diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml index 7d1160157d..cb05f2704a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the stock location's deletion. x-schemaName: AdminStockLocationDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Stock Location was deleted. + description: Whether the stock location was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml index f8181758b1..9f23c06060 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of stock locations. x-schemaName: AdminStockLocationListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The stock location's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The stock location's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The stock location's count. + description: The total number of items. stock_locations: type: array - description: The stock location's stock locations. + description: The list of 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 index 68d6a4db18..19f1d66a39 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStockLocationResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The stock location's details. x-schemaName: AdminStockLocationResponse required: - stock_location diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml index a56500fc7b..32f483dc82 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStore.yaml @@ -28,25 +28,25 @@ properties: default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the sales channel used by default in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the region used by default in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the stock location used by default in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The store's created at. + description: The date the store was created. updated_at: type: string format: date-time title: updated_at - description: The store's updated at. + description: The date the store was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml index 5014c7b7bc..a0e2ccb92d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreCurrency.yaml @@ -1,5 +1,5 @@ type: object -description: The supported currency's supported currencies. +description: The details of a store's currency. x-schemaName: AdminStoreCurrency required: - id @@ -14,33 +14,34 @@ properties: id: type: string title: id - description: The supported currency's ID. + description: The currency's ID. currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd store_id: type: string title: store_id - description: The supported currency's store id. + description: The ID of the store this currency belongs to. is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether this currency is the default in the store. currency: $ref: ./AdminCurrency.yaml created_at: type: string format: date-time title: created_at - description: The supported currency's created at. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The supported currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The supported currency's deleted at. + description: The date the currency was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml index 33099c28f1..639f93778b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of stores. x-schemaName: AdminStoreListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The store's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The store's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The store's count. + description: The total number of items. stores: type: array - description: The store's stores. + description: The list of 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 index c24cc35690..d335ebde98 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminStoreResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminStoreResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The store's details. x-schemaName: AdminStoreResponse required: - store diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml index f0321f5651..7972123ffe 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRate.yaml @@ -1,5 +1,5 @@ type: object -description: The tax rate's parent. +description: The tax rate's details. x-schemaName: AdminTaxRate required: - id @@ -20,57 +20,61 @@ properties: id: type: string title: id - description: The parent's ID. + description: The tax rate's ID. rate: type: number title: rate - description: The parent's rate. + description: The rate to charge. + example: 10 code: type: string title: code - description: The parent's code. + description: The code the tax rate is identified by. name: type: string title: name - description: The parent's name. + description: The tax rate's name. metadata: type: object - description: The parent's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. tax_region_id: type: string title: tax_region_id - description: The parent's tax region id. + description: The ID of the tax region this rate belongs to. is_combinable: type: boolean title: is_combinable - description: The parent's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates is_default: type: boolean title: is_default - description: The parent's is default. + description: Whether this tax rate is the default in the tax region. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the tax rate was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the tax rate was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the tax rate was deleted. created_by: type: string title: created_by - description: The parent's created by. + description: The ID of the user that created the tax rate. tax_region: $ref: ./AdminTaxRegion.yaml rules: type: array - description: The parent's rules. + 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 index 6c284786d9..88c4b0ebb1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the tax rate deletion. x-schemaName: AdminTaxRateDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Tax Rate was deleted. + description: Whether the tax rate was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml index 2dd828e446..e4888f9c3a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The tax rate's details. x-schemaName: AdminTaxRateResponse required: - tax_rate diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml index 8e0ff14b5d..2d88ad2ed8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRateRule.yaml @@ -1,5 +1,5 @@ type: object -description: The rule's rules. +description: The tax rate rule's details. x-schemaName: AdminTaxRateRule required: - reference @@ -8,8 +8,10 @@ properties: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of a record in the table that this rule references. + example: ptyp_1 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml index 5ee5e6b8e0..0c5867f445 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegion.yaml @@ -1,17 +1,11 @@ type: object -description: The parent's tax region. +description: The tax region's details. 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 @@ -25,67 +19,44 @@ properties: 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. + example: us 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. + description: The tax region's metadata, can hold custom key-value pairs. parent_id: type: string title: parent_id - description: The tax region's parent id. + description: The ID of the parent tax region. created_at: type: string format: date-time title: created_at - description: The tax region's created at. + description: The date the tax region was created. updated_at: type: string format: date-time title: updated_at - description: The tax region's updated at. + description: The date the tax region was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tax region's deleted at. + description: The date the tax region was deleted. created_by: type: string title: created_by - description: The tax region's created by. + description: The ID of the user that created the tax region. tax_rates: type: array - description: The tax region's tax rates. + description: The tax region's rates. items: type: object parent: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml index 235dd86a80..be8ab35c7c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the tax region deletion. x-schemaName: AdminTaxRegionDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the Tax Region was deleted. + description: Whether the tax region was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml index 0c200e26d0..b1cfcf7062 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminTaxRegionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The tax region's details. x-schemaName: AdminTaxRegionResponse required: - tax_region diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml index 1858893589..2f9911872e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateApiKey.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in an API key. x-schemaName: AdminUpdateApiKey required: - title @@ -7,4 +7,4 @@ properties: title: type: string title: title - description: The api key's title. + description: The API key's title. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml index 22a9be4f57..63cfe987d0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in a collection. x-schemaName: AdminUpdateCollection properties: title: @@ -12,4 +12,4 @@ properties: description: The collection's handle. metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml index acb0253445..57fb90e715 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in a customer group. x-schemaName: AdminUpdateCustomerGroup properties: name: @@ -8,4 +8,4 @@ properties: description: The customer group's name. metadata: type: object - description: The customer group's metadata. + description: The customer group's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml index 97688d7c5f..449d7f76e4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: the details to update in a price list. x-schemaName: AdminUpdatePriceList properties: title: @@ -13,11 +13,11 @@ properties: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -33,3 +33,6 @@ properties: rules: type: object description: The price list's rules. + example: + customer_group_id: + - cusgrp_123 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePricePreference.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePricePreference.yaml index 0c5f879d8f..cc04155d19 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePricePreference.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePricePreference.yaml @@ -1,16 +1,18 @@ type: object -description: SUMMARY +description: The details to update in the price preference. x-schemaName: AdminUpdatePricePreference properties: attribute: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices are tax inclusive for this price preference. 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 844455161e..6d17d3a72f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProduct.yaml @@ -1,51 +1,51 @@ type: object -description: The update's details. +description: The product's details. x-schemaName: AdminUpdateProduct properties: title: type: string title: title - description: The update's title. + description: The product's title. subtitle: type: string title: subtitle - description: The update's subtitle. + description: The product's subtitle. description: type: string title: description - description: The update's description. + description: The product's description. is_giftcard: type: boolean title: is_giftcard - description: The update's is giftcard. + description: Whether the product is a gift card. discountable: type: boolean title: discountable - description: The update's discountable. + description: Whether discounts can be applied on the product. images: type: array - description: The update's images. + description: The product's images. items: type: object - description: The image's images. + description: The image's details. required: - url properties: url: type: string title: url - description: The image's url. + description: The image's URL. thumbnail: type: string title: thumbnail - description: The update's thumbnail. + description: The product's thumbnail URL. handle: type: string title: handle - description: The update's handle. + description: The product's unique handle. status: type: string - description: The update's status. + description: The product's status. enum: - draft - proposed @@ -54,17 +54,17 @@ properties: type_id: type: string title: type_id - description: The update's type id. + description: The ID of the product's type. collection_id: type: string title: collection_id - description: The update's collection id. + description: The ID of the product's collection. categories: type: array - description: The update's categories. + description: The product's categories. items: type: object - description: The category's categories. + description: The product's category. required: - id properties: @@ -74,10 +74,10 @@ properties: description: The category's ID. tags: type: array - description: The update's tags. + description: The product's tags. items: type: object - description: The tag's tags. + description: The product's tag. required: - id properties: @@ -87,181 +87,24 @@ properties: description: The tag's ID. options: type: array - description: The update's options. + description: The product's options. items: $ref: ./AdminUpdateProductOption.yaml variants: type: array - description: The update's variants. + description: >- + The product's variants. You can add new variants or update existing ones, + passing their IDs in the object. items: 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. + - $ref: ./AdminCreateProductVariant.yaml + - $ref: ./AdminUpdateProductVariant.yaml sales_channels: type: array - description: The update's sales channels. + description: The sales channels that the product is available in. items: type: object - description: The sales channel's sales channels. + description: The sales channel's details. required: - id properties: @@ -272,35 +115,35 @@ properties: weight: type: number title: weight - description: The update's weight. + description: The product's weight. length: type: number title: length - description: The update's length. + description: The product's length. height: type: number title: height - description: The update's height. + description: The product's height. width: type: number title: width - description: The update's width. + description: The product's width. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product's MID code. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product's origin country. material: type: string title: material - description: The update's material. + description: The product's material. metadata: type: object - description: The update's metadata. + description: The product's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml index bfdca1a5cb..046aa99815 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductOption.yaml @@ -1,15 +1,15 @@ type: object -description: SUMMARY +description: The details to update in a product option. x-schemaName: AdminUpdateProductOption properties: title: type: string title: title - description: The product's title. + description: The option's title. values: type: array - description: The product's values. + description: The option's values. items: type: string title: values - description: The value's values. + description: An option value. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml index c0429b85e9..59f99cff83 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateProductVariant.yaml @@ -1,79 +1,81 @@ type: object -description: The update's details. +description: The properties to update of a product variant. x-schemaName: AdminUpdateProductVariant properties: title: type: string title: title - description: The update's title. + description: The product variant's title. sku: type: string title: sku - description: The update's sku. + description: The product variant's SKU. ean: type: string title: ean - description: The update's ean. + description: The product variant's EAN. upc: type: string title: upc - description: The update's upc. + description: The product variant's UPC. barcode: type: string title: barcode - description: The update's barcode. + description: The product variant's barcode. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product variant's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product variant's MID code. allow_backorder: type: boolean title: allow_backorder - description: The update's allow backorder. + description: Whether customers can order the variant even if it's not in stock. manage_inventory: type: boolean title: manage_inventory - description: The update's manage inventory. + description: >- + Whether the Medusa application manages the variant's inventory. If + disabled, the product variant is always considered in stock. variant_rank: type: number title: variant_rank - description: The update's variant rank. + description: The product variant's rank among its siblings. weight: type: number title: weight - description: The update's weight. + description: The product variant's weight. length: type: number title: length - description: The update's length. + description: The product variant's length. height: type: number title: height - description: The update's height. + description: The product variant's height. width: type: number title: width - description: The update's width. + description: The product variant's width. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product variant's origin country. material: type: string title: material - description: The update's material. + description: The product variant's material. metadata: type: object - description: The update's metadata. + description: The product variant's metadata, can hold custom key-value pairs. prices: type: array - description: The update's prices. + description: The product variant's prices. items: $ref: ./AdminCreateProductVariantPrice.yaml options: type: object - description: The update's options. + description: The product variant's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePromotionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePromotionRule.yaml new file mode 100644 index 0000000000..27f09bd9b7 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePromotionRule.yaml @@ -0,0 +1,49 @@ +type: object +description: The properties to update in a buy rule. +required: + - id + - values +properties: + id: + type: string + title: id + description: The buy rule's ID. + operator: + type: string + description: >- + The operator used to check whether the buy rule applies on a cart. For + example, `eq` means that the cart's value for the specified attribute must + match the specified value. + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: >- + The attribute to compare against when checking whether a promotion can be + applied on a cart. + example: items.product.id + values: + oneOf: + - type: string + title: values + description: The attribute's value. + example: prod_123 + - type: array + description: The allowed attribute values. + items: + type: string + title: values + description: An attribute value. + example: prod_123 +x-schemaName: AdminUpdatePromotionRule diff --git a/www/apps/api-reference/specs/admin/components/schemas/UpdateOrderReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml similarity index 62% rename from www/apps/api-reference/specs/admin/components/schemas/UpdateOrderReturnReason.yaml rename to www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml index 581ad731dc..3299988196 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/UpdateOrderReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateReturnReason.yaml @@ -1,11 +1,7 @@ type: object -description: SUMMARY -x-schemaName: UpdateOrderReturnReason +description: The details to update in a return reason. +x-schemaName: AdminUpdateReturnReason properties: - id: - type: string - title: id - description: The return reason's ID. label: type: string title: label @@ -20,4 +16,7 @@ properties: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. +required: + - value + - label diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml index 8f30103306..db5e76e560 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in the sales channel. x-schemaName: AdminUpdateSalesChannel properties: name: @@ -13,7 +13,7 @@ properties: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOptionRule.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOptionRule.yaml new file mode 100644 index 0000000000..96a09b2d5a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateShippingOptionRule.yaml @@ -0,0 +1,43 @@ +type: object +description: The properties to update in the shipping option rule. +required: + - id + - operator + - attribute + - value +properties: + id: + type: string + title: id + description: The rule's ID. + operator: + type: string + description: The operator used to check whether a rule applies. + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The name of a property or table that the rule applies to. + example: customer_group + value: + oneOf: + - type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 + - type: array + description: Values of the attribute that enable this rule. + items: + type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 +x-schemaName: AdminUpdateShippingOptionRule diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml index 2312fd5e3c..936fe6f522 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in a stock location. x-schemaName: AdminUpdateStockLocation properties: name: @@ -8,7 +8,9 @@ properties: description: The stock location's name. address: type: object - description: The stock location's address. + description: >- + The stock location's address. Pass this property if you're creating a new + address to associate with the location. required: - address_1 - country_code @@ -16,11 +18,11 @@ properties: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -33,6 +35,7 @@ properties: type: string title: country_code description: The address's country code. + example: us phone: type: string title: phone @@ -48,7 +51,9 @@ properties: address_id: type: string title: address_id - description: The stock location's address id. + description: >- + The ID of an existing stock location address to associate the stock + location with. metadata: type: object - description: The stock location's metadata. + description: The stock location's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml index 7df88b6bc0..e8c4463b52 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in a store. x-schemaName: AdminUpdateStore properties: name: @@ -11,34 +11,35 @@ properties: description: The store's supported currencies. items: type: object - description: The supported currency's supported currencies. + description: A store currency. required: - currency_code properties: currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether the currency is the default in the store. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The supported currency's is tax inclusive. + description: Whether prices using this currency are tax inclusive. default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the default sales channel in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the default region in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the default stock location in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml index 5580cc1ef6..8000de42a9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml @@ -1,21 +1,21 @@ type: object -description: SUMMARY +description: The properties to update in the tax rate. x-schemaName: AdminUpdateTaxRate properties: rate: type: number title: rate - description: The tax rate's rate. + description: The rate to charge. code: type: string title: code - description: The tax rate's code. + description: The code that the tax rate is identified by. rules: type: array description: The tax rate's rules. items: type: object - description: The rule's rules. + description: A tax rate rule. required: - reference - reference_id @@ -23,11 +23,13 @@ properties: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of the record in the table that the rule references. + example: ptyp_123 name: type: string title: name @@ -35,11 +37,14 @@ properties: is_default: type: boolean title: is_default - description: The tax rate's is default. + description: Whether the tax rate is the default in the store. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates metadata: type: object - description: The tax rate's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml index 1d1bd54d5a..2fc8ed46f5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update in a user. x-schemaName: AdminUpdateUser properties: first_name: @@ -13,4 +13,4 @@ properties: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml index 8db01d8c4c..b61c9d020f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateVariantInventoryItem.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The properties to update of the variant's inventory item association. x-schemaName: AdminUpdateVariantInventoryItem required: - required_quantity @@ -7,4 +7,10 @@ properties: required_quantity: type: number title: required_quantity - description: The product's required quantity. + description: >- + The number of units a single quantity is equivalent to. For example, if a + customer orders one quantity of the variant, Medusa checks the + availability of the quantity multiplied by the value set for + `required_quantity`. When the customer orders the quantity, Medusa + reserves the ordered quantity multiplied by the value set for + `required_quantity`. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml index b0e8d7c033..5c265c5e0e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpsertStockLocationAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The stock location's address. +description: The details of the stock location address to create. x-schemaName: AdminUpsertStockLocationAddress required: - address_1 @@ -8,11 +8,11 @@ properties: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -21,6 +21,7 @@ properties: type: string title: country_code description: The address's country code. + example: usd city: type: string title: city diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml index 6fb258123e..c3bca505cb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUser.yaml @@ -32,22 +32,22 @@ properties: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The user's created at. + description: The date the user was created. updated_at: type: string format: date-time title: updated_at - description: The user's updated at. + description: The date the user was updated. deleted_at: type: string format: date-time title: deleted_at - description: The user's deleted at. + description: The date the user was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml index fb9888ff23..72ede85811 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserDeleteResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the deleted user. x-schemaName: AdminUserDeleteResponse required: - id @@ -18,4 +18,4 @@ properties: deleted: type: boolean title: deleted - description: Whether the User was deleted. + description: Whether the user was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml index 7aac88724a..e595dad0cd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of users. x-schemaName: AdminUserListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The user's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The user's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The user's count. + description: The total number of items. users: type: array - description: The user's users. + description: The list of 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 index dfc78e1bc9..ed4678e0a0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUserResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUserResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The user's details. x-schemaName: AdminUserResponse required: - user diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml index 1c803655b9..c71f1c4364 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecution.yaml @@ -1,5 +1,5 @@ type: object -description: The workflows execution's workflow execution. +description: The workflows execution's details. x-schemaName: AdminWorkflowExecution required: - id @@ -18,11 +18,11 @@ properties: workflow_id: type: string title: workflow_id - description: The workflow execution's workflow id. + description: The ID of the workflow. transaction_id: type: string title: transaction_id - description: The workflow execution's transaction id. + description: The workflow execution's transaction ID. execution: $ref: ./AdminWorkflowExecutionExecution.yaml context: @@ -42,14 +42,14 @@ properties: type: string format: date-time title: created_at - description: The workflow execution's created at. + description: The date the workflow execution was created. updated_at: type: string format: date-time title: updated_at - description: The workflow execution's updated at. + description: The date the workflow execution was updated. deleted_at: type: string format: date-time title: deleted_at - description: The workflow execution's deleted at. + description: The date the workflow execution was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml index e589756af2..6b780c9e0a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionExecution.yaml @@ -1,9 +1,152 @@ type: object -description: The workflow execution's execution. +description: The workflow execution's steps details. x-schemaName: AdminWorkflowExecutionExecution required: - steps properties: steps: type: object - description: The execution's steps. + description: >- + The execution's steps. Each object key is a step ID, and the value is the + object whose properties are shown below. + required: + - id + - invoke + - definition + - compensate + - depth + - startedAt + additionalProperties: + type: object + properties: + id: + type: string + title: id + description: The step's ID. + invoke: + type: object + description: The state of the step's invokation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The invokation step's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The invokation step's state. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + definition: + type: object + description: The step's definition details. + x-schemaName: WorkflowExecutionDefinition + properties: + async: + type: boolean + title: async + description: Whether the step is async. + compensateAsync: + type: boolean + title: compensateAsync + description: Whether the compensation function of the step is async. + noCompensation: + type: boolean + title: noCompensation + description: Whether the step doesn't have a compensation function. + continueOnPermanentFailure: + type: boolean + title: continueOnPermanentFailure + description: >- + Whether the step continues executing even if its status is + changed to failed. + maxRetries: + type: number + title: maxRetries + description: The maximum number of times to retry the step. + noWait: + type: boolean + title: noWait + description: >- + Whether the workflow shouldn't wait for the step to finish + before moving to the next step. + default: false + retryInterval: + type: number + title: retryInterval + description: >- + The interval in seconds between retry attempts when the step + fails. + retryIntervalAwaiting: + type: number + title: retryIntervalAwaiting + description: >- + The interval in seconds to retry a step even if its status is + `waiting_response`. + saveResponse: + type: boolean + title: saveResponse + description: Whether the step's response is stored. + timeout: + type: number + title: timeout + description: >- + The maximum time in seconds to wait for this step to complete. + If the step exceeds this time, the step's state is changed to + `timeout`, but the step continues executing. + compensate: + type: object + description: The state of the step's compensation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The compensation function's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The compensation function's status. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + depth: + type: number + title: depth + description: The step's depth in the workflow's execution. + startedAt: + type: number + title: startedAt + description: The timestamp the step started executing. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml index 2c21bd3e4e..c57cb857d1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminWorkflowExecutionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The workflow execution's details. x-schemaName: AdminWorkflowExecutionResponse required: - workflow_execution diff --git a/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml index df83ca78ff..f5de0a2150 100644 --- a/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/ApiKeyResponse.yaml @@ -1,5 +1,5 @@ type: object -description: The api key's details. +description: The API key's details. x-schemaName: ApiKeyResponse required: - id @@ -16,44 +16,50 @@ properties: id: type: string title: id - description: The api key's ID. + description: The API key's ID. token: type: string title: token - description: The api key's token. + description: The API key's token. redacted: type: string title: redacted - description: The api key's redacted. + description: >- + The redacted form of the API key's token. This is useful when showing + portion of the token. For example `sk_...123`. title: type: string title: title - description: The api key's title. + description: The API key's title. type: type: string + description: >- + The API key's type. `secret` API keys are used for authenticating admin + users, and `publishable` API key are used for storefronts and similar + clients to scope requests to sales channels. enum: - secret - publishable last_used_at: type: string title: last_used_at - description: The api key's last used at. + description: The date the API key was last used. format: date-time created_by: type: string title: created_by - description: The api key's created by. + description: The ID of the user that created the API key. created_at: type: string title: created_at - description: The api key's created at. + description: The date the API key was created. format: date-time revoked_by: type: string title: revoked_by - description: The api key's revoked by. + description: The ID of the user that revoked the API key. revoked_at: type: string title: revoked_at - description: The api key's revoked at. + description: The date the API key was revoked. format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/AuthCallbackResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AuthCallbackResponse.yaml index 65706e144b..aa4b4117eb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AuthCallbackResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AuthCallbackResponse.yaml @@ -4,7 +4,7 @@ x-schemaName: AuthCallbackResponse required: - location properties: - token: + location: type: string title: location description: >- diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml deleted file mode 100644 index 4e1e727e4a..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseApplicationMethod.yaml +++ /dev/null @@ -1,61 +0,0 @@ -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 - description: The application method's type. - enum: - - fixed - - percentage - target_type: - type: string - description: The application method's target type. - enum: - - items - - shipping_methods - - order - allocation: - type: string - description: The application method's allocation. - enum: - - each - - across - 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 70dd7bf660..f8db134ea0 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 parent's calculated price. +description: The calculated price's details. x-schemaName: BaseCalculatedPriceSet required: - id @@ -14,42 +14,102 @@ properties: is_calculated_price_price_list: type: boolean title: is_calculated_price_price_list - description: The calculated price's is calculated price price list. + description: Whether the calculated price belongs to a price list. is_calculated_price_tax_inclusive: type: boolean title: is_calculated_price_tax_inclusive - description: The calculated price's is calculated price tax inclusive. + description: Whether the calculated price is tax inclusive. calculated_amount: type: number title: calculated_amount - description: The calculated price's calculated amount. + description: >- + The amount of the calculated price, or `null` if there isn't a calculated + price. This is the amount shown to the customer. calculated_amount_with_tax: type: number title: calculated_amount_with_tax - description: The calculated price's calculated amount with tax. + description: The calculated price's amount with taxes applied. calculated_amount_without_tax: type: number title: calculated_amount_without_tax - description: The calculated price's calculated amount without tax. + description: The calculated price's amount without taxes applied. is_original_price_price_list: type: boolean title: is_original_price_price_list - description: The calculated price's is original price price list. + description: Whether the original price belongs to a price list. is_original_price_tax_inclusive: type: boolean title: is_original_price_tax_inclusive - description: The calculated price's is original price tax inclusive. + description: Whether the original price is tax inclusive. original_amount: type: number title: original_amount - description: The calculated price's original amount. + description: >- + The amount of the original price, or `null` if there isn't an original + price. This amount is useful to compare with the `calculated_amount`, such + as to check for discounted value. currency_code: type: string title: currency_code description: The calculated price's currency code. + example: usd calculated_price: type: object description: The calculated price's details. + properties: + id: + type: string + title: id + description: The calculated price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity original_price: type: object - description: The calculated price's original price. + description: The original price's details. + properties: + id: + type: string + title: id + description: The original price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml index 59baa7033c..a4456a306c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCapture.yaml @@ -1,3 +1,28 @@ type: object -description: The capture's captures. +description: The details of a captured payment. x-schemaName: BaseCapture +required: + - id + - amount + - created_at + - payment +properties: + id: + type: string + title: id + description: The payment capture's ID. + amount: + type: number + title: amount + description: The captured amount. + created_at: + type: string + format: date-time + title: created_at + description: The date the capture was created. + created_by: + type: string + title: created_by + description: The ID of the user that captured the payment. + payment: + type: object diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml index 5cc50d1e73..5ba46f61aa 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCart.yaml @@ -1,3 +1,173 @@ type: object description: The item's cart. x-schemaName: BaseCart +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: + type: object + 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: + type: number + title: original_item_total + description: The cart's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The cart's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The cart's original item tax total. + item_total: + type: number + title: item_total + description: The cart's item total. + item_subtotal: + type: number + title: item_subtotal + description: The cart's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The cart's item tax total. + original_total: + type: number + title: original_total + description: The cart's original total. + original_subtotal: + type: number + title: original_subtotal + description: The cart's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The cart's original tax total. + total: + type: number + title: total + description: The cart's total. + subtotal: + type: number + title: subtotal + description: The cart's subtotal. + tax_total: + type: number + title: tax_total + description: The cart's tax total. + discount_total: + type: number + title: discount_total + description: The cart's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The cart's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The cart's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The cart's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The cart's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The cart's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml index 0cc3faf4c1..e85cfd8a57 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartAddress.yaml @@ -1,69 +1,3 @@ type: object -description: The parent's billing address. +description: The cart's shipping 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 index 01d9216030..b2e59d9621 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartLineItem.yaml @@ -1,5 +1,5 @@ type: object -description: The item's items. +description: The tax line's item. x-schemaName: BaseCartLineItem required: - id @@ -40,17 +40,9 @@ properties: 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 + type: number + title: quantity + description: The item's quantity. product: $ref: ./BaseProduct.yaml product_id: @@ -115,34 +107,18 @@ properties: 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 + type: number + title: compare_at_unit_price + description: The item's compare at unit price. 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 + type: number + title: unit_price + description: The item's unit price. tax_lines: type: array description: The item's tax lines. items: - $ref: ./BaseLineItemTaxLine.yaml + type: object adjustments: type: array description: The item's adjustments. @@ -173,134 +149,46 @@ properties: title: deleted_at description: The item's deleted at. 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 + type: number + title: original_total + description: The item's original total. 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 + type: number + title: original_subtotal + description: The item's original subtotal. 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 + type: number + title: original_tax_total + description: The item's original tax total. 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 + type: number + title: item_total + description: The item's item total. 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 + type: number + title: item_subtotal + description: The item's item subtotal. 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 + type: number + title: item_tax_total + description: The item's item tax total. 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 + type: number + title: total + description: The item's total. 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 + type: number + title: subtotal + description: The item's subtotal. 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 + type: number + title: tax_total + description: The item's tax total. 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 + type: number + title: discount_total + description: The item's discount total. 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 + type: number + title: discount_tax_total + description: The item's discount tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml index 6f613ecf88..1dbcebc278 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCartShippingMethod.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping method's shipping methods. +description: A cart's shipping method. x-schemaName: BaseCartShippingMethod required: - id @@ -25,7 +25,7 @@ properties: cart_id: type: string title: cart_id - description: The shipping method's cart id. + description: The ID of the cart this shipping method belongs to. name: type: string title: name @@ -35,31 +35,28 @@ properties: 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 + 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. + description: Whether the shipping method's amount is tax inclusive. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: >- + The shipping method's data, useful for fulfillment handling by third-party + services. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -67,112 +64,52 @@ properties: $ref: ./BaseShippingMethodTaxLine.yaml adjustments: type: array - description: The shipping method's adjustments. + description: The shipping method's adjustments, such as applied promotions. items: $ref: ./BaseShippingMethodAdjustment.yaml created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. 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 + type: string + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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 + type: string + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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 + type: string + title: original_tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. 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 + type: string + title: total + description: The shipping method's total amount including taxes and promotions. 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 + type: string + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. 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 + type: string + title: tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. 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 + type: string + title: discount_total + description: The total amount discounted. 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 + type: string + title: discount_total + description: The taxes applied on the discounted amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml deleted file mode 100644 index 85d6a02519..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseClaim.yaml +++ /dev/null @@ -1,3 +0,0 @@ -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 index 27c9efe996..fe407754be 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseClaimItem.yaml @@ -1,5 +1,5 @@ type: object -description: The claim item's claim items. +description: The claim item's details. x-schemaName: BaseClaimItem required: - id @@ -17,22 +17,22 @@ properties: claim_id: type: string title: claim_id - description: The claim item's claim id. + description: The ID of the claim this item belongs to. order_id: type: string title: order_id - description: The claim item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The claim item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The claim item's quantity. + description: The quantity claimed. reason: type: string - description: The claim item's reason. + description: The claim's reason. enum: - missing_item - wrong_item @@ -40,17 +40,28 @@ properties: - other raw_quantity: type: object - description: The claim item's raw quantity. + description: The quantity claimed. + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + required: + - value metadata: type: object - description: The claim item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The claim item's created at. + description: The date the claim was created. updated_at: type: string format: date-time title: updated_at - description: The claim item's updated at. + description: The date the claim was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml index 19efac7da2..6b7390021c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml @@ -1,3 +1,3 @@ type: object -description: The product's collection. +description: The collection's details. x-schemaName: BaseCollection diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml deleted file mode 100644 index ef30b67813..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCustomer.yaml +++ /dev/null @@ -1,73 +0,0 @@ -type: object -description: The customer's details. -x-schemaName: BaseCustomer -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 ID of the address used as the default billing address. - default_shipping_address_id: - type: string - title: default_shipping_address_id - description: The ID of the address used as the default shipping address. - 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, used to store custom key-value pairs. - created_by: - type: string - title: created_by - description: The ID of the user that created this customer, if available. - created_at: - type: string - format: date-time - title: created_at - description: The customer's creation date. - updated_at: - type: string - format: date-time - title: updated_at - description: The customer's update date. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The customer's deletion date. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml index 906bc9231d..c894dbf6d0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCustomerAddress.yaml @@ -1,3 +1,97 @@ type: object -description: The address's addresses. +description: The customer's address. x-schemaName: BaseCustomerAddress +required: + - id + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company + - first_name + - last_name + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The address's ID. + address_name: + type: string + title: address_name + description: The address's name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: Whether the address is the default shipping address. + is_default_billing: + type: boolean + title: is_default_billing + description: Whether the address is the default billing address. + customer_id: + type: string + title: customer_id + description: The ID of the customer that this address belongs to. + 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 address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + 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, used to store custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The address's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The address's update date. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml index 852b2e0a94..82c98c6dbf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseExchangeItem.yaml @@ -1,5 +1,5 @@ type: object -description: The additional item's additional items. +description: The item's details. x-schemaName: BaseExchangeItem required: - id @@ -13,33 +13,33 @@ properties: id: type: string title: id - description: The additional item's ID. + description: The item's ID. exchange_id: type: string title: exchange_id - description: The additional item's exchange id. + description: The ID of the exchange this item belongs to. order_id: type: string title: order_id - description: The additional item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The additional item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The additional item's quantity. + description: The item's quantity. metadata: type: object - description: The additional item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The additional item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The additional item's updated at. + description: The date the item was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml index 5cddd56a89..7e0af5e7a7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseFulfillmentProvider.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping option's provider. +description: The fulfillment provider's details. x-schemaName: BaseFulfillmentProvider required: - id @@ -12,4 +12,4 @@ properties: is_enabled: type: boolean title: is_enabled - description: The provider's is enabled. + description: Whether the provider 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 index 5b5a104b31..af9b884de8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseLineItemAdjustment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The adjustment's details. x-schemaName: BaseLineItemAdjustment +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the cart this adjustment belongs to. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. +required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml index 1fdd8bf379..63946d4c1f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseLineItemTaxLine.yaml @@ -1,3 +1,62 @@ type: object -description: The tax line's tax lines. +description: The tax line's details x-schemaName: BaseLineItemTaxLine +properties: + item: + $ref: ./BaseCartLineItem.yaml + item_id: + type: string + title: item_id + description: The ID of the item the tax line applies on. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the associated tax rate. + code: + type: string + title: code + description: The code the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. +required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml index 09579fa8dd..2b2d4962a6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml @@ -1,3 +1,238 @@ type: object -description: The order change's order. +description: The order's details. x-schemaName: BaseOrder +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 + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: ./BaseOrderFulfillment.yaml + sales_channel: + $ref: ./AdminSalesChannel.yaml + customer: + $ref: ./AdminCustomer.yaml + shipping_address: + $ref: ./AdminOrderAddress.yaml + billing_address: + $ref: ./AdminOrderAddress.yaml + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The ID of the region associated with the order. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order is placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: number + title: display_id + description: The order's display ID. + 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 + description: The order's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillment_status: + type: string + description: The order's fulfillment status. + 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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the order's items including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The total of the order's items excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the order's items excluding promotions. + item_total: + type: number + title: item_total + description: The total of the order's items including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The total of the order's items excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order's items including promotions. + original_total: + type: number + title: original_total + description: The order's total excluding promotions, including taxes. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The order's tax total, excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The order's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The order's discount or promotions total. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total of order's discount or promotion. + 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 tax total of the order's gift card. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The tax total of the order's shipping. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The tax total of the order's shipping excluding promotions. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml index f1896707cd..ffdb335848 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The exchange's billing address. +description: An order address x-schemaName: BaseOrderAddress required: - id @@ -10,61 +10,64 @@ properties: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer this address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us + country: + $ref: ./AdminRegionCountry.yaml province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The billing address's updated at. + description: The date the address was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml deleted file mode 100644 index dc086f2f8e..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChange.yaml +++ /dev/null @@ -1,146 +0,0 @@ -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 - description: The order change's change type. - enum: - - return - - exchange - - claim - - edit - - return_request - 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 index 91725525be..476cad7744 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderChangeAction.yaml @@ -1,3 +1,85 @@ type: object description: The action's actions. x-schemaName: BaseOrderChangeAction +properties: + order_change: + type: object + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change this action belongs to. + order_id: + type: string + title: order_id + description: The ID of the associated order. + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + title: action + description: The applied action. + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the order change action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change action was updated. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: ./BaseOrder.yaml +required: + - order_change + - id + - order_change_id + - order_id + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at + - return_id + - claim_id + - exchange_id + - order diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml index 513f2f9f6a..12970b6fe2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml @@ -22,48 +22,53 @@ properties: location_id: type: string title: location_id - description: The fulfillment's location id. + description: The ID of the location the items are fulfilled from. packed_at: type: string title: packed_at - description: The fulfillment's packed at. + description: The date the items were packed. format: date-time shipped_at: type: string title: shipped_at - description: The fulfillment's shipped at. + description: The date the items were shipped. format: date-time delivered_at: type: string title: delivered_at - description: The fulfillment's delivered at. + description: The date the items were delivered. format: date-time canceled_at: type: string title: canceled_at - description: The fulfillment's canceled at. + description: The date the items were canceled. format: date-time data: type: object - description: The fulfillment's data. + description: >- + Data useful for the fulfillment provider handling it. This is taken from + the associated shipping option. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property provider_id: type: string title: provider_id - description: The fulfillment's provider id. + description: The ID of the fulfillment provider used to handle the fulfillment. shipping_option_id: type: string title: shipping_option_id - description: The fulfillment's shipping option id. + description: The ID of the associated shipping option. metadata: type: object - description: The fulfillment's metadata. + description: The fulfillment's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The fulfillment's created at. + description: The date the fulfillment was created. updated_at: type: string format: date-time title: updated_at - description: The fulfillment's updated at. + description: The date the fulfillment was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml index 0a1f9eb14d..b29f58deb1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderItemDetail.yaml @@ -1,3 +1,79 @@ type: object description: The item's detail. x-schemaName: BaseOrderItemDetail +required: + - id + - item_id + - item + - quantity + - fulfilled_quantity + - delivered_quantity + - shipped_quantity + - return_requested_quantity + - return_received_quantity + - return_dismissed_quantity + - written_off_quantity + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: the detail's ID. + item_id: + type: string + title: id + description: the ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + delivered_quantity: + type: number + title: fulfilled_quantity + description: The item's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + return_received_quantity: + type: number + title: return_received_quantity + description: >- + The item's quantity that's returned and added to the underlying variant's + stocked quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: >- + The item's quantity that's returned but damaged. So, it's not added to the + underlying variant's stocked quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed from the order. + metadata: + type: object + title: metadata + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the detail was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the detail was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml index ecf54b1785..f69a00e216 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItem.yaml @@ -56,19 +56,19 @@ properties: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The URL of the item's thumbnail. variant: $ref: ./BaseProductVariant.yaml variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated variant. product: $ref: ./BaseProduct.yaml product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -88,7 +88,7 @@ properties: product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the collection the item's product belongs to. product_handle: type: string title: product_handle @@ -96,7 +96,7 @@ properties: variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -107,23 +107,25 @@ properties: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The values of the item variant's options. + example: + Color: Blue requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item is tax inclusive. compare_at_unit_price: type: number title: compare_at_unit_price - description: The item's compare at unit price. + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -148,64 +150,64 @@ properties: type: string format: date-time title: created_at - description: The item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The item's updated at. + description: The date the item was updated. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. original_total: type: number title: original_total - description: The item's original total. + description: The item's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The item's original subtotal. + description: The item's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The item's original tax total. + description: The total taxes of the item, excluding promotions. item_total: type: number title: item_total - description: The item's item total. + description: The total taxes of the item, including promotions. item_subtotal: type: number title: item_subtotal - description: The item's item subtotal. + description: The item's total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The item's item tax total. + description: The total taxes of the item, including promotions. total: type: number title: total - description: The item's total. + description: The item's total, including taxes and promotions. subtotal: type: number title: subtotal - description: The item's subtotal. + description: The item's subtotal excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The item's tax total. + description: The tax total of the item including promotions. discount_total: type: number title: discount_total - description: The item's discount total. + description: The total discount amount of the item. discount_tax_total: type: number title: discount_tax_total - description: The item's discount tax total. + description: The total taxes applied on the discounted amount. refundable_total: type: number title: refundable_total - description: The item's refundable total. + description: The total refundable amount of the item's total. refundable_total_per_unit: type: number title: refundable_total_per_unit - description: The item's refundable total per unit. + description: The total refundable amount of the item's total for a single quantity. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml index a4f81ce94f..8bc04e5fdd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The adjustment's details. x-schemaName: BaseOrderLineItemAdjustment +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion that this applies on the order's item. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. +required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml index 213da9382d..b9bf8070c0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderLineItemTaxLine.yaml @@ -1,3 +1,62 @@ type: object description: The tax line's tax lines. x-schemaName: BaseOrderLineItemTaxLine +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the associated line item. + total: + type: number + title: total + description: The tax line's total including promotions. + subtotal: + type: number + title: subtotal + description: The tax line's subtotal excluding promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. +required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingDetail.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingDetail.yaml new file mode 100644 index 0000000000..5cd76600fb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingDetail.yaml @@ -0,0 +1,42 @@ +type: object +description: Details of changes to a shipping method. +x-schemaName: BaseOrderShippingDetail +required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The ID of the new changes to the shipping method. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method. + shipping_method: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + return_id: + type: string + title: return_id + description: The ID of the associated return. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method change was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml index 4357db37d7..930352a943 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethod.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping method's shipping methods. +description: The shipping method's details. x-schemaName: BaseOrderShippingMethod required: - id @@ -28,7 +28,7 @@ properties: order_id: type: string title: order_id - description: The shipping method's order id. + description: The ID of the order the shipping method belongs to. name: type: string title: name @@ -44,17 +44,22 @@ properties: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping method's is tax inclusive. + description: Whether the shipping method's amount includes applied taxes. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: >- + The shipping method's data, useful for fulfillment provider handling its + fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -66,108 +71,46 @@ properties: 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 + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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 + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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 + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. 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 + type: number + title: total + description: The shipping method's total including taxes and promotions. 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 + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. 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 + type: number + title: tax_total + description: The shipping method's tax total including promotions. 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 + type: number + title: discount_total + description: The total discounts applied on the shipping method. 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 + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. + detail: + $ref: ./BaseOrderShippingDetail.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml index 0d458f73fa..59eec5e5eb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodAdjustment.yaml @@ -1,3 +1,56 @@ type: object description: The adjustment's adjustments. x-schemaName: BaseOrderShippingMethodAdjustment +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. +required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml index 3cce6d21b0..96102bb4ad 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderShippingMethodTaxLine.yaml @@ -1,3 +1,62 @@ type: object -description: The tax line's tax lines. +description: The tax line's details. x-schemaName: BaseOrderShippingMethodTaxLine +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider handling the tax calculation. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. +required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml index 395346dc23..26db0db078 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderSummary.yaml @@ -1,5 +1,5 @@ type: object -description: The order's summary. +description: The order's summary details. x-schemaName: BaseOrderSummary required: - total @@ -10,71 +10,46 @@ required: - 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. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The summary's subtotal. + description: The order's total excluding taxes, including promotions. total_tax: type: number title: total_tax - description: The summary's total tax. + description: The order's total taxes. ordered_total: type: number title: ordered_total - description: The summary's ordered total. + description: The order's total when it was placed. fulfilled_total: type: number title: fulfilled_total - description: The summary's fulfilled total. + description: The total of the fulfilled items of the order. returned_total: type: number title: returned_total - description: The summary's returned total. + description: The total of the order's returned items. return_request_total: type: number title: return_request_total - description: The summary's return request total. + description: The total of the items requested to be returned. 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. + description: The total of the items removed from the order. paid_total: type: number title: paid_total - description: The summary's paid total. + description: The total amount paid. refunded_total: type: number title: refunded_total - description: The summary's refunded total. + description: The total amount refunded. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml index 8abf8cfd58..f822566df9 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderTransaction.yaml @@ -1,5 +1,5 @@ type: object -description: The transaction's transactions. +description: An order transaction's details. x-schemaName: BaseOrderTransaction required: - id @@ -19,7 +19,7 @@ properties: order_id: type: string title: order_id - description: The transaction's order id. + description: The ID of the order this transaction belongs to. amount: type: number title: amount @@ -28,24 +28,31 @@ properties: type: string title: currency_code description: The transaction's currency code. + example: usd reference: type: string title: reference - description: The transaction's reference. + description: >- + The name of a table that this transaction references. If this transaction + is for captured payment, its value is `capture`. If this transaction is + for refunded payment, its value is `refund`. + enum: + - capture + - refund reference_id: type: string title: reference_id - description: The transaction's reference id. + description: The ID of the referenced record in the referenced table. metadata: type: object - description: The transaction's metadata. + description: The transaction's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The transaction's created at. + description: The date that the transaction was created. updated_at: type: string format: date-time title: updated_at - description: The transaction's updated at. + description: The date that the transaction was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml index 6171436ba7..86305baabf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePayment.yaml @@ -1,3 +1,93 @@ type: object -description: The payment's payments. +description: The payment's details. x-schemaName: BasePayment +required: + - id + - amount + - currency_code + - provider_id +properties: + id: + type: string + title: id + description: The payment's ID. + amount: + type: number + title: amount + description: The payment's amount. + authorized_amount: + type: number + title: authorized_amount + description: The amount authorized of the payment. + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The ID of the payment provider used to process this payment. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order_edit_id: + type: string + title: order_edit_id + description: The ID of the associated order edit. + customer_id: + type: string + title: customer_id + description: ID of the associated customer. + data: + type: object + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment + created_at: + type: string + format: date-time + title: created_at + description: The date the payment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the payment was updated. + captured_at: + type: string + format: date-time + title: captured_at + description: The date the payment was captured. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. + captured_amount: + type: number + title: captured_amount + description: The captured amount of the payment. + refunded_amount: + type: number + title: captured_amount + description: The refunded amount of the payment. + captures: + type: array + description: The details of payment captures. + items: + $ref: ./BaseCapture.yaml + refunds: + type: array + description: The details of payment refunds. + items: + $ref: ./BaseRefund.yaml + payment_collection: + type: object + payment_session: + type: object diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml index 309583af20..8ee4e76804 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentCollection.yaml @@ -1,5 +1,5 @@ type: object -description: The payment collection's payment collections. +description: The payment collection's details. x-schemaName: BasePaymentCollection required: - id @@ -20,77 +20,41 @@ properties: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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 + type: number + title: amount + description: The total amount to be paid. 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 + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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 + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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 + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -102,7 +66,9 @@ properties: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: >- + The payment provider used to process the collection's payments and + sessions. items: $ref: ./BasePaymentProvider.yaml payment_sessions: diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml index 2266f0a8ea..2b73a963fb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml @@ -1,3 +1,10 @@ type: object description: The payment provider's payment providers. x-schemaName: BasePaymentProvider +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/BasePaymentSession.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml index f0c1e2603a..33533c274e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentSession.yaml @@ -1,3 +1,61 @@ type: object -description: The payment session's payment sessions. +description: The payment session's details. x-schemaName: BasePaymentSession +properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: >- + The payment session's data, useful for the payment provider processing the + payment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: ./BasePayment.yaml +required: + - id + - amount + - currency_code + - provider_id + - data + - status 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 c07bd8c599..406806bd73 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProduct.yaml @@ -123,7 +123,7 @@ properties: type: array description: The product's variants. items: - $ref: ./BaseProductVariant.yaml + type: object options: type: array description: The product's options. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml index cbabec4609..f1e59ad937 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductImage.yaml @@ -1,3 +1,33 @@ type: object -description: The image's images. +description: The image's details. x-schemaName: BaseProductImage +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. +required: + - id + - url diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml index 91105a54c2..152999bb1c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml @@ -1,3 +1,44 @@ type: object -description: The option's options. +description: The product option's details. x-schemaName: BaseProductOption +properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: ./BaseProductOptionValue.yaml + metadata: + type: object + description: The option's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The option's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The option's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The option's deleted at. +required: + - id + - title diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml index a607fba792..ba0a4dfd87 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOptionValue.yaml @@ -1,5 +1,5 @@ type: object -description: The option's options. +description: The product option value's details. x-schemaName: BaseProductOptionValue required: - id @@ -8,32 +8,32 @@ properties: id: type: string title: id - description: The option's ID. + description: The value's ID. value: type: string title: value - description: The option's value. + description: The value. option: - $ref: ./BaseProductOption.yaml + type: object option_id: type: string title: option_id - description: The option's option id. + description: The ID of the option this value belongs to. metadata: type: object - description: The option's metadata. + description: The value's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The option's created at. + description: The date the value was created. updated_at: type: string format: date-time title: updated_at - description: The option's updated at. + description: The date the value was updated. deleted_at: type: string format: date-time title: deleted_at - description: The option's deleted at. + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml index 559318d70e..e27ee0ea8c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductVariant.yaml @@ -1,3 +1,132 @@ type: object -description: The variant's variants. +description: The product variant's details. x-schemaName: BaseProductVariant +required: + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The variant's ID. + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN code. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's out of stock. + manage_inventory: + type: boolean + title: manage_inventory + description: >- + Whether the Medusa application manages the variant's inventory quantity + and availablility. If disabled, the variant is always considered in stock. + inventory_quantity: + type: number + title: inventory_quantity + description: >- + The variant's inventory quantity. This is only included if you pass in the + `fields` query parameter a `+variants.inventory_quantity` parameter. + hs_code: + type: string + title: hs_code + description: The variant's HS code. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + mid_code: + type: string + title: mid_code + description: The variant's MID code. + material: + type: string + title: material + description: The variant's material. + 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. + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its sibling variants. + options: + type: array + description: The variant's option values. + items: + $ref: ./BaseProductOptionValue.yaml + product: + $ref: ./BaseProduct.yaml + product_id: + type: string + title: product_id + description: The ID of the product that the variant belongs to. + calculated_price: + $ref: ./BaseCalculatedPriceSet.yaml + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml index 9cba351225..12eafa4026 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePromotionRuleValue.yaml @@ -1,5 +1,5 @@ type: object -description: The value's values. +description: The rule value's details. x-schemaName: BasePromotionRuleValue required: - id @@ -11,4 +11,4 @@ properties: value: type: string title: value - description: The value's details. + description: The value. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml index 50d12fb0f9..9a8cf91839 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRefund.yaml @@ -1,3 +1,38 @@ type: object -description: The refund's refunds. +description: The refund's details. x-schemaName: BaseRefund +required: + - id + - amount + - created_at + - payment +properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + type: object + refund_reason: + $ref: ./RefundReason.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml index 778b10a689..bbf5758714 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRegion.yaml @@ -1,5 +1,5 @@ type: object -description: The parent's region. +description: The region's details. x-schemaName: BaseRegion required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml index ee76c5c787..5fd0a02708 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRegionCountry.yaml @@ -1,3 +1,33 @@ type: object -description: The country's countries. +description: The country's details. x-schemaName: BaseRegionCountry +properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. +required: + - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml deleted file mode 100644 index 3f0906bd54..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/BaseReturnItem.yaml +++ /dev/null @@ -1,3 +0,0 @@ -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 index b5c88a34d8..d46a97718a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseRuleOperatorOptions.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseRuleOperatorOptions.yaml @@ -1,5 +1,5 @@ type: object -description: The operator's operators. +description: The operator's details. x-schemaName: BaseRuleOperatorOptions required: - id @@ -10,11 +10,14 @@ properties: type: string title: id description: The operator's ID. + example: in value: type: string title: value description: The operator's value. + example: in label: type: string title: label description: The operator's label. + example: In diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml index e20885775e..53869e4f40 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The adjustment's details. x-schemaName: BaseShippingMethodAdjustment +required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method the adjustment is applied on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml index e7e494dae5..50c5ff23ef 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseShippingMethodTaxLine.yaml @@ -1,3 +1,62 @@ type: object -description: The tax line's tax lines. +description: The tax line's details. x-schemaName: BaseShippingMethodTaxLine +required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of this shipping method the tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider that calculated the taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml index 5217a9aa3b..14de28c42e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CreateAddress.yaml @@ -1,51 +1,52 @@ type: object -description: The cart's shipping address. +description: The address to create. x-schemaName: CreateAddress properties: customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. + description: The address's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml deleted file mode 100644 index ea5d127dd2..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCartAddress.yaml +++ /dev/null @@ -1,47 +0,0 @@ -type: object -description: The cart's billing address. -x-schemaName: CreateCartAddress -properties: - 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml deleted file mode 100644 index fc4ffc2354..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/CreateCartCreateLineItem.yaml +++ /dev/null @@ -1,97 +0,0 @@ -type: object -description: The item's items. -x-schemaName: CreateCartCreateLineItem -required: - - quantity - - variant_id -properties: - quantity: - type: string - title: quantity - description: The item's quantity. - variant_id: - type: string - title: variant_id - description: The item's variant 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. - 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. - is_giftcard: - type: boolean - title: is_giftcard - description: The item's is giftcard. - compare_at_unit_price: - type: string - title: compare_at_unit_price - description: The item's compare at unit price. - unit_price: - type: string - title: unit_price - description: The item's unit price. - metadata: - type: object - description: The item's metadata. 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/CustomerGroupInCustomerFilters.yaml b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml index fcc67cf89c..e16fde8c9b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/CustomerGroupInCustomerFilters.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's groups. +description: Filter by customer groups to get their associated customers. x-schemaName: CustomerGroupInCustomerFilters required: - id @@ -12,27 +12,27 @@ properties: oneOf: - type: string title: id - description: The group's ID. + description: Filter by a group's ID. - type: array - description: The group's ID. + description: Filter by group IDs. items: type: string title: id - description: The id's ID. + description: A group's ID. name: oneOf: - type: string title: name - description: The group's name. + description: Filter by a group's name. - type: array - description: The group's name. + description: Filter by group names. items: type: string title: name - description: The name's details. + description: A group's name. created_at: type: object - description: The group's created at. + description: Filter by the group's creation date. properties: $and: type: array @@ -56,7 +56,7 @@ properties: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -159,7 +159,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The group's updated at. + description: Filter by the group's update date. properties: $and: type: array @@ -183,7 +183,7 @@ properties: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -286,7 +286,7 @@ properties: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The group's deleted at. + description: Filter by the group's deletion date. properties: $and: type: array @@ -310,7 +310,7 @@ properties: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq diff --git a/www/apps/api-reference/specs/store/components/schemas/File.yaml b/www/apps/api-reference/specs/store/components/schemas/File.yaml deleted file mode 100644 index 20c6a466af..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/File.yaml +++ /dev/null @@ -1,45 +0,0 @@ -type: object -description: The product's file. -x-schemaName: File -required: - - lastModified - - name - - webkitRelativePath - - size - - type - - arrayBuffer - - stream - - text -properties: - lastModified: - type: number - title: lastModified - description: The file's lastmodified. - name: - type: string - title: name - description: The file's name. - webkitRelativePath: - type: string - title: webkitRelativePath - description: The file's webkitrelativepath. - size: - type: number - title: size - description: The file's size. - type: - type: string - title: type - description: The file's type. - arrayBuffer: - type: object - description: The file's arraybuffer. - slice: - type: object - description: The file's slice. - stream: - type: object - description: The file's stream. - text: - type: object - description: The file's text. diff --git a/www/apps/api-reference/specs/store/components/schemas/FileList.yaml b/www/apps/api-reference/specs/store/components/schemas/FileList.yaml deleted file mode 100644 index 2bc70ab8fb..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/FileList.yaml +++ /dev/null @@ -1,18 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: FileList -required: - - length - - item - - __@iterator@258 -properties: - length: - type: number - title: length - description: The upload's length. - item: - type: object - description: The upload's item. - __@iterator@258: - type: object - description: The upload's @iterator@258. diff --git a/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml b/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml index ff883a1a28..aa13bb7243 100644 --- a/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/InventoryLevel.yaml @@ -1,5 +1,5 @@ type: object -description: The inventory level's inventory levels. +description: The inventory level's details x-schemaName: InventoryLevel required: - id @@ -17,11 +17,11 @@ properties: inventory_item_id: type: string title: inventory_item_id - description: The inventory level's inventory item id. + description: The ID of the associated inventory item. location_id: type: string title: location_id - description: The inventory level's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity @@ -40,4 +40,4 @@ properties: description: The inventory level's incoming quantity. metadata: type: object - description: The inventory level's metadata. + description: The inventory level's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/Order.yaml b/www/apps/api-reference/specs/store/components/schemas/Order.yaml index 8c90e11018..47214c6a82 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -1,3 +1,296 @@ type: object -description: The transaction's order. +description: The order change's order. x-schemaName: Order +required: + - id + - version + - status + - currency_code + - 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_subtotal + - 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's ID. + version: + type: number + title: version + description: The order's version. + order_change: + type: object + status: + type: string + description: The order's status. + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The ID of the region the order belongs to. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order was placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + example: usd + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + items: + type: array + description: The order's items. + items: + $ref: ./OrderLineItem.yaml + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: ./OrderShippingMethod.yaml + transactions: + type: array + description: The order's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The order's summary. + metadata: + type: object + description: The order's metadata, can hold custom key-value pairs. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the order was canceled. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The order items' total including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order items' total excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The taxes total for order items, excluding promotions. + item_total: + type: number + title: item_total + description: The order items' total including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The order items' total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order items including promotions. + original_total: + type: number + title: original_total + description: The order's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the order including promotions. + discount_subtotal: + type: number + title: discount_subtotal + description: The total discount excluding taxes. + discount_total: + type: number + title: discount_total + description: The total discount including taxes. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total applied on the discount. + 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 including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The total taxes of the order's shipping including taxes. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The total taxes of the order's shipping excluding promotions. + raw_original_item_total: + type: object + description: The order's raw original item total. + raw_original_item_subtotal: + type: object + description: The order's raw original item subtotal. + raw_original_item_tax_total: + type: object + description: The order's raw original item tax total. + raw_item_total: + type: object + description: The order's raw item total. + raw_item_subtotal: + type: object + description: The order's raw item subtotal. + raw_item_tax_total: + type: object + description: The order's raw item tax total. + raw_original_total: + type: object + description: The order's raw original total. + raw_original_subtotal: + type: object + description: The order's raw original subtotal. + raw_original_tax_total: + type: object + description: The order's raw original tax total. + raw_total: + type: object + description: The order's raw total. + raw_subtotal: + type: object + description: The order's raw subtotal. + raw_tax_total: + type: object + description: The order's raw tax total. + raw_discount_total: + type: object + description: The order's raw discount total. + raw_discount_tax_total: + type: object + description: The order's raw discount tax total. + raw_gift_card_total: + type: object + description: The order's raw gift card total. + raw_gift_card_tax_total: + type: object + description: The order's raw gift card tax total. + raw_shipping_total: + type: object + description: The order's raw shipping total. + raw_shipping_subtotal: + type: object + description: The order's raw shipping subtotal. + raw_shipping_tax_total: + type: object + description: The order's raw shipping tax total. + raw_original_shipping_total: + type: object + description: The order's raw original shipping total. + raw_original_shipping_subtotal: + type: object + description: The order's raw original shipping subtotal. + raw_original_shipping_tax_total: + type: object + description: The order's raw original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml index 2006536055..3108787026 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The order preview's billing address. +description: The address's details. x-schemaName: OrderAddress required: - id @@ -9,61 +9,62 @@ properties: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The billing address's updated at. + description: The date the address was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml index e4b9f03dab..58d07e2b68 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChange.yaml @@ -1,5 +1,5 @@ type: object -description: The order preview's order change. +description: The order change's details. x-schemaName: OrderChange required: - id @@ -34,10 +34,12 @@ properties: version: type: number title: version - description: The order change's version. + description: >- + The order change's version. This will be the order's version when the + change is applied. change_type: type: string - description: The order change's change type. + description: The order change's type. enum: - return - exchange @@ -46,23 +48,23 @@ properties: order_id: type: string title: order_id - description: The order change's order id. + description: The ID of the order this change applies on. return_id: type: string title: return_id - description: The order change's return id. + description: The ID of the associated return. exchange_id: type: string title: exchange_id - description: The order change's exchange id. + description: The ID of the associated exchange. claim_id: type: string title: claim_id - description: The order change's claim id. + description: The ID of the associated claim. order: type: object return_order: - $ref: ./Return.yaml + type: object exchange: $ref: ./OrderExchange.yaml claim: @@ -74,74 +76,63 @@ properties: $ref: ./OrderChangeAction.yaml status: type: string - title: status description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined requested_by: type: string title: requested_by - description: The order change's requested by. + description: The ID of the user that requested the change. 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 + type: string + title: requested_at + description: The date the order change was requested. + format: date-time confirmed_by: type: string title: confirmed_by - description: The order change's confirmed by. + description: The ID of the user that confirmed the order change. 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 + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time declined_by: type: string title: declined_by - description: The order change's declined by. + description: The ID of the user that declined the order change. declined_reason: type: string title: declined_reason - description: The order change's declined reason. + description: The reason the order change was declined. metadata: type: object - description: The order change's metadata. + description: The order change's metadata, can hold custom key-value pairs. 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 + type: string + title: declined_at + description: The date the order change was declined. + format: date-time canceled_by: type: string title: canceled_by - description: The order change's canceled by. + description: The ID of the user that canceled the order change. 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 + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time created_at: type: string format: date-time title: created_at - description: The order change's created at. + description: The date the order change was created. updated_at: type: string format: date-time title: updated_at - description: The order change's updated at. + description: The date the order change was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml index 13a80ba767..d21c904f16 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderChangeAction.yaml @@ -1,3 +1,100 @@ type: object -description: The action's actions. +description: The order change action's details. x-schemaName: OrderChangeAction +required: + - id + - order_change_id + - order_change + - order_id + - return_id + - claim_id + - exchange_id + - order + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: ./Order.yaml + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml index 7d1a9d3366..41bb209451 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml @@ -1,3 +1,257 @@ type: object description: The order change's claim. x-schemaName: OrderClaim +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: + id: + type: string + title: id + description: The claim's ID. + order_id: + type: string + title: order_id + description: The ID of the order associated with the claim. + claim_items: + type: array + description: The order items targetted by the claim. + items: + $ref: ./BaseClaimItem.yaml + additional_items: + type: array + description: The outbound or new items of the claim. + items: + $ref: ./BaseClaimItem.yaml + return: + type: object + return_id: + type: string + title: return_id + description: The ID of the associated return. + no_notification: + type: boolean + title: no_notification + description: Whether the customer should be notified about changes in the claim. + refund_amount: + type: number + title: refund_amount + description: The amount to be refunded. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + region_id: + type: string + title: region_id + description: The ID of the region associated with the claim. + customer_id: + type: string + title: customer_id + description: The ID of the customer associated with the claim's order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the claim's order is created in. + email: + type: string + title: email + description: The email associated with the claim's order. + format: email + display_id: + type: number + 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 + description: The claim's payment status. + 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 + description: The claim's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + description: Learn more about transactions of orders and associated models. + items: + $ref: ./BaseOrderTransaction.yaml + summary: + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The claim's metadata, used to store custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The claim's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's update date. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the associated order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the associated order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the original items in the associated order. + item_total: + type: number + title: item_total + description: The total of the claim's items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the claim's items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the claim's items. + original_total: + type: number + title: original_total + description: The associated order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The associated order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The associated order's original tax total. + total: + type: number + title: total + description: The associated order'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 associated order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The associated order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The associated order's original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml index 0c83b9bb1b..c0ba54357b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml @@ -1,3 +1,263 @@ type: object description: The order change's exchange. x-schemaName: OrderExchange +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 ID of the order the exchange is created for. + return_items: + type: array + description: The items returned (inbound) by the exchange. + items: + $ref: ./AdminReturnItem.yaml + additional_items: + type: array + description: The new items (outbound) sent by the exchange. + items: + $ref: ./BaseExchangeItem.yaml + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer notifications when the exchange is updated. + difference_due: + type: number + title: difference_due + description: >- + The amount to be exchanged or refunded. If the amount is negative, it must + be refunded. If positive, additional payment is required from the + customer. + return: + description: the return associated with the exchange. + $ref: ./AdminReturn.yaml + return_id: + type: string + title: return_id + description: The ID of the associated exchange. + 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 ID of the associated order's region. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the associated order belongs to. + email: + type: string + title: email + description: The email used when placing the order. + format: email + display_id: + type: number + title: display_id + description: The exchange's display ID. + shipping_address: + description: The shipping address to send new items to. + $ref: ./BaseOrderAddress.yaml + billing_address: + description: The customer's billing address. + $ref: ./BaseOrderAddress.yaml + shipping_methods: + type: array + description: The shipping methods used to send the new (outbound) items. + items: + $ref: ./BaseOrderShippingMethod.yaml + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: ./BasePaymentCollection.yaml + payment_status: + type: string + description: The exchange's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments of new (outbound) items. + items: + $ref: ./BaseOrderFulfillment.yaml + fulfillment_status: + type: string + description: The exchange's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + items: + $ref: ./BaseOrderTransaction.yaml + summary: + description: The totals summary of the exchange. + $ref: ./BaseOrderSummary.yaml + metadata: + type: object + description: The exchange's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date that the exchange was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date that the exchange was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The total tax of the original items in the order. + item_total: + type: number + title: item_total + description: The total of the exchange's new items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the exchange's new items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the exchange's new items. + original_total: + type: number + title: original_total + description: The total of the order. + original_subtotal: + type: number + title: original_subtotal + description: The subtotal of the order. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order. + total: + type: number + title: total + description: The total of the exchange. + subtotal: + type: number + title: subtotal + description: The subtotal of the exchange. + tax_total: + type: number + title: tax_total + description: The tax total of the exchange. + discount_total: + type: number + title: discount_total + description: The discount total of the exchange. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on discount of the exchange. + gift_card_total: + type: number + title: gift_card_total + description: The gift cards total of the exchange. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The total taxes on the gift card of the exchange. + 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 order's shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml index d7584d2fbe..ccd2567ac5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml @@ -1,3 +1,106 @@ type: object -description: The item's detail. +description: The order item's detail. x-schemaName: OrderItem +required: + - id + - item_id + - item + - quantity + - raw_quantity + - fulfilled_quantity + - raw_fulfilled_quantity + - delivered_quantity + - raw_delivered_quantity + - shipped_quantity + - raw_shipped_quantity + - return_requested_quantity + - raw_return_requested_quantity + - return_received_quantity + - raw_return_received_quantity + - return_dismissed_quantity + - raw_return_dismissed_quantity + - written_off_quantity + - raw_written_off_quantity + - metadata + - created_at + - updated_at +properties: + id: + type: string + title: id + description: The item's ID. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + raw_fulfilled_quantity: + type: object + description: The item's raw fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The item's delivered quantity. + raw_delivered_quantity: + type: object + description: The item's raw delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + raw_shipped_quantity: + type: object + description: The item's raw shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + raw_return_requested_quantity: + type: object + description: The item's raw return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The item's quantity that's received through a return. + raw_return_received_quantity: + type: object + description: The item's raw return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The item's quantity that's returned but dismissed because it's damaged. + raw_return_dismissed_quantity: + type: object + description: The item's raw return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed due to an order change. + raw_written_off_quantity: + type: object + description: The item's raw written off quantity. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. 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..7872ecc8f1 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml @@ -0,0 +1,435 @@ +type: object +description: The order line item's details. +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 URL. + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the associated product's type. + product_collection: + type: string + title: product_collection + description: The ID of the associated product's 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 associated variant's values for the associated product's options. + example: + Color: Red + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item's price includes taxes. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw compare at unit price's value. + - type: number + title: value + description: The raw compare at unit price's value. + unit_price: + type: number + title: unit_price + description: The item's price for a single quantity. + raw_unit_price: + type: object + description: The item's raw unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw unit price's value. + - type: number + title: value + description: The raw unit price's value. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + 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 + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes and promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. + item_total: + type: number + title: item_total + description: The item's total for a single quantity, including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: >- + The item's total for a single quantity, excluding taxes and including + promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of a single quantity of the item, including promotions. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the item, including promotions. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total amount of the item that can be refunded. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total amount that can be refunded of a single quantity of the item. + raw_original_total: + type: object + description: The item'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 item'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 item'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_item_total: + type: object + description: The item'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 item'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 item'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_total: + type: object + description: The item'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 item'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 item'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 item'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 item'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_refundable_total: + type: object + description: The item's raw refundable total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total's value. + - type: number + title: value + description: The raw refundable total's value. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total per unit's value. + - type: number + title: value + description: The raw refundable total per unit's value. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml index 18f5e20824..caeb06aecf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The line item adjustment's details. x-schemaName: OrderLineItemAdjustment +required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml index 0b002d0419..90d590d62b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml @@ -1,3 +1,70 @@ type: object -description: The tax line's tax lines. +description: The line item tax line's details. x-schemaName: OrderLineItemTaxLine +required: + - item + - item_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at +properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the line item that the tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax lines. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml deleted file mode 100644 index 56edabcde0..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml +++ /dev/null @@ -1,1550 +0,0 @@ -type: object -description: The order edit's order preview. -x-schemaName: OrderPreview -required: - - order_change - - status - - currency_code - - version - - id - - 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: - order_change: - $ref: ./OrderChange.yaml - items: - type: array - description: The order preview's items. - items: - allOf: - - 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 - format: date-time - title: created_at - description: The item's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The item's updated at. - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: ./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. - - 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: OrderChangeAction - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - allOf: - - 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. - - 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: OrderChangeAction - status: - type: string - description: The order preview's status. - enum: - - canceled - - requires_action - - pending - - completed - - draft - - archived - currency_code: - type: string - title: currency_code - description: The order preview's currency code. - version: - type: number - title: version - description: The order preview's version. - id: - type: string - title: id - description: The order preview's ID. - 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 - shipping_address: - $ref: ./OrderAddress.yaml - billing_address: - $ref: ./OrderAddress.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 - - pending_difference - - raw_pending_difference - 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 - pending_difference: - oneOf: - - type: string - title: pending_difference - description: The summary's pending difference. - - type: number - title: pending_difference - description: The summary's pending difference. - - type: string - title: pending_difference - description: The summary's pending difference. - - type: object - description: The summary's pending difference. - x-schemaName: IBigNumber - raw_pending_difference: - type: object - description: The summary's raw pending difference. - 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: - 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 - 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 - 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/OrderReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml new file mode 100644 index 0000000000..2b2fa31a38 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml @@ -0,0 +1,50 @@ +type: object +description: The item's items. +x-schemaName: OrderReturnItem +required: + - id + - quantity + - received_quantity + - damaged_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 received quantity of the item. This quantity is added to the stocked + inventory quantity of the item. + damaged_quantity: + type: number + title: damaged_quantity + description: >- + The received damaged quantity of the item, which isn't added to the + stocked inventory quantity of the item. + reason_id: + type: string + title: reason_id + description: The ID of the return reason associated with the item. + note: + type: string + title: note + description: A note about why the item was returned. + item_id: + type: string + title: item_id + description: The ID of the associated order item. + return_id: + type: string + title: return_id + description: The ID of the return this return item belongs to. + metadata: + type: object + description: The return item's metadata, can hold custom key-value pairs. 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..892005eea0 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml @@ -0,0 +1,246 @@ +type: object +description: The shipping method's details. +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 ID of the order that the shipping method belongs to. + 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. + raw_amount: + type: object + description: The shipping method's raw amount. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw amount's value. + - type: number + title: value + description: The raw amount's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the shipping method's amount includes taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: >- + The shipping method's data, useful for the fulfillment provider handling + the fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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 date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's subtotal excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the shipping method excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the shipping method, including promotions. + discount_total: + type: number + title: discount_total + description: The shipping method's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes of the discount amount. + raw_original_total: + type: object + description: The shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml index a05be82f62..c63afb13c0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodAdjustment.yaml @@ -1,3 +1,56 @@ type: object -description: The adjustment's adjustments. +description: The shipping method adjustment's details. x-schemaName: OrderShippingMethodAdjustment +required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion this adjustment applies. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml index 89976e41b4..d49d3e1414 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml @@ -1,3 +1,70 @@ type: object -description: The tax line's tax lines. +description: The shipping method tax line's details. x-schemaName: OrderShippingMethodTaxLine +required: + - shipping_method + - shipping_method_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at +properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method that this tax line is for. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml index fe6226719f..100e873e64 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml @@ -1,18 +1,16 @@ type: object -description: The transaction's transactions. +description: The transaction's details. x-schemaName: OrderTransaction required: - id - order_id - - order - amount - - raw_amount - currency_code - reference - reference_id + - metadata - created_at - updated_at - - metadata properties: id: type: string @@ -21,46 +19,40 @@ properties: order_id: type: string title: order_id - description: The transaction's order id. - order: - type: object + description: The ID of the order this transaction belongs to. 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. + type: number + title: amount + description: The transaction's amount. currency_code: type: string title: currency_code description: The transaction's currency code. + example: usd reference: type: string title: reference - description: The transaction's reference. + description: >- + The name of a table that this transaction references. If this transaction + is for captured payment, its value is `capture`. If this transaction is + for refunded payment, its value is `refund`. + enum: + - capture + - refund reference_id: type: string title: reference_id - description: The transaction's reference id. + description: The ID of the referenced record in the referenced table. + metadata: + type: object + description: The transaction's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The transaction's created at. + description: The date that the transaction was created. updated_at: type: string format: date-time title: updated_at - description: The transaction's updated at. - metadata: - type: object - description: The transaction's metadata. + description: The date that the transaction was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml b/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml new file mode 100644 index 0000000000..5c68174797 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/RefundReason.yaml @@ -0,0 +1,35 @@ +type: object +description: The refund reason's details. +x-schemaName: RefundReason +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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund reason was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the refund reason was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml index 2ccee98673..e3f9c36587 100644 --- a/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/RefundReasonResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The refund reason's details. x-schemaName: RefundReasonResponse required: - refund_reason diff --git a/www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml deleted file mode 100644 index d66cc74750..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/ReservationResponse.yaml +++ /dev/null @@ -1,66 +0,0 @@ -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 index 529ada57ca..b16dbae793 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Return.yaml @@ -1,3 +1,299 @@ type: object -description: The order change's return order. +description: The return's details. x-schemaName: Return +required: + - id + - status + - order_id + - items + - currency_code + - 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 + - discount_subtotal + - 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 return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. + order_id: + type: string + title: order_id + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: ./OrderReturnItem.yaml + region_id: + type: string + title: region_id + description: The ID of the region this return belongs to. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the associated order's sales channel. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The return's currency code. + example: usd + shipping_address: + $ref: ./OrderAddress.yaml + billing_address: + $ref: ./OrderAddress.yaml + shipping_methods: + type: array + description: The return's shipping methods. + items: + $ref: ./OrderShippingMethod.yaml + transactions: + type: array + description: The return's transactions. + items: + $ref: ./OrderTransaction.yaml + summary: + type: object + description: The return's summary. + metadata: + type: object + description: The return's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the return was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the return was updated. + original_item_total: + type: number + title: original_item_total + description: The return's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The return's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The return's original item tax total. + item_total: + type: number + title: item_total + description: The return's item total. + item_subtotal: + type: number + title: item_subtotal + description: The return's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The return's item tax total. + original_total: + type: number + title: original_total + description: The return's original total. + original_subtotal: + type: number + title: original_subtotal + description: The return's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The return's original tax total. + total: + type: number + title: total + description: The return's total. + subtotal: + type: number + title: subtotal + description: The return's subtotal. + tax_total: + type: number + title: tax_total + description: The return's tax total. + discount_total: + type: number + title: discount_total + description: The return's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The return's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The return's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The return's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The return's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The return's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The return's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The return's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The return's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The return's original shipping tax total. + order_change: + $ref: ./OrderChange.yaml + canceled_at: + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time + discount_subtotal: + type: number + title: discount_subtotal + description: The return's discount subtotal. + raw_original_item_total: + type: object + description: The return's raw original item total. + raw_original_item_subtotal: + type: object + description: The return's raw original item subtotal. + raw_original_item_tax_total: + type: object + description: The return's raw original item tax total. + raw_item_total: + type: object + description: The return's raw item total. + raw_item_subtotal: + type: object + description: The return's raw item subtotal. + raw_item_tax_total: + type: object + description: The return's raw item tax total. + raw_original_total: + type: object + description: The return's raw original total. + raw_original_subtotal: + type: object + description: The return's raw original subtotal. + raw_original_tax_total: + type: object + description: The return's raw original tax total. + raw_total: + type: object + description: The return's raw total. + raw_subtotal: + type: object + description: The return's raw subtotal. + raw_tax_total: + type: object + description: The return's raw tax total. + raw_discount_total: + type: object + description: The return's raw discount total. + raw_discount_tax_total: + type: object + description: The return's raw discount tax total. + raw_gift_card_total: + type: object + description: The return's raw gift card total. + raw_gift_card_tax_total: + type: object + description: The return's raw gift card tax total. + raw_shipping_total: + type: object + description: The return's raw shipping total. + raw_shipping_subtotal: + type: object + description: The return's raw shipping subtotal. + raw_shipping_tax_total: + type: object + description: The return's raw shipping tax total. + raw_original_shipping_total: + type: object + description: The return's raw original shipping total. + raw_original_shipping_subtotal: + type: object + description: The return's raw original shipping subtotal. + raw_original_shipping_tax_total: + type: object + description: The return's raw original shipping tax total. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml index c791cbd824..8ce18622d4 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the line item to add. x-schemaName: StoreAddCartLineItem required: - variant_id @@ -8,11 +8,11 @@ properties: variant_id: type: string title: variant_id - description: The cart's variant id. + description: The ID of the product variant to add to the cart. quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml deleted file mode 100644 index 729f1b95bd..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCalculateCartTaxes.yaml +++ /dev/null @@ -1,8 +0,0 @@ -type: object -description: SUMMARY -x-schemaName: StoreCalculateCartTaxes -properties: - fields: - type: string - title: fields - description: The cart's fields. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml index 73037779af..9ec4dc1c9f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCart.yaml @@ -1,9 +1,9 @@ type: object -description: The cart's parent. +description: The cart's details. x-schemaName: StoreCart required: - - id - currency_code + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -30,320 +30,148 @@ properties: id: type: string title: id - description: The parent's ID. + description: The cart's ID. region: - $ref: ./BaseRegion.yaml + $ref: ./StoreRegion.yaml region_id: type: string title: region_id - description: The parent's region id. + description: The ID of the region the cart belongs to. customer_id: type: string title: customer_id - description: The parent's customer id. + description: The ID of the customer the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The parent's sales channel id. + description: >- + The ID of the cart's sales channel. Only products that belong to the same + sales channel can be added to the cart. The created order will be + associated with the same sales channel. email: type: string title: email - description: The parent's email. + description: The email of the customer the cart belongs to. format: email currency_code: type: string title: currency_code - description: The parent's currency code. + description: The cart's currency code. + example: usd shipping_address: - $ref: ./BaseCartAddress.yaml + $ref: ./StoreCartAddress.yaml billing_address: - $ref: ./BaseCartAddress.yaml + $ref: ./StoreCartAddress.yaml items: type: array - description: The parent's items. + description: The cart's items. items: - $ref: ./BaseCartLineItem.yaml + $ref: ./StoreCartLineItem.yaml shipping_methods: type: array - description: The parent's shipping methods. + description: The cart's shipping methods. items: - $ref: ./BaseCartShippingMethod.yaml + $ref: ./StoreCartShippingMethod.yaml payment_collection: - $ref: ./BasePaymentCollection.yaml + $ref: ./StorePaymentCollection.yaml metadata: type: object - description: The parent's metadata. + description: The cart's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the cart was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the cart was updated. original_item_total: - oneOf: - - type: string - title: original_item_total - description: The parent's original item total. - - type: number - title: original_item_total - description: The parent's original item total. - - type: string - title: original_item_total - description: The parent's original item total. - - $ref: ./IBigNumber.yaml + type: number + title: original_item_total + description: The cart items' total including taxes, excluding promotions. original_item_subtotal: - oneOf: - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - type: number - title: original_item_subtotal - description: The parent's original item subtotal. - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: original_item_subtotal + description: The cart items' total excluding taxes, including promotions. original_item_tax_total: - oneOf: - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - type: number - title: original_item_tax_total - description: The parent's original item tax total. - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - $ref: ./IBigNumber.yaml + type: number + title: original_item_tax_total + description: The cart items' tax total excluding promotions. item_total: - oneOf: - - type: string - title: item_total - description: The parent's item total. - - type: number - title: item_total - description: The parent's item total. - - type: string - title: item_total - description: The parent's item total. - - $ref: ./IBigNumber.yaml + type: number + title: item_total + description: The cart items' total including taxes and promotions. item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The parent's item subtotal. - - type: number - title: item_subtotal - description: The parent's item subtotal. - - type: string - title: item_subtotal - description: The parent's item subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: item_subtotal + description: The cart items' total excluding taxes, including promotions. item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The parent's item tax total. - - type: number - title: item_tax_total - description: The parent's item tax total. - - type: string - title: item_tax_total - description: The parent's item tax total. - - $ref: ./IBigNumber.yaml + type: number + title: item_tax_total + description: The cart items' tax total including promotions. original_total: - oneOf: - - type: string - title: original_total - description: The parent's original total. - - type: number - title: original_total - description: The parent's original total. - - type: string - title: original_total - description: The parent's original total. - - $ref: ./IBigNumber.yaml + type: number + title: original_total + description: The cart's total including taxes, excluding promotions. original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The parent's original subtotal. - - type: number - title: original_subtotal - description: The parent's original subtotal. - - type: string - title: original_subtotal - description: The parent's original subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: original_subtotal + description: The cart's total excluding taxes, including promotions. original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The parent's original tax total. - - type: number - title: original_tax_total - description: The parent's original tax total. - - type: string - title: original_tax_total - description: The parent's original tax total. - - $ref: ./IBigNumber.yaml + type: number + title: original_tax_total + description: The cart's tax total excluding promotions. total: - oneOf: - - type: string - title: total - description: The parent's total. - - type: number - title: total - description: The parent's total. - - type: string - title: total - description: The parent's total. - - $ref: ./IBigNumber.yaml + type: number + title: total + description: The cart's total including taxes and promotions. subtotal: - oneOf: - - type: string - title: subtotal - description: The parent's subtotal. - - type: number - title: subtotal - description: The parent's subtotal. - - type: string - title: subtotal - description: The parent's subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: subtotal + description: The cart's total excluding taxes, including promotions. tax_total: - oneOf: - - type: string - title: tax_total - description: The parent's tax total. - - type: number - title: tax_total - description: The parent's tax total. - - type: string - title: tax_total - description: The parent's tax total. - - $ref: ./IBigNumber.yaml + type: number + title: tax_total + description: The cart's tax total including promotions. discount_total: - oneOf: - - type: string - title: discount_total - description: The parent's discount total. - - type: number - title: discount_total - description: The parent's discount total. - - type: string - title: discount_total - description: The parent's discount total. - - $ref: ./IBigNumber.yaml + type: number + title: discount_total + description: The cart's discount total. discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - type: number - title: discount_tax_total - description: The parent's discount tax total. - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - $ref: ./IBigNumber.yaml + type: number + title: discount_tax_total + description: The tax total applied on the discounted amount. gift_card_total: - oneOf: - - type: string - title: gift_card_total - description: The parent's gift card total. - - type: number - title: gift_card_total - description: The parent's gift card total. - - type: string - title: gift_card_total - description: The parent's gift card total. - - $ref: ./IBigNumber.yaml + type: number + title: gift_card_total + description: The total gift card amount applied on the cart. gift_card_tax_total: - oneOf: - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: number - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - $ref: ./IBigNumber.yaml + type: number + title: gift_card_tax_total + description: The total taxes applied on the gift card amount. shipping_total: - oneOf: - - type: string - title: shipping_total - description: The parent's shipping total. - - type: number - title: shipping_total - description: The parent's shipping total. - - type: string - title: shipping_total - description: The parent's shipping total. - - $ref: ./IBigNumber.yaml + type: number + title: shipping_total + description: The cart's shipping total including taxes and promotions. shipping_subtotal: - oneOf: - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: number - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. shipping_tax_total: - oneOf: - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - type: number - title: shipping_tax_total - description: The parent's shipping tax total. - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - $ref: ./IBigNumber.yaml + type: number + title: shipping_tax_total + description: The total taxes applied on the cart's shipping amount. original_shipping_total: - oneOf: - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - type: number - title: original_shipping_total - description: The parent's original shipping total. - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - $ref: ./IBigNumber.yaml + type: number + title: original_shipping_total + description: The cart's shipping total including taxes, excluding promotions. original_shipping_subtotal: - oneOf: - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: number - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - $ref: ./IBigNumber.yaml + type: number + title: original_shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. original_shipping_tax_total: - oneOf: - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: number - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - $ref: ./IBigNumber.yaml + type: number + title: original_shipping_tax_total + description: The total taxes applied on the cart's shipping amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml index af376781b2..15aa12c9eb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's billing address. +description: The address's details. x-schemaName: StoreCartAddress required: - id @@ -9,69 +9,62 @@ properties: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: - oneOf: - - type: string - title: created_at - description: The billing address's created at. - - type: string - title: created_at - description: The billing address's created at. - format: date-time + type: string + title: created_at + description: The date the address was created. + format: date-time updated_at: - oneOf: - - type: string - title: updated_at - description: The billing address's updated at. - - type: string - title: updated_at - description: The billing address's updated at. - format: date-time + type: string + title: updated_at + description: The date the address was updated. + format: date-time diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml index 1b92e40ec6..824b9623cb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartLineItem.yaml @@ -1,27 +1,27 @@ type: object -description: The item's items. +description: The item's details. x-schemaName: StoreCartLineItem required: - - id - - title - - quantity - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - cart - - cart_id - - original_total - - original_subtotal - - original_tax_total + - title + - id - item_total - item_subtotal - item_tax_total + - original_total + - original_subtotal + - original_tax_total - total - subtotal - tax_total - discount_total - discount_tax_total + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - cart_id properties: id: type: string @@ -38,25 +38,17 @@ properties: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The item's thumbnail URL. 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 + type: number + title: quantity + description: The item's quantity. product: - $ref: ./BaseProduct.yaml + $ref: ./StoreProduct.yaml product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -72,25 +64,25 @@ properties: product_type: type: string title: product_type - description: The item's product type. + description: The ID of the associated product's type. product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the associated product's collection. product_handle: type: string title: product_handle description: The item's product handle. variant: - $ref: ./BaseProductVariant.yaml + $ref: ./StoreProductVariant.yaml variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -101,206 +93,246 @@ properties: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The associated variant's value for the product's options. + example: + Color: Red requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item's price includes taxes. 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 + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. 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 + type: number + title: unit_price + description: The price of a single quantity of the item. tax_lines: type: array description: The item's tax lines. items: - $ref: ./BaseLineItemTaxLine.yaml + allOf: + - type: object + description: The tax line's details. + x-schemaName: BaseLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + item_id: + type: string + title: item_id + description: The ID of the line item this tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + description: The tax line's details adjustments: type: array description: The item's adjustments. items: - $ref: ./BaseLineItemAdjustment.yaml + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseLineItemAdjustment + required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + item_id: + type: string + title: item_id + description: The ID of the item that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + description: The adjustment's details. cart: - $ref: ./BaseCart.yaml + type: object cart_id: type: string title: cart_id - description: The item's cart id. + description: The ID of the cart that the line item belongs to. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string title: created_at - description: The item's created at. + description: The date the item was created. format: date-time updated_at: type: string title: updated_at - description: The item's updated at. + description: The date the item was updated. format: date-time deleted_at: type: string title: deleted_at - description: The item's deleted at. + description: The date the item was deleted. 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 + type: number + title: original_total + description: The item's total including taxes, excluding promotions. 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 + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. 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 + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. 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 + type: number + title: original_tax_total + description: The item's total including taxes and promotions. 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 + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. 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 + type: number + title: item_tax_total + description: The total taxes of the item including promotions. 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 + type: number + title: total + description: The item's total including taxes and promotions. 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 + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. 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 + type: number + title: tax_total + description: The total taxes of the item including promotions. 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 + type: number + title: discount_total + description: The total discount of the item. 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 + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml index 2bfa43f956..43ad8c7035 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The cart's details. x-schemaName: StoreCartResponse required: - cart diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml new file mode 100644 index 0000000000..818a670856 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCartShippingMethod.yaml @@ -0,0 +1,253 @@ +type: object +description: A cart's shipping method. +x-schemaName: StoreCartShippingMethod +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 ID of the cart this shipping method belongs to. + 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: Whether the shipping method's amount is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: >- + The shipping method's data, useful for fulfillment handling by third-party + services. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's details + x-schemaName: BaseShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments, such as applied promotions. + items: + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + description: The adjustment's details. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. + total: + type: number + title: total + description: The shipping method's total amount including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: >- + The total taxes applied on the shipping method's amount including + promotions. + discount_total: + type: number + title: discount_total + description: The total amount discounted. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discounted amount. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml index a336103bb6..ad9bc1b4ea 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml @@ -2,13 +2,13 @@ type: object description: The collection's details. x-schemaName: StoreCollection required: - - id - title + - metadata + - id - handle - created_at - updated_at - deleted_at - - metadata properties: id: type: string @@ -26,22 +26,22 @@ properties: type: string format: date-time title: created_at - description: The collection's created at. + description: The date the collection was created. updated_at: type: string format: date-time title: updated_at - description: The collection's updated at. + description: The date the collection was updated. deleted_at: type: string format: date-time title: deleted_at - description: The collection's deleted at. + description: The date the collection was deleted. products: type: array description: The collection's products. items: - $ref: ./AdminProduct.yaml + type: object metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml index ad095a583e..ee547bec16 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollectionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The collection's details. x-schemaName: StoreCollectionResponse required: - collection diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml index 41c5888a13..69fb5ff088 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCart.yaml @@ -1,11 +1,13 @@ type: object -description: SUMMARY +description: The details of the cart to be created. x-schemaName: StoreCreateCart properties: region_id: type: string title: region_id - description: The cart's region id. + description: >- + The ID of the cart's region. This affects the prices and currency of the + cart. shipping_address: $ref: ./StoreCartAddress.yaml billing_address: @@ -13,12 +15,15 @@ properties: email: type: string title: email - description: The cart's email. + description: The email of the cart's customer. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: >- + The cart's currency code. If not provided, the region's currency is used. + This affects prices in the cart, as well. + example: usd items: type: array description: The cart's items. @@ -27,7 +32,10 @@ properties: sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: >- + The ID of the sales channel that cart is created in. Only products + available in that sales channel can be added to the cart. If not provided, + the store's default sales channel is associated with the cart instead. metadata: type: object - description: The cart's metadata. + description: The cart's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml index f8f116c0fa..6821b05339 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the customer to create. x-schemaName: StoreCreateCustomer required: - email @@ -27,4 +27,4 @@ properties: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml index c88dbe20d2..d93623368f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreatePaymentCollection.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the payment collection to create. x-schemaName: StoreCreatePaymentCollection required: - cart_id @@ -7,4 +7,4 @@ properties: cart_id: type: string title: cart_id - description: The payment collection's cart id. + description: The ID of the cart this payment collection is for. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml index 60c6dc1fd5..bd5befc29b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturn.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details of the return to create. x-schemaName: StoreCreateReturn required: - order_id @@ -9,7 +9,7 @@ properties: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. items: type: array description: The return's items. @@ -20,12 +20,12 @@ properties: note: type: string title: note - description: The return's note. + description: A note with more details about the return. receive_now: type: boolean title: receive_now - description: The return's receive now. + description: Whether to mark the return as received. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location that items are returned to. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml index 021192cc25..ecdbeb0c2d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnItem.yaml @@ -1,5 +1,5 @@ type: object -description: The item's items. +description: The details of the line item to create. x-schemaName: StoreCreateReturnItem required: - id @@ -16,8 +16,8 @@ properties: reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. note: type: string title: note - description: The item's note. + description: A note with more details about the returned item. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml index ff842a7175..ee60d6374b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCreateReturnShipping.yaml @@ -1,5 +1,5 @@ type: object -description: The return's return shipping. +description: The return's shipping details. x-schemaName: StoreCreateReturnShipping required: - option_id @@ -7,8 +7,8 @@ properties: option_id: type: string title: option_id - description: The return shipping's option id. + description: The ID of the shipping option to use. price: type: number title: price - description: The return shipping's price. + description: The shipping's price. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml index 05eec9f84d..70e56aa4eb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCurrency.yaml @@ -8,7 +8,6 @@ required: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at @@ -17,6 +16,7 @@ properties: type: string title: code description: The currency's code. + example: usd symbol: type: string title: symbol @@ -37,33 +37,18 @@ properties: 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. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The currency's deleted at. + description: The date the currency was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml index cb51836b4b..349a669091 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of currencies. x-schemaName: StoreCurrencyListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The currency's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The currency's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The currency's count. + description: The total count of items. currencies: type: array - description: The currency's currencies. + description: The list of 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 index 18fffcdeeb..2bb1a6b68a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCurrencyResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The currency's details. x-schemaName: StoreCurrencyResponse required: - currency diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml index c6626ecc9c..0c0997ff3f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomer.yaml @@ -1,73 +1,69 @@ type: object -description: The customer's parent. +description: The customer's details. x-schemaName: StoreCustomer required: + - addresses - id - email - - default_billing_address_id - - default_shipping_address_id - company_name - first_name - last_name - - addresses + - default_billing_address_id + - default_shipping_address_id properties: id: type: string title: id - description: The parent's ID. + description: The customer's ID. email: type: string title: email - description: The parent's email. + description: The customer's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The parent's default billing address id. + description: The ID of the address used for billing by default. default_shipping_address_id: type: string title: default_shipping_address_id - description: The parent's default shipping address id. + description: The ID of the address used for shipping by default. company_name: type: string title: company_name - description: The parent's company name. + description: The customer's company name. first_name: type: string title: first_name - description: The parent's first name. + description: The customer's first name. last_name: type: string title: last_name - description: The parent's last name. + description: The customer's last name. addresses: type: array - description: The parent's addresses. + description: The customer's addresses. items: - $ref: ./BaseCustomerAddress.yaml + $ref: ./StoreCustomerAddress.yaml phone: type: string title: phone - description: The parent's phone. + description: The customer's phone. metadata: type: object - description: The parent's metadata. - created_by: - type: string - title: created_by - description: The parent's created by. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + description: The customer's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the customer was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the customer was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the customer was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml index 8bc8942adb..4d3108e25f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The customer's address. +description: The customer address's details x-schemaName: StoreCustomerAddress required: - id @@ -28,19 +28,19 @@ properties: address_name: type: string title: address_name - description: The address's address name. + description: The address's name. is_default_shipping: type: boolean title: is_default_shipping - description: The address's is default shipping. + description: Whether the address is used for shipping by default. is_default_billing: type: boolean title: is_default_billing - description: The address's is default billing. + description: Whether the address is used for billing by default. customer_id: type: string title: customer_id - description: The address's customer id. + description: The ID of the customer the address belongs to. company: type: string title: company @@ -56,11 +56,11 @@ properties: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. city: type: string title: city @@ -69,6 +69,7 @@ properties: type: string title: country_code description: The address's country code. + example: usd province: type: string title: province @@ -83,14 +84,14 @@ properties: description: The address's phone. metadata: type: object - description: The address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The address's updated at. + description: The date the address was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml index ae6cf1559e..e04348e7e3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of customer addresses. x-schemaName: StoreCustomerAddressListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The customer's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer's count. + description: The total number of items. addresses: type: array - description: The customer's addresses. + description: The list of 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 index a665e19eb1..515fa48b09 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerAddressResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The address's details. x-schemaName: StoreCustomerAddressResponse required: - address diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml index c121ca1d70..f64fdf1657 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCustomerResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The customer's details. x-schemaName: StoreCustomerResponse required: - customer diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml index 188ac9c5e5..58ff75075f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's order. +description: The order's details. x-schemaName: StoreOrder required: - id @@ -51,28 +51,29 @@ properties: region_id: type: string title: region_id - description: The order's region id. + description: The ID of the associated region. customer_id: type: string title: customer_id - description: The order's customer id. + description: The ID of the customer that placed the order. sales_channel_id: type: string title: sales_channel_id - description: The order's sales channel id. + description: The ID of the sales channel the order was placed in. email: type: string title: email - description: The order's email. + description: The email of the customer that placed the order. format: email currency_code: type: string title: currency_code description: The order's currency code. + example: usd display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. shipping_address: $ref: ./BaseOrderAddress.yaml billing_address: @@ -123,74 +124,69 @@ properties: - 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. + description: The order's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The order's created at. + description: The date the order was created. updated_at: type: string format: date-time title: updated_at - description: The order's updated at. + description: The date the order was updated. original_item_total: type: number title: original_item_total - description: The order's original item total. + description: The order items' total including taxes, excluding promotions. original_item_subtotal: type: number title: original_item_subtotal - description: The order's original item subtotal. + description: The order items' total excluding taxes, including promotions. original_item_tax_total: type: number title: original_item_tax_total - description: The order's original item tax total. + description: The total taxes applied on the order items, excluding promotions. item_total: type: number title: item_total - description: The order's item total. + description: The order items' total including taxes and promotions. item_subtotal: type: number title: item_subtotal - description: The order's item subtotal. + description: The order items' total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The order's item tax total. + description: The total taxes applied on the order's items, including promotions. original_total: type: number title: original_total - description: The order's original total. + description: The order's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The order's original subtotal. + description: The order's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The order's original tax total. + description: The total taxes of the order excluding promotions. total: type: number title: total - description: The order's total. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The order's subtotal. + description: The order's total excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The order's tax total. + description: The tax totals of the order including promotions. discount_total: type: number title: discount_total @@ -198,7 +194,7 @@ properties: discount_tax_total: type: number title: discount_tax_total - description: The order's discount tax total. + description: The total taxes applied on the discounted amount. gift_card_total: type: number title: gift_card_total @@ -206,28 +202,28 @@ properties: gift_card_tax_total: type: number title: gift_card_tax_total - description: The order's gift card tax total. + description: The total taxes applied on the gift card's amount. shipping_total: type: number title: shipping_total - description: The order's shipping total. + description: The order's shipping total including taxes and promotions. shipping_subtotal: type: number title: shipping_subtotal - description: The order's shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. shipping_tax_total: type: number title: shipping_tax_total - description: The order's shipping tax total. + description: The total taxes of the order's shipping including promotions. original_shipping_total: type: number title: original_shipping_total - description: The order's original shipping total. + description: The order's shipping total including taxes, excluding promotions. original_shipping_subtotal: type: number title: original_shipping_subtotal - description: The order's original shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. original_shipping_tax_total: type: number title: original_shipping_tax_total - description: The order's original shipping tax total. + description: The total taxes of the order's shipping excluding promotions. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml index c0ce372244..ee6f5a725e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The order's details. x-schemaName: StoreOrderResponse required: - order diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml index 94658ceb27..01509e2578 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollection.yaml @@ -2,12 +2,12 @@ type: object description: The payment collection's details. x-schemaName: StorePaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -20,77 +20,41 @@ properties: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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 + type: number + title: amount + description: The total amount to be paid. 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 + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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 + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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 + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -102,14 +66,16 @@ properties: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: >- + The payment provider used to process the collection's payments and + sessions. items: - $ref: ./BasePaymentProvider.yaml + $ref: ./StorePaymentProvider.yaml payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: ./BasePaymentSession.yaml + $ref: ./StorePaymentSession.yaml payments: type: array description: The payment collection's payments. diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml index 3f4dd244b0..dd6dbcee76 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentCollectionResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The payment collection's details. x-schemaName: StorePaymentCollectionResponse required: - payment_collection diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml index 70de4c3efc..81642fa9ec 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentProvider.yaml @@ -1,5 +1,5 @@ type: object -description: The payment provider's payment providers. +description: The payment provider's details x-schemaName: StorePaymentProvider required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/StorePaymentSession.yaml b/www/apps/api-reference/specs/store/components/schemas/StorePaymentSession.yaml new file mode 100644 index 0000000000..7d6195667e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StorePaymentSession.yaml @@ -0,0 +1,61 @@ +type: object +description: The payment session's details. +x-schemaName: StorePaymentSession +properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: >- + The payment session's data, useful for the payment provider processing the + payment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: ./BasePayment.yaml +required: + - id + - amount + - currency_code + - provider_id + - data + - status 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 7062d98f47..044867e21f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -2,15 +2,14 @@ type: object description: The product's details. x-schemaName: StoreProduct required: + - variants + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - - variants - handle - subtitle - is_giftcard @@ -24,9 +23,10 @@ required: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: categories: @@ -56,7 +56,7 @@ properties: type: array description: The product's options. items: - $ref: ./BaseProductOption.yaml + $ref: ./StoreProductOption.yaml description: type: string title: description @@ -67,22 +67,22 @@ properties: description: The product's ID. metadata: type: object - description: The product's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The product's updated at. + description: The date the product was updated. variants: type: array description: The product's variants. items: - $ref: ./BaseProductVariant.yaml + $ref: ./StoreProductVariant.yaml handle: type: string title: handle @@ -94,11 +94,11 @@ properties: is_giftcard: type: boolean title: is_giftcard - description: The product's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The product's thumbnail. + description: The product's thumbnail URL. width: type: number title: width @@ -118,45 +118,45 @@ properties: hs_code: type: string title: hs_code - description: The product's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The product's mid code. + description: The product's MID code. material: type: string title: material description: The product's material. collection: - $ref: ./BaseCollection.yaml + $ref: ./StoreCollection.yaml collection_id: type: string title: collection_id - description: The product's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The product's type id. + description: The ID of the product's type. tags: type: array description: The product's tags. items: - $ref: ./BaseProductTag.yaml + $ref: ./StoreProductTag.yaml images: type: array description: The product's images. items: - $ref: ./BaseProductImage.yaml + $ref: ./StoreProductImage.yaml discountable: type: boolean title: discountable - description: The product's discountable. + description: Whether the product can be discounted. external_id: type: string title: external_id - description: The product's external id. + description: The ID of the product in an external service or system. deleted_at: type: string format: date-time title: deleted_at - description: The product's deleted at. + description: The date the product was deleted. 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 d164aa2e9c..cea963e49c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategory.yaml @@ -1,13 +1,11 @@ type: object -description: The category's categories. +description: The category's details. x-schemaName: StoreProductCategory required: - id - name - description - handle - - is_active - - is_internal - rank - parent_category_id - parent_category @@ -37,14 +35,6 @@ properties: type: string title: handle description: The category's handle. - 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 @@ -52,29 +42,29 @@ properties: parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. parent_category: - $ref: ./BaseProductCategory.yaml + type: object category_children: type: array - description: The category's category children. + description: The category's children. items: - $ref: ./BaseProductCategory.yaml + type: object metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml index 0b9eedfe4f..124035ab92 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The paginated list of product categories. x-schemaName: StoreProductCategoryListResponse required: - limit @@ -10,17 +10,17 @@ properties: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: ./StoreProductCategory.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml index 05dc39f824..7530c17d57 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductCategoryResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product category's details. x-schemaName: StoreProductCategoryResponse required: - product_category diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml new file mode 100644 index 0000000000..632f1a9c1a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductImage.yaml @@ -0,0 +1,33 @@ +type: object +description: The image's details. +x-schemaName: StoreProductImage +required: + - id + - url +properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml new file mode 100644 index 0000000000..40ba71a5d9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductOption.yaml @@ -0,0 +1,44 @@ +type: object +description: The product option's details. +x-schemaName: StoreProductOption +properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The ID of the product this option belongs to. + values: + type: array + description: The option's values. + items: + $ref: ./StoreProductOptionValue.yaml + metadata: + type: object + description: The option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the product option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the product option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the product option was deleted. +required: + - title + - id diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml new file mode 100644 index 0000000000..9a754c37c2 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductOptionValue.yaml @@ -0,0 +1,39 @@ +type: object +description: The product option value's details. +x-schemaName: StoreProductOptionValue +required: + - value + - id +properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml index ac22f2a56f..aab52a7a1d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The product's details. x-schemaName: StoreProductResponse required: - product diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml new file mode 100644 index 0000000000..1e31fdb2fb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductTag.yaml @@ -0,0 +1,35 @@ +type: object +description: The tag's details. +x-schemaName: StoreProductTag +properties: + id: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The date the tag was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tag was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the tag was deleted. + metadata: + type: object + description: The tag's metadata, can hold custom key-value pairs. +required: + - id + - value + - created_at + - updated_at diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml new file mode 100644 index 0000000000..4d7558620a --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml @@ -0,0 +1,140 @@ +type: object +description: The variant's details. +x-schemaName: StoreProductVariant +properties: + options: + type: array + description: The variant's options. + items: + $ref: ./StoreProductOptionValue.yaml + product: + type: object + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. + id: + type: string + title: id + description: The variant's ID. + width: + type: number + title: width + description: The variant's width. + weight: + type: number + title: weight + description: The variant's weight. + height: + type: number + title: height + description: The variant's height. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + 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. + material: + type: string + title: material + description: The variant's material. + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + product_id: + type: string + title: product_id + description: The ID of the product this variant belongs to. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's not in stock. + manage_inventory: + type: boolean + title: manage_inventory + description: >- + Whether Medusa manages the variant's inventory. If disabled, the variant + is always considered in stock. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + inventory_quantity: + type: number + title: inventory_quantity + description: >- + The variant's inventory quantity. This property is only available if you + pass `+variants.inventory_quantity` in the `fields` query parameter. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its siblings. + calculated_price: + $ref: ./BaseCalculatedPriceSet.yaml +required: + - options + - length + - title + - id + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - created_at + - updated_at + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml deleted file mode 100644 index 295b3c1fdd..0000000000 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariantParams.yaml +++ /dev/null @@ -1,76 +0,0 @@ -type: object -description: The product's variants. -x-schemaName: StoreProductVariantParams -properties: - q: - type: string - title: q - description: The variant's q. - id: - oneOf: - - type: string - title: id - description: The variant's ID. - - type: array - description: The variant's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: - type: object - description: The variant's options. - limit: - type: number - title: limit - description: The variant's limit. - offset: - type: number - title: offset - description: The variant's offset. - order: - type: string - title: order - description: The variant's order. - fields: - type: string - title: fields - description: The variant's fields. - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content is the - same type as the expected query parameters. - items: - type: object - title: $or diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml index d07d5098a6..4f92f9c220 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegion.yaml @@ -18,10 +18,13 @@ properties: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: >- + Whether taxes are calculated automatically during checkout for carts that + belong to this region. countries: type: array description: The region's countries. @@ -34,14 +37,14 @@ properties: $ref: ./AdminPaymentProvider.yaml metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml new file mode 100644 index 0000000000..9fd9034074 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml @@ -0,0 +1,32 @@ +type: object +description: The country's details. +x-schemaName: StoreRegionCountry +required: + - id +properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's ISO 2 code. + example: us + iso_3: + type: string + title: iso_3 + description: The country's ISO 3 codel. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml index 4f35c16688..2b3ca272bf 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml @@ -2,14 +2,13 @@ type: object description: The return's details. x-schemaName: StoreReturn required: - - id - - order_id - - order_version - - display_id - items - - received_at + - order_id + - id - created_at + - display_id - canceled_at + - received_at properties: id: type: string @@ -18,7 +17,7 @@ properties: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. status: type: string title: status @@ -26,46 +25,38 @@ properties: exchange_id: type: string title: exchange_id - description: The return's exchange id. + description: The ID of the associated exchange. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. 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. + description: The ID of the associated claim. 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. + description: The return's display ID. refund_amount: type: number title: refund_amount - description: The return's refund amount. + description: The return's refunded amount. items: type: array description: The return's items. items: - $ref: ./BaseReturnItem.yaml + $ref: ./StoreReturnItem.yaml received_at: type: string title: received_at - description: The return's received at. + description: The date the return was received. created_at: type: string format: date-time title: created_at - description: The return's created at. + description: The date the return was created. canceled_at: type: string title: canceled_at - description: The return's canceled at. + description: The date the return was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml new file mode 100644 index 0000000000..878ce1a742 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnItem.yaml @@ -0,0 +1,46 @@ +type: object +description: The return item's details. +x-schemaName: StoreReturnItem +properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + received_quantity: + type: number + title: received_quantity + description: The item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. + reason_id: + type: string + title: reason_id + description: The ID of the item's reason. + note: + type: string + title: note + description: A note with more details on why the item is returned. + item_id: + type: string + title: item_id + description: The ID of the item in the order. + return_id: + type: string + title: return_id + description: The ID of the return this item belongs to. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. +required: + - id + - quantity + - received_quantity + - damaged_quantity + - item_id + - return_id diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml index 0b2be3c0f3..b08051fb32 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReason.yaml @@ -26,14 +26,14 @@ properties: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml index 19edb6a521..b3071e4427 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnReasonResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return reason's details. x-schemaName: StoreReturnReasonResponse required: - return_reason diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml index bac8524459..6dc083e1d5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturnResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The return's details. x-schemaName: StoreReturnResponse required: - return diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml index 13a1160363..c1e75ff242 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOption.yaml @@ -1,5 +1,5 @@ type: object -description: The shipping option's shipping options. +description: The shipping option's details. x-schemaName: StoreShippingOption required: - id @@ -26,30 +26,33 @@ properties: description: The shipping option's name. price_type: type: string - description: The shipping option's price type. + description: >- + The shipping option's price type. If it's `flat`, the price is fixed and + is set in the `prices` property. If it's `calculated`, the price is + calculated on checkout by the associated fulfillment provider. enum: - flat - calculated service_zone_id: type: string title: service_zone_id - description: The shipping option's service zone id. + description: The ID of the service zone the shipping option belongs to. provider_id: type: string title: provider_id - description: The shipping option's provider id. + description: The ID of the fulfillment provider handling this option. provider: $ref: ./BaseFulfillmentProvider.yaml shipping_option_type_id: type: string title: shipping_option_type_id - description: The shipping option's shipping option type id. + description: The ID of the shipping option's type. type: - type: object + $ref: ./StoreShippingOptionType.yaml shipping_profile_id: type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: The ID of the associated shipping profile. amount: type: number title: amount @@ -57,10 +60,13 @@ properties: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping option's is tax inclusive. + description: Whether the amount includes taxes. data: type: object - description: The shipping option's data. + description: The shipping option's data, useful for the provider handling fulfillment. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping option's metadata. + description: The shipping option's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml index 8001c7a8c5..695f2175b1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionListResponse.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The shipping option's details. x-schemaName: StoreShippingOptionListResponse required: - shipping_options diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionType.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionType.yaml new file mode 100644 index 0000000000..d88dffb77d --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreShippingOptionType.yaml @@ -0,0 +1,48 @@ +type: object +description: The shipping option type's details. +x-schemaName: StoreShippingOptionType +required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at +properties: + id: + type: string + title: id + description: The type's ID. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + created_at: + type: string + format: date-time + title: created_at + description: The date the type was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the type was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the type was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml index a6468aab56..844c2958ce 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in the line item. x-schemaName: StoreUpdateCartLineItem required: - quantity @@ -7,7 +7,7 @@ properties: quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. + description: The item's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml index f3f14b1f5e..0eaa5dda8b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml @@ -1,5 +1,5 @@ type: object -description: SUMMARY +description: The details to update in the customer. x-schemaName: StoreUpdateCustomer properties: company_name: diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml index 0338cc6658..22025cb22d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateAddress.yaml @@ -1,5 +1,5 @@ type: object -description: The cart's shipping address. +description: The details to update in the address. x-schemaName: UpdateAddress required: - id @@ -7,51 +7,52 @@ properties: id: type: string title: id - description: The shipping address's ID. + description: The ID of an existing address to update. customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer that this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: usd province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. + description: The address's metadata, can hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml index 0b29d94268..32376f2c2f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/UpdateCartData.yaml @@ -1,36 +1,41 @@ type: object -description: SUMMARY +description: The details to update in a cart. x-schemaName: UpdateCartData properties: region_id: type: string title: region_id - description: The cart's region id. + description: >- + The ID of the associated region. This can affect the prices and currency + code of the cart. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The ID of the customer that the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: >- + The ID of the associated sales channel. Only products available in this + channel can be added to the cart. email: type: string title: email - description: The cart's email. + description: The email of the customer that the cart belongs to. format: email currency_code: type: string title: currency_code description: The cart's currency code. + example: usd shipping_address_id: type: string title: shipping_address_id - description: The cart's shipping address id. + description: The ID of the cart's shipping address. billing_address_id: type: string title: billing_address_id - description: The cart's billing address id. + description: The ID of the cart's billing address. billing_address: oneOf: - $ref: ./CreateAddress.yaml @@ -41,4 +46,4 @@ properties: - $ref: ./UpdateAddress.yaml metadata: type: object - description: The cart's metadata. + description: The cart's metadata, ca hold custom key-value pairs. diff --git a/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml b/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml index 2d20174121..2f04930503 100644 --- a/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/WorkflowExecutionContext.yaml @@ -8,6 +8,30 @@ properties: data: type: object description: The context's data. + properties: + invoke: + type: object + description: The step's invokation details. + required: + - output + additionalProperties: + type: object + properties: + output: + type: object + description: The invokation's details. + required: + - output + - compensateInput + properties: + output: + description: the step's output + compensateInput: + description: the compensation function's input. + payload: + description: the payload of the transaction. + required: + - invoke compensate: type: object description: The context's compensate. @@ -16,4 +40,20 @@ properties: description: The context's errors. items: type: object - description: The error's errors. + description: The error's details. + properties: + error: + type: object + description: The error's details. + action: + type: string + title: action + description: The error's action. + handlerType: + type: string + title: handlerType + description: The error's handler type. + required: + - error + - action + - handlerType diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 14d4c8a9f4..f65143bd95 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -185,12 +185,9 @@ paths: "email": "customer@gmail.com", "password": "supersecret" }' - - lang: Shell + - lang: Bash label: Google Provider source: curl -X POST '{backend_url}/auth/customer/google' - - lang: Shell - label: GitHub Provider - source: curl -X POST '{backend_url}/auth/customer/github' tags: - Auth responses: @@ -240,7 +237,7 @@ paths: - lang: Shell label: Google Provider source: curl -X POST '{backend_url}/auth/customer/google/callback?code=123' - - lang: Shell + - lang: Bash label: GitHub Provider source: curl -X POST '{backend_url}/auth/customer/github/callback?code=123' tags: @@ -372,7 +369,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - success properties: @@ -451,6 +448,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -521,6 +520,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -576,6 +577,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -655,6 +658,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -679,7 +684,7 @@ paths: type: type: string title: type - description: The type of the returned object. + description: The type of the returned object. In this case, the order is returned because the cart was completed successfully. default: order order: $ref: '#/components/schemas/StoreOrder' @@ -693,7 +698,7 @@ paths: type: type: string title: type - description: The type of the returned object. + description: The type of the returned object. In this case, the cart is returned because an error has occurred. default: cart cart: $ref: '#/components/schemas/StoreCart' @@ -764,6 +769,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -842,6 +849,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -918,6 +927,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -1003,6 +1014,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -1081,6 +1094,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -1148,6 +1163,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -1166,7 +1183,7 @@ paths: description: Any additional data relevant for the third-party fulfillment provider to process the shipment. externalDocs: url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter - description: Learn more about the `data` parameter. + description: Learn more about the data parameter. x-codeSamples: - lang: Shell label: cURL @@ -1229,11 +1246,8 @@ paths: 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. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StoreCalculateCartTaxes' + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -1288,6 +1302,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -1296,6 +1312,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -1304,6 +1322,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -2077,7 +2097,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of collections. required: - limit - offset @@ -2086,17 +2106,17 @@ paths: limit: type: number title: limit - description: The collection's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The collection's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The collection's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of collections. required: - collections properties: @@ -2149,6 +2169,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -2199,6 +2221,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -2207,6 +2231,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -2215,6 +2241,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -2321,6 +2349,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -2374,6 +2404,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -2416,6 +2448,9 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createCustomerAccountWorkflow + security: + - cookie_auth: [] + - jwt_token: [] /store/customers/me: get: operationId: GetCustomersMe @@ -2443,6 +2478,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -2499,6 +2536,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -2570,6 +2609,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -2578,6 +2619,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -2586,6 +2629,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -2597,31 +2642,52 @@ paths: - name: city in: query description: Filter by the address's city. - required: true + required: false schema: - type: string - title: city - description: Filter by the address's city. + oneOf: + - type: string + title: city + description: Filter by a city. + - type: array + description: Filter by cities. + items: + type: string + title: city + description: A city. - name: postal_code in: query description: Filter by the address's postal code. - required: true + required: false schema: - type: string - title: postal_code - description: Filter by the address's postal code. + oneOf: + - type: string + title: postal_code + description: Filter by a postal code. + - type: array + description: Filter by postal codes. + items: + type: string + title: postal_code + description: A postal code. - name: country_code in: query description: Filter by the address's country code. - required: true + required: false schema: - type: string - title: country_code - description: Filter by the address's country code. + oneOf: + - type: string + title: country_code + description: Filter by a country code. + - type: array + description: Filter by country codes. + items: + type: string + title: country_code + description: A country code. - name: q in: query description: Search term to filter the address's searchable properties. - required: true + required: false schema: type: string title: q @@ -2683,6 +2749,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -2822,6 +2890,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -2885,6 +2955,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -3015,6 +3087,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -3098,6 +3172,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -3106,6 +3182,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -3114,6 +3192,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -3205,7 +3285,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of orders. required: - limit - offset @@ -3214,17 +3294,17 @@ paths: limit: type: number title: limit - description: The order's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The order's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The order's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of orders. required: - orders properties: @@ -3277,6 +3357,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -3330,6 +3412,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -3403,6 +3487,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -3484,6 +3570,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -3492,6 +3580,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -3500,6 +3590,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -3598,6 +3690,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -3606,6 +3700,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -3614,6 +3710,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -4486,6 +4584,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: include_ancestors_tree in: query description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. @@ -4555,6 +4655,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -4563,6 +4665,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -4571,6 +4675,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -5406,14 +5512,6 @@ paths: externalDocs: url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price description: 'Storefront guide: How to show product variants'' prices with taxes.' - - name: country_code - in: query - description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. - required: false - schema: - type: string - title: country_code - description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. - name: province in: query description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. @@ -5422,14 +5520,6 @@ paths: type: string title: province description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. - - name: cart_id - in: query - description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. - required: false - schema: - type: string - title: cart_id - description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. - name: sales_channel_id in: query required: false @@ -5458,6 +5548,38 @@ paths: type: string title: category_id description: A product category's ID. + - name: currency_code + in: query + description: The currency code to retrieve prices in. + required: false + schema: + type: string + title: currency_code + description: The currency code to retrieve prices in. + - name: variants + in: query + description: Filter the products' variants. + required: false + schema: + type: object + description: Filter the products' variants. + x-schemaName: StoreProductVariantParams + properties: + options: + type: object + description: Filter by the variants' options. + required: + - value + - option_id + properties: + option_id: + type: string + title: option_id + description: The ID of the option to filter by. + value: + type: string + title: value + description: Filter by a value of the option. x-codeSamples: - lang: Shell label: cURL @@ -5546,6 +5668,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: region_id in: query description: The ID of the region the product is being viewed from. This is required if you're retrieving product variant prices with taxes. @@ -5634,6 +5758,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -5642,6 +5768,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -5650,6 +5778,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -5744,7 +5874,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of regions. required: - limit - offset @@ -5753,23 +5883,23 @@ paths: limit: type: number title: limit - description: The region's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The region's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The region's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of regions. required: - regions properties: regions: type: array - description: The region's regions. + description: The list of regions. items: $ref: '#/components/schemas/StoreRegion' '400': @@ -5813,6 +5943,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -5826,7 +5958,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The region's details. required: - region properties: @@ -5924,6 +6056,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -5932,6 +6066,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -5940,6 +6076,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -6033,6 +6171,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -6081,6 +6221,8 @@ paths: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -6089,6 +6231,8 @@ paths: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -6097,6 +6241,8 @@ paths: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - 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 `-`. @@ -6234,17 +6380,69 @@ components: properties: api_key: $ref: '#/components/schemas/AdminApiKey' - AdminArchiveOrder: + AdminApplicationMethod: type: object - description: SUMMARY - x-schemaName: AdminArchiveOrder + description: The application method's details. + x-schemaName: AdminApplicationMethod required: - - order_id + - id properties: - order_id: + promotion: + $ref: '#/components/schemas/AdminPromotion' + target_rules: + type: array + description: The application method's target rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' + buy_rules: + type: array + description: The application method's buy rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' + id: type: string - title: order_id - description: The order's order id. + title: id + description: The application method's ID. + type: + type: string + description: The application method's type. If it's `fixed`, the promotion discounts a fixed amount. If it's `percentage`, the promotion discounts a percentage. + enum: + - fixed + - percentage + target_type: + type: string + description: Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order. + enum: + - items + - shipping_methods + - order + allocation: + type: string + description: How is the promotion amount discounted. `each` means the discounted amount is applied on each applicable item; `across` means the discounted amount is split accross the applicable items. + enum: + - each + - across + value: + type: number + title: value + description: The amount to be discounted. + currency_code: + type: string + title: currency_code + description: The application method's currency code. + example: usd + max_quantity: + type: number + title: max_quantity + description: The max quantity allowed in the cart for the associated promotion to be applied. + buy_rules_min_quantity: + type: number + title: buy_rules_min_quantity + description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. + apply_to_quantity: + type: number + title: apply_to_quantity + description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`. AdminBatchProductRequest: type: object description: The products to create, update, or delete. @@ -6465,44 +6663,18 @@ components: description: The claim's details. x-schemaName: AdminClaim required: - - order_id - - claim_items - - additional_items - - currency_code + - order + - return - id - - region_id - - customer_id - - sales_channel_id - - email - - shipping_methods - - payment_status - - fulfillment_status - - summary - - metadata + - type + - order_id + - display_id + - order_version - 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 + - canceled_at + - additional_items + - claim_items properties: id: type: string @@ -6523,7 +6695,7 @@ components: items: $ref: '#/components/schemas/BaseClaimItem' return: - $ref: '#/components/schemas/Return' + $ref: '#/components/schemas/AdminReturn' return_id: type: string title: return_id @@ -6536,76 +6708,15 @@ components: type: number title: refund_amount description: The amount to be refunded. - currency_code: - type: string - title: currency_code - description: The claim's currency code. - region_id: - type: string - title: region_id - description: The ID of the region associated with the claim. - customer_id: - type: string - title: customer_id - description: The ID of the customer associated with the claim's order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the claim's order is created in. - email: - type: string - title: email - description: The email associated with the claim's order. - format: email display_id: type: number 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 - description: The claim's payment status. - 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 - description: The claim's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered + $ref: '#/components/schemas/AdminOrderShippingMethod' transactions: type: array description: The claim's transactions. @@ -6614,8 +6725,6 @@ components: description: Learn more about transactions of orders and associated models. items: $ref: '#/components/schemas/BaseOrderTransaction' - summary: - $ref: '#/components/schemas/BaseOrderSummary' metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -6629,94 +6738,32 @@ components: format: date-time title: updated_at description: The claim's update date. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the associated order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the associated order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The tax total of the original items in the associated order. - item_total: - type: number - title: item_total - description: The total of the claim's items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the claim's items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the claim's items. - original_total: - type: number - title: original_total - description: The associated order's original total. - original_subtotal: - type: number - title: original_subtotal - description: The associated order's original subtotal. - original_tax_total: - type: number - title: original_tax_total - description: The associated order's original tax total. - total: - type: number - title: total - description: The associated order'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 associated order's original shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The associated order's original shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The associated order's original shipping tax total. + order: + $ref: '#/components/schemas/AdminOrder' + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order_version: + type: string + title: order_version + description: The version of the order when the claim is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. AdminClaimDeleteResponse: type: object description: The details of the deleted claim. @@ -6787,7 +6834,7 @@ components: - claim properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimRequestResponse: @@ -6802,7 +6849,7 @@ components: return: $ref: '#/components/schemas/AdminReturn' order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' claim: $ref: '#/components/schemas/AdminClaim' AdminClaimResponse: @@ -6823,7 +6870,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminCollection: @@ -6950,68 +6997,6 @@ components: enum: - publishable - secret - AdminCreateApplicationMethod: - type: object - description: The application method's details. - x-schemaName: AdminCreateApplicationMethod - required: - - value - - type - - target_type - properties: - description: - type: string - title: description - description: The application method's description. - value: - type: number - title: value - description: The discounted amount applied by the associated promotion based on the `type`. - currency_code: - type: string - title: currency_code - description: The application method's currency code. - max_quantity: - type: number - title: max_quantity - description: The max quantity allowed in the cart for the associated promotion to be applied. - type: - type: string - description: The type of the application method indicating how the associated promotion is applied. - enum: - - fixed - - percentage - target_type: - type: string - description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order. - enum: - - items - - shipping_methods - - order - allocation: - type: string - description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart. - enum: - - each - - across - target_rules: - type: array - description: The application method's target rules. - items: - $ref: '#/components/schemas/AdminCreatePromotionRule' - buy_rules: - type: array - description: The application method's buy rules. - items: - $ref: '#/components/schemas/AdminCreatePromotionRule' - apply_to_quantity: - type: number - title: apply_to_quantity - description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`. - buy_rules_min_quantity: - type: number - title: buy_rules_min_quantity - description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. AdminCreateCollection: type: object description: the product collection's details. @@ -7049,15 +7034,14 @@ components: description: The filfillment's details. x-schemaName: AdminCreateFulfillment required: + - data + - order_id + - metadata + - items - location_id - provider_id - delivery_address - - items - labels - - order - - order_id - - data - - metadata properties: location_id: type: string @@ -7122,8 +7106,8 @@ components: description: An item to fulfill. required: - title - - sku - quantity + - sku - barcode properties: title: @@ -7321,8 +7305,8 @@ components: description: A price's details. required: - currency_code - - amount - variant_id + - amount properties: currency_code: type: string @@ -7587,6 +7571,20 @@ components: metadata: type: object description: The product tag's metadata, used to store custom key-value pairs. + AdminCreateProductType: + type: object + description: The details of the product type to create. + x-schemaName: AdminCreateProductType + required: + - value + properties: + metadata: + type: object + description: The product's metadata, used to store custom key-value pairs. + value: + type: string + title: value + description: The product type's value. AdminCreateProductVariant: type: object description: The product variant's details. @@ -7672,6 +7670,26 @@ components: description: The variant's options, where the key is an option's name, and the value is the option's value. example: Color: Black + inventory_items: + type: array + description: The variant's inventory items to create. + items: + $ref: '#/components/schemas/AdminCreateProductVariantInventoryKit' + AdminCreateProductVariantInventoryKit: + type: object + description: The details of a variant's inventory item. + x-schemaName: AdminCreateProductVariantInventoryKit + required: + - inventory_item_id + properties: + inventory_item_id: + type: string + title: inventory_item_id + description: The inventory item's ID. + required_quantity: + type: number + title: required_quantity + description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. AdminCreateProductVariantPrice: type: object description: The details of a variant's price. @@ -7701,6 +7719,13 @@ components: description: The price's rules. example: region_id: reg_123 + properties: + region_id: + type: string + title: region_id + description: The ID of a region. + required: + - region_id AdminCreatePromotionRule: type: object description: The promotion rule's details. @@ -7714,13 +7739,13 @@ components: type: string description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: + - gte + - lte - gt - lt - eq - ne - in - - lte - - gte description: type: string title: description @@ -7729,7 +7754,7 @@ components: type: string title: attribute description: The attribute to compare against when checking whether a promotion can be applied on a cart. - example: item.product.id + example: items.product.id values: oneOf: - type: string @@ -7834,6 +7859,33 @@ components: metadata: type: object description: The reservation's metadata, used to store custom key-value pairs. + AdminCreateReturnReason: + type: object + description: The details of the return reason to create. + x-schemaName: AdminCreateReturnReason + required: + - value + - label + properties: + 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. + parent_return_reason_id: + type: string + title: parent_return_reason_id + description: The ID of the parent return reason. + metadata: + type: object + description: The return reason's metadata, can hold custom key-value pairs. AdminCreateSalesChannel: type: object description: The sales channel's details. @@ -7891,85 +7943,22 @@ components: description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - name - - service_zone_id - - shipping_profile_id - - price_type - - provider_id - - type - - prices + - label + - description + - code properties: - name: + label: type: string - title: name - description: The shipping option's name. - service_zone_id: + title: label + description: The type's label. + description: type: string - title: service_zone_id - description: The ID of the service zone this shipping option belongs to. - shipping_profile_id: + title: description + description: The type's description. + code: type: string - title: shipping_profile_id - description: The ID of the shipping profile this shipping option belongs to. - data: - type: object - description: Any data necessary for fulfillment providers to handle shipping methods and fulfillments of this shipping option. - externalDocs: - url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property - description: Learn more about the data property. - price_type: - type: string - description: | - The shipping option price's type. If `flat`, it means the option has a fixed price set in the `prices` property. `calculated` means that the shipping option's price is calculated during checkout. - enum: - - flat - - calculated - provider_id: - type: string - title: provider_id - description: The ID of the fulfillment provider used to handle this shipping option and its associated methods and fulfillments. - type: - type: object - prices: - type: array - description: The shipping option's prices. If `price_type` is `calculated`, pass an empty array for this property. - items: - oneOf: - - type: object - description: The price for a currency code. - x-schemaName: AdminCreateShippingOptionPriceWithCurrency - required: - - currency_code - - amount - properties: - currency_code: - type: string - title: currency_code - description: The price's currency code. - amount: - type: number - title: amount - description: The price's amount. - - type: object - description: The price in a region. - x-schemaName: AdminCreateShippingOptionPriceWithRegion - required: - - region_id - - amount - properties: - region_id: - type: string - title: region_id - description: The ID of the region this price is used in. - amount: - type: number - title: amount - description: The price's amount. - rules: - type: array - description: The shipping option's rules. - items: - $ref: '#/components/schemas/AdminCreateShippingOptionRule' + title: code + description: The type's code. AdminCreateShippingOptionRule: type: object description: The details of the shipping option rule. @@ -8055,6 +8044,7 @@ components: required: - name - tax_region_id + - code properties: name: type: string @@ -8134,6 +8124,7 @@ components: type: object description: The tax region's default tax rate. required: + - code - name properties: rate: @@ -8166,8 +8157,8 @@ components: description: The details of the variant-inventory item association. x-schemaName: AdminCreateVariantInventoryItem required: - - required_quantity - inventory_item_id + - required_quantity properties: required_quantity: type: number @@ -8225,7 +8216,6 @@ components: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at @@ -8314,6 +8304,7 @@ components: x-schemaName: AdminCustomer required: - has_account + - addresses - id - email - default_billing_address_id @@ -8321,7 +8312,6 @@ components: - company_name - first_name - last_name - - addresses properties: id: type: string @@ -8365,7 +8355,7 @@ components: type: array description: The customer's addresses. items: - $ref: '#/components/schemas/BaseCustomerAddress' + $ref: '#/components/schemas/AdminCustomerAddress' phone: type: string title: phone @@ -8504,9 +8494,9 @@ components: description: The customer group's details. x-schemaName: AdminCustomerGroup required: + - customers - id - name - - customers - metadata - created_at - updated_at @@ -8523,7 +8513,7 @@ components: type: array description: The customer group's customers. items: - $ref: '#/components/schemas/BaseCustomer' + type: object metadata: type: object description: The customer group's metadata, used to store custom key-value pairs. @@ -8539,7 +8529,7 @@ components: description: The customer group's update date. AdminCustomerGroupResponse: type: object - description: SUMMARY + description: The customer group's details. x-schemaName: AdminCustomerGroupResponse required: - customer_group @@ -9102,7 +9092,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). AdminCustomerResponse: type: object - description: SUMMARY + description: The customer's details. x-schemaName: AdminCustomerResponse required: - customer @@ -9145,44 +9135,14 @@ components: 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 + - order_id - 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 + - canceled_at + - deleted_at + - additional_items + - return_items properties: order_id: type: string @@ -9207,88 +9167,24 @@ components: title: difference_due description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. return: - description: the return associated with the exchange. $ref: '#/components/schemas/AdminReturn' return_id: type: string title: return_id description: The ID of the associated exchange. - 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 ID of the associated order's region. - customer_id: - type: string - title: customer_id - description: The ID of the customer that placed the order. - sales_channel_id: - type: string - title: sales_channel_id - description: The ID of the sales channel the associated order belongs to. - email: - type: string - title: email - description: The email used when placing the order. - format: email display_id: - type: number + type: string title: display_id description: The exchange's display ID. - shipping_address: - description: The shipping address to send new items to. - $ref: '#/components/schemas/BaseOrderAddress' - billing_address: - description: The customer's billing address. - $ref: '#/components/schemas/BaseOrderAddress' shipping_methods: type: array description: The shipping methods used to send the new (outbound) items. items: $ref: '#/components/schemas/BaseOrderShippingMethod' - payment_collections: - type: array - description: The exchange's payment collections. - items: - $ref: '#/components/schemas/BasePaymentCollection' - payment_status: - type: string - description: The exchange's payment status. - enum: - - canceled - - not_paid - - awaiting - - authorized - - partially_authorized - - captured - - partially_captured - - partially_refunded - - refunded - - requires_action - fulfillments: - type: array - description: The exchange's fulfillments of new (outbound) items. - items: - $ref: '#/components/schemas/BaseOrderFulfillment' - fulfillment_status: - type: string - description: The exchange's fulfillment status. - enum: - - canceled - - not_fulfilled - - partially_fulfilled - - fulfilled - - partially_shipped - - shipped - - partially_delivered - - delivered transactions: type: array description: The exchange's transactions. @@ -9296,9 +9192,6 @@ components: url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions items: $ref: '#/components/schemas/BaseOrderTransaction' - summary: - description: The totals summary of the exchange. - $ref: '#/components/schemas/BaseOrderSummary' metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -9312,94 +9205,30 @@ components: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: - type: number - title: original_item_total - description: The total of the original items in the order. - original_item_subtotal: - type: number - title: original_item_subtotal - description: The subtotal of the original items in the order. - original_item_tax_total: - type: number - title: original_item_tax_total - description: The total tax of the original items in the order. - item_total: - type: number - title: item_total - description: The total of the exchange's new items. - item_subtotal: - type: number - title: item_subtotal - description: The subtotal of the exchange's new items. - item_tax_total: - type: number - title: item_tax_total - description: The tax total of the exchange's new items. - original_total: - type: number - title: original_total - description: The total of the order. - original_subtotal: - type: number - title: original_subtotal - description: The subtotal of the order. - original_tax_total: - type: number - title: original_tax_total - description: The tax total of the order. - total: - type: number - title: total - description: The total of the exchange. - subtotal: - type: number - title: subtotal - description: The subtotal of the exchange. - tax_total: - type: number - title: tax_total - description: The tax total of the exchange. - discount_total: - type: number - title: discount_total - description: The discount total of the exchange. - discount_tax_total: - type: number - title: discount_tax_total - description: The total taxes on discount of the exchange. - gift_card_total: - type: number - title: gift_card_total - description: The gift cards total of the exchange. - gift_card_tax_total: - type: number - title: gift_card_tax_total - description: The total taxes on the gift card of the exchange. - 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 order's shipping total. - original_shipping_subtotal: - type: number - title: original_shipping_subtotal - description: The order's shipping subtotal. - original_shipping_tax_total: - type: number - title: original_shipping_tax_total - description: The order's shipping tax total. + order_version: + type: string + title: order_version + description: The version of the order once the exchange is applied. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + order: + $ref: '#/components/schemas/AdminOrder' + allow_backorder: + type: boolean + title: allow_backorder + description: Whether variants that are out-of-stock can still be added as additional or outbound items. AdminExchangeDeleteResponse: type: object description: The details of deleting an exchange. @@ -9444,7 +9273,7 @@ components: - exchange properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeRequestResponse: @@ -9457,11 +9286,9 @@ components: - exchange properties: return: - description: The associated return's details. $ref: '#/components/schemas/AdminReturn' order_preview: - description: A preview of the order once the exchange is applied. - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' exchange: $ref: '#/components/schemas/AdminExchange' AdminExchangeResponse: @@ -9482,7 +9309,7 @@ components: - return properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' return: $ref: '#/components/schemas/AdminReturn' AdminExportProductResponse: @@ -9573,10 +9400,8 @@ components: title: shipping_option_id description: The ID of the shipping option this fulfillment is created for. provider: - description: The details of the fulfillment provider using to handle this fulfillment. $ref: '#/components/schemas/AdminFulfillmentProvider' delivery_address: - description: The address to deliver the item to. $ref: '#/components/schemas/AdminFulfillmentAddress' items: type: array @@ -9830,8 +9655,20 @@ components: description: The date the label was deleted. AdminFulfillmentProvider: type: object - description: The shipping option's provider. + description: The fulfillment provider's details. x-schemaName: AdminFulfillmentProvider + 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. AdminFulfillmentProviderListResponse: type: object description: The paginated list of fulfillment providers. @@ -9870,7 +9707,7 @@ components: $ref: '#/components/schemas/AdminFulfillment' AdminFulfillmentSet: type: object - description: The fulfillment set's parent. + description: The service zone's fulfillment set. x-schemaName: AdminFulfillmentSet required: - id @@ -9885,37 +9722,37 @@ components: id: type: string title: id - description: The parent's ID. + description: The fulfillment set's ID. name: type: string title: name - description: The parent's name. + description: The fulfillment set's name. type: type: string title: type - description: The parent's type. + description: The fulfillment set's type. location: $ref: '#/components/schemas/AdminStockLocation' service_zones: type: array - description: The parent's service zones. + description: The fulfillment set's service zones. items: $ref: '#/components/schemas/AdminServiceZone' created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The fulfillment set's created at. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The fulfillment set's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The fulfillment set's deleted at. AdminFulfillmentSetDeleteResponse: type: object description: The deletion details. @@ -9940,7 +9777,7 @@ components: description: Whether the fulfillment set was deleted. AdminFulfillmentSetResponse: type: object - description: SUMMARY + description: The fulfillment set's details. x-schemaName: AdminFulfillmentSetResponse required: - fulfillment_set @@ -9949,7 +9786,7 @@ components: $ref: '#/components/schemas/AdminFulfillmentSet' AdminGeoZone: type: object - description: The geo zone's details. + description: The geo zone's geo zones. x-schemaName: AdminGeoZone required: - id @@ -9993,17 +9830,17 @@ components: type: string format: date-time title: created_at - description: The date the geo zone was created. + description: The geo zone's created at. updated_at: type: string format: date-time title: updated_at - description: The date the geo zone was update. + description: The geo zone's updated at. deleted_at: type: string format: date-time title: deleted_at - description: The date the geo zone was deleted. + description: The geo zone's deleted at. AdminImportProductRequest: type: object description: The import's details. @@ -10012,7 +9849,12 @@ components: - file properties: file: - $ref: '#/components/schemas/File' + type: object + description: A File to upload. + externalDocs: + url: https://developer.mozilla.org/en-US/docs/Web/API/File + description: Learn more about the File API + title: file AdminImportProductResponse: type: object description: The import process's details. @@ -10042,7 +9884,7 @@ components: description: The number of products that will be updated by this import. AdminInventoryItem: type: object - description: The inventory item's details. + description: The reservation's inventory item. x-schemaName: AdminInventoryItem required: - id @@ -10055,7 +9897,7 @@ components: sku: type: string title: sku - description: The inventory item's SKU. + description: The inventory item's sku. origin_country: type: string title: origin_country @@ -10063,15 +9905,15 @@ components: hs_code: type: string title: hs_code - description: The inventory item's HS code. + description: The inventory item's hs code. requires_shipping: type: boolean title: requires_shipping - description: Whether the inventory item requires shipping. + description: The inventory item's requires shipping. mid_code: type: string title: mid_code - description: The inventory item's MID code. + description: The inventory item's mid code. material: type: string title: material @@ -10103,13 +9945,13 @@ components: thumbnail: type: string title: thumbnail - description: The URL of the inventory item's thumbnail. + description: The inventory item's thumbnail. metadata: type: object - description: The inventory item's metadata, can hold custom key-value pairs. + description: The inventory item's metadata. location_levels: type: array - description: The inventory item's associated inventory levels. + description: The inventory item's location levels. items: $ref: '#/components/schemas/AdminInventoryLevel' AdminInventoryItemResponse: @@ -10123,7 +9965,7 @@ components: $ref: '#/components/schemas/AdminInventoryItem' AdminInventoryLevel: type: object - description: The inventory level's details. + description: The location level's location levels. x-schemaName: AdminInventoryLevel required: - id @@ -10133,62 +9975,59 @@ components: - inventory_item_id - location_id - stocked_quantity - - raw_stocked_quantity - reserved_quantity - - raw_reserved_quantity - incoming_quantity - - raw_incoming_quantity - metadata - available_quantity properties: id: type: string title: id - description: The inventory level's ID. + description: The location level's ID. + created_at: + type: string + format: date-time + title: created_at + description: The location level's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The location level's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The location level's deleted at. inventory_item_id: type: string title: inventory_item_id - description: The ID of the inventory item this level belongs to. + description: The location level's inventory item id. location_id: type: string title: location_id - description: The ID of the stock location this level belongs to. + description: The location level's location id. stocked_quantity: type: number title: stocked_quantity - description: The quantity of the associated inventory item stocked in the associated stock location. + description: The location level's stocked quantity. reserved_quantity: type: number title: reserved_quantity - description: The reserved quantity of the associated inventory item stocked in the associated stock location. + description: The location level's reserved quantity. incoming_quantity: type: number title: incoming_quantity - description: The incoming quantity of the associated inventory item stocked in the associated stock location. + description: The location level's incoming quantity. metadata: type: object - description: The location level's metadata, can hold custom key-value pairs. + description: The location level's metadata. inventory_item: type: object available_quantity: type: number title: available_quantity - description: The quantity available for order of the associated inventory item in the associated stock location. - created_at: - type: string - format: date-time - title: created_at - description: The date the inventory level was created. - updated_at: - type: string - format: date-time - title: updated_at - description: The date the inventory level was updated. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The date the inventory level was deleted. + description: The location level's available quantity. AdminInvite: type: object description: The invite's details. @@ -10364,21 +10203,20 @@ components: x-schemaName: AdminOrder required: - payment_collections + - items + - shipping_methods + - currency_code - id + - created_at + - updated_at + - email - 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 @@ -10411,7 +10249,7 @@ components: type: array description: The order's fulfillments. items: - $ref: '#/components/schemas/BaseOrderFulfillment' + $ref: '#/components/schemas/AdminOrderFulfillment' sales_channel: $ref: '#/components/schemas/AdminSalesChannel' customer: @@ -10457,12 +10295,12 @@ components: type: array description: The order's items. items: - $ref: '#/components/schemas/BaseOrderLineItem' + $ref: '#/components/schemas/AdminOrderLineItem' shipping_methods: type: array description: The order's shipping methods. items: - $ref: '#/components/schemas/BaseOrderShippingMethod' + $ref: '#/components/schemas/AdminOrderShippingMethod' payment_status: type: string description: The order's payment status. @@ -10671,6 +10509,252 @@ components: format: date-time title: updated_at description: The date the address was updated. + AdminOrderChange: + type: object + description: The order change's details. + x-schemaName: AdminOrderChange + required: + - order + - claim + - return_order + - exchange + - actions + - status + - order_id + - metadata + - id + - created_at + - updated_at + - version + - canceled_at + - return_id + - exchange_id + - claim_id + - requested_by + - requested_at + - confirmed_by + - confirmed_at + - declined_by + - declined_reason + - declined_at + - canceled_by + properties: + id: + type: string + title: id + description: The order change's ID. + version: + type: number + title: version + description: The order change's version. This will be the order's version when the change is applied. + change_type: + type: string + description: The order change's type. + enum: + - return + - exchange + - claim + - edit + order_id: + type: string + title: order_id + description: The ID of the order this change applies on. + return_id: + type: string + title: return_id + description: The ID of the associated return. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + return_order: + $ref: '#/components/schemas/AdminReturn' + exchange: + $ref: '#/components/schemas/AdminExchange' + claim: + $ref: '#/components/schemas/AdminClaim' + actions: + type: array + description: The order change's actions. + items: + $ref: '#/components/schemas/AdminOrderChangeAction' + status: + type: string + description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined + requested_by: + type: string + title: requested_by + description: The ID of the user that requested the change. + requested_at: + type: string + title: requested_at + description: The date the order change was requested. + format: date-time + confirmed_by: + type: string + title: confirmed_by + description: The ID of the user that confirmed the order change. + confirmed_at: + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time + declined_by: + type: string + title: declined_by + description: The ID of the user that declined the order change. + declined_reason: + type: string + title: declined_reason + description: The reason the order change was declined. + metadata: + type: object + description: The order change's metadata, can hold custom key-value pairs. + declined_at: + type: string + title: declined_at + description: The date the order change was declined. + format: date-time + canceled_by: + type: string + title: canceled_by + description: The ID of the user that canceled the order change. + canceled_at: + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time + created_at: + type: string + format: date-time + title: created_at + description: The date the order change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change was updated. + AdminOrderChangeAction: + type: object + description: The order change action's details. + x-schemaName: AdminOrderChangeAction + required: + - order_change + - order + - order_id + - internal_note + - id + - created_at + - updated_at + - return_id + - exchange_id + - claim_id + - order_change_id + - reference + - reference_id + - action + - details + properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + type: string + title: order + description: The order change's order. + externalDocs: + url: '#pagination' + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. AdminOrderChangesResponse: type: object description: The details of an order's changes. @@ -10682,7 +10766,7 @@ components: type: array description: An order's changes. items: - $ref: '#/components/schemas/BaseOrderChange' + $ref: '#/components/schemas/AdminOrderChange' AdminOrderEditPreviewResponse: type: object description: The preview of an order edit. @@ -10691,7 +10775,7 @@ components: - order_preview properties: order_preview: - $ref: '#/components/schemas/OrderPreview' + $ref: '#/components/schemas/AdminOrderPreview' AdminOrderEditResponse: type: object description: An order edit's details. @@ -10700,7 +10784,298 @@ components: - order_change properties: order_change: - $ref: '#/components/schemas/OrderChange' + $ref: '#/components/schemas/AdminOrderChange' + AdminOrderFulfillment: + type: object + description: The fulfillment's details. + x-schemaName: AdminOrderFulfillment + required: + - id + - location_id + - packed_at + - shipped_at + - delivered_at + - canceled_at + - requires_shipping + - 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 ID of the location the items are fulfilled from. + packed_at: + type: string + title: packed_at + description: The date the items were packed. + format: date-time + shipped_at: + type: string + title: shipped_at + description: The date the items were shipped. + format: date-time + delivered_at: + type: string + title: delivered_at + description: The date the items were delivered. + format: date-time + canceled_at: + type: string + title: canceled_at + description: The date the items were canceled. + format: date-time + data: + type: object + description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider used to handle the fulfillment. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + metadata: + type: object + description: The fulfillment's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the fulfillment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the fulfillment was updated. + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the fulfillment requires shipping. + AdminOrderLineItem: + type: object + description: The item's details. + x-schemaName: AdminOrderLineItem + required: + - title + - metadata + - id + - subtitle + - thumbnail + - created_at + - updated_at + - item_total + - item_subtotal + - item_tax_total + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - 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 + - 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 URL of the item's thumbnail. + variant: + $ref: '#/components/schemas/AdminProductVariant' + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: '#/components/schemas/AdminProduct' + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the collection the item's product belongs to. + 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 values of the item variant's options. + example: + Color: Blue + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + 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: + type: object + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item, excluding promotions. + item_total: + type: number + title: item_total + description: The total taxes of the item, including promotions. + item_subtotal: + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of the item, including promotions. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the item including promotions. + discount_total: + type: number + title: discount_total + description: The total discount amount of the item. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total refundable amount of the item's total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total refundable amount of the item's total for a single quantity. AdminOrderPreview: type: object description: A preview of an order if a change, such as exchange, return, edit, or claim is applied on it. @@ -10709,19 +11084,18 @@ components: - return_requested_total - order_change - currency_code - - version - id + - created_at + - updated_at + - email + - 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 @@ -10750,7 +11124,7 @@ components: title: return_requested_total description: The total of the requested return. order_change: - $ref: '#/components/schemas/BaseOrderChange' + $ref: '#/components/schemas/AdminOrderChange' items: type: array description: The order's items. @@ -10822,7 +11196,7 @@ components: title: variant_id description: The ID of the associated variant. product: - $ref: '#/components/schemas/BaseProduct' + $ref: '#/components/schemas/AdminProduct' product_id: type: string title: product_id @@ -10880,8 +11254,8 @@ components: description: Whether the item's price includes taxes. compare_at_unit_price: type: number - title: The original price of the item before a promotion or sale. - description: The + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -11195,7 +11569,7 @@ components: type: array description: The order's fulfillments. items: - $ref: '#/components/schemas/BaseOrderFulfillment' + $ref: '#/components/schemas/AdminOrderFulfillment' fulfillment_status: type: string description: The order's fulfillment status. @@ -11350,6 +11724,120 @@ components: $ref: '#/components/schemas/Order' return: $ref: '#/components/schemas/AdminReturn' + AdminOrderShippingMethod: + type: object + description: The shipping method's details. + x-schemaName: AdminOrderShippingMethod + 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 ID of the order the shipping method belongs to. + 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: Whether the shipping method's amount includes applied taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: The shipping method's data, useful for fulfillment provider handling its fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The shipping method's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The total discounts applied on the shipping method. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + detail: + $ref: '#/components/schemas/BaseOrderShippingDetail' AdminPayment: type: object description: The payment's details. @@ -11438,22 +11926,22 @@ components: type: array description: The details of payment refunds. items: - $ref: '#/components/schemas/BaseRefund' + $ref: '#/components/schemas/AdminRefund' payment_collection: - $ref: '#/components/schemas/BasePaymentCollection' + type: object payment_session: - $ref: '#/components/schemas/BasePaymentSession' + $ref: '#/components/schemas/AdminPaymentSession' AdminPaymentCollection: type: object description: The payment collection's details. x-schemaName: AdminPaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -11514,17 +12002,17 @@ components: type: array description: The payment provider used to process the collection's payments and sessions. items: - $ref: '#/components/schemas/BasePaymentProvider' + $ref: '#/components/schemas/AdminPaymentProvider' payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: '#/components/schemas/BasePaymentSession' + $ref: '#/components/schemas/AdminPaymentSession' payments: type: array description: The payment collection's payments. items: - $ref: '#/components/schemas/BasePayment' + $ref: '#/components/schemas/AdminPayment' AdminPaymentCollectionResponse: type: object description: The payment collection's details. @@ -11559,6 +12047,65 @@ components: properties: payment: $ref: '#/components/schemas/AdminPayment' + AdminPaymentSession: + type: object + description: The payment session's details. + x-schemaName: AdminPaymentSession + properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: The payment session's data, useful for the payment provider processing the payment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: '#/components/schemas/BasePayment' + required: + - id + - amount + - currency_code + - provider_id + - data + - status AdminPostCancelClaimReqSchema: type: object description: The details of canceling a claim. @@ -12702,15 +13249,15 @@ components: description: The product's details. x-schemaName: AdminProduct required: + - variants - type + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - handle - subtitle - is_giftcard @@ -12724,9 +13271,10 @@ components: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: collection: @@ -12773,7 +13321,7 @@ components: type: array description: The product's options. items: - $ref: '#/components/schemas/BaseProductOption' + $ref: '#/components/schemas/AdminProductOption' description: type: string title: description @@ -12851,7 +13399,7 @@ components: type: array description: The product's images. items: - $ref: '#/components/schemas/BaseProductImage' + $ref: '#/components/schemas/AdminProductImage' discountable: type: boolean title: discountable @@ -13026,9 +13574,43 @@ components: type: boolean title: deleted description: Whether the product was deleted. + AdminProductImage: + type: object + description: The image's details. + x-schemaName: AdminProductImage + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. + required: + - id + - url AdminProductOption: type: object - description: The product's product option. + description: The product option's details. x-schemaName: AdminProductOption required: - id @@ -13043,37 +13625,37 @@ components: title: title description: The product option's title. product: - $ref: '#/components/schemas/BaseProduct' + type: object product_id: type: string title: product_id - description: The product option's product id. + description: The ID of the product this option belongs to. values: type: array description: The product option's values. items: - $ref: '#/components/schemas/BaseProductOptionValue' + type: object metadata: type: object - description: The product option's metadata. + description: The product option's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The product option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The product option's deleted at. + description: The date the product option was deleted. AdminProductOptionDeleteResponse: type: object - description: SUMMARY + description: The details of the product option deletion. x-schemaName: AdminProductOptionDeleteResponse required: - id @@ -13083,29 +13665,70 @@ components: id: type: string title: id - description: The product's ID. + description: The product option's ID. object: type: string title: object description: The name of the deleted object. + default: product_option deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product option was deleted. parent: $ref: '#/components/schemas/AdminProduct' AdminProductOptionResponse: type: object - description: SUMMARY + description: The product option's details. x-schemaName: AdminProductOptionResponse required: - product_option properties: product_option: $ref: '#/components/schemas/AdminProductOption' + AdminProductOptionValue: + type: object + description: The product option value's details. + x-schemaName: AdminProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + $ref: '#/components/schemas/AdminProductOption' + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. AdminProductResponse: type: object - description: SUMMARY + description: The product's details. x-schemaName: AdminProductResponse required: - product @@ -13114,7 +13737,7 @@ components: $ref: '#/components/schemas/AdminProduct' AdminProductTag: type: object - description: The tag's tags. + description: The product tag's details. x-schemaName: AdminProductTag required: - id @@ -13134,23 +13757,23 @@ components: type: string format: date-time title: created_at - description: The tag's created at. + description: The date the tag was created. updated_at: type: string format: date-time title: updated_at - description: The tag's updated at. + description: The date the tag was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tag's deleted at. + description: The date the tag was deleted. metadata: type: object - description: The tag's metadata. + description: The tag's metadata, can hold custom key-value pairs. AdminProductTagDeleteResponse: type: object - description: SUMMARY + description: The details of the product tag deletion. x-schemaName: AdminProductTagDeleteResponse required: - id @@ -13169,10 +13792,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Product Tag was deleted. + description: Whether the product tag was deleted. AdminProductTagListResponse: type: object - description: SUMMARY + description: The paginated list of product tags. x-schemaName: AdminProductTagListResponse required: - limit @@ -13183,23 +13806,23 @@ components: limit: type: number title: limit - description: The product tag's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product tag's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product tag's count. + description: The total number of items. product_tags: type: array - description: The product tag's product tags. + description: The list of product tags. items: $ref: '#/components/schemas/AdminProductTag' AdminProductTagResponse: type: object - description: SUMMARY + description: The product tag's details. x-schemaName: AdminProductTagResponse required: - product_tag @@ -13208,7 +13831,7 @@ components: $ref: '#/components/schemas/AdminProductTag' AdminProductType: type: object - description: The parent's type. + description: The product type's details. x-schemaName: AdminProductType required: - id @@ -13228,23 +13851,23 @@ components: type: string format: date-time title: created_at - description: The type's created at. + description: The date the type was created. updated_at: type: string format: date-time title: updated_at - description: The type's updated at. + description: The date the type was updated. deleted_at: type: string format: date-time title: deleted_at - description: The type's deleted at. + description: The date the type was deleted. metadata: type: object - description: The type's metadata. + description: The type's metadata, can hold custom key-value pairs. AdminProductTypeDeleteResponse: type: object - description: SUMMARY + description: The details of the product type deletion. x-schemaName: AdminProductTypeDeleteResponse required: - id @@ -13263,10 +13886,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Product Type was deleted. + description: Whether the product type was deleted. AdminProductTypeListResponse: type: object - description: SUMMARY + description: The paginated list of product types. x-schemaName: AdminProductTypeListResponse required: - limit @@ -13277,23 +13900,23 @@ components: limit: type: number title: limit - description: The product type's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product type's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product type's count. + description: The total number of items. product_types: type: array - description: The product type's product types. + description: The list of product types. items: $ref: '#/components/schemas/AdminProductType' AdminProductTypeResponse: type: object - description: SUMMARY + description: The product type's details. x-schemaName: AdminProductTypeResponse required: - product_type @@ -13302,10 +13925,11 @@ components: $ref: '#/components/schemas/AdminProductType' AdminProductVariant: type: object - description: The product's parent. + description: The product variant's details. x-schemaName: AdminProductVariant required: - prices + - options - id - title - sku @@ -13322,122 +13946,121 @@ components: - length - height - width - - options - created_at - updated_at - deleted_at properties: prices: type: array - description: The parent's prices. + description: The variant's prices. items: $ref: '#/components/schemas/AdminPrice' id: type: string title: id - description: The parent's ID. + description: The variant's ID. title: type: string title: title - description: The parent's title. + description: The variant's title. sku: type: string title: sku - description: The parent's sku. + description: The variant's SKU. barcode: type: string title: barcode - description: The parent's barcode. + description: The variant's barcode. ean: type: string title: ean - description: The parent's ean. + description: The variant's EAN code. upc: type: string title: upc - description: The parent's upc. + description: The variant's UPC. allow_backorder: type: boolean title: allow_backorder - description: The parent's allow backorder. + description: Whether the variant can be ordered even if it's out of stock. manage_inventory: type: boolean title: manage_inventory - description: The parent's manage inventory. + description: Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock. inventory_quantity: type: number title: inventory_quantity - description: The parent's inventory quantity. + description: The variant's inventory quantity. This is only included if you pass in the `fields` query parameter a `+variants.inventory_quantity` parameter. hs_code: type: string title: hs_code - description: The parent's hs code. + description: The variant's HS code. origin_country: type: string title: origin_country - description: The parent's origin country. + description: The variant's origin country. mid_code: type: string title: mid_code - description: The parent's mid code. + description: The variant's MID code. material: type: string title: material - description: The parent's material. + description: The variant's material. weight: type: number title: weight - description: The parent's weight. + description: The variant's weight. length: type: number title: length - description: The parent's length. + description: The variant's length. height: type: number title: height - description: The parent's height. + description: The variant's height. width: type: number title: width - description: The parent's width. + description: The variant's width. variant_rank: type: number title: variant_rank - description: The parent's variant rank. + description: The variant's rank among its sibling variants. options: type: array - description: The parent's options. + description: The variant's option values. items: - $ref: '#/components/schemas/BaseProductOptionValue' + $ref: '#/components/schemas/AdminProductOptionValue' product: - $ref: '#/components/schemas/BaseProduct' + type: object product_id: type: string title: product_id - description: The parent's product id. + description: The ID of the product that the variant belongs to. calculated_price: $ref: '#/components/schemas/BaseCalculatedPriceSet' created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the variant was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the variant was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the variant was deleted. metadata: type: object - description: The parent's metadata. + description: The variant's metadata, can hold custom key-value pairs. AdminProductVariantDeleteResponse: type: object - description: SUMMARY + description: The details of the product variant's deletion. x-schemaName: AdminProductVariantDeleteResponse required: - id @@ -13447,7 +14070,7 @@ components: id: type: string title: id - description: The product's ID. + description: The product variant's ID. object: type: string title: object @@ -13455,12 +14078,13 @@ components: deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the product variant was deleted. + default: variant parent: $ref: '#/components/schemas/AdminProduct' AdminProductVariantInventoryBatchResponse: type: object - description: SUMMARY + description: The created, updated, and deleted associations between variants and inventory items. x-schemaName: AdminProductVariantInventoryBatchResponse required: - created @@ -13471,10 +14095,10 @@ components: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: The product's created. + description: The created associations between product variants and inventory items. items: type: object - description: The created's details. + description: A created association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -13482,32 +14106,32 @@ components: properties: productService: type: object - description: The created's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The created's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. updated: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: The product's updated. + description: The updated associations between product variants and inventory items. items: type: object - description: The updated's details. + description: An updated association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -13515,32 +14139,32 @@ components: properties: productService: type: object - description: The updated's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The updated's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. deleted: oneOf: - $ref: '#/components/schemas/AdminProductVariantInventoryLink' - type: array - description: SUMMARY + description: The deleted associations between product variants and inventory items. items: type: object - description: SUMMARY + description: An deleted association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - productService @@ -13548,55 +14172,55 @@ components: properties: productService: type: object - description: The deleted's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. + description: The ID of the product variant. inventoryService: type: object - description: The deleted's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. AdminProductVariantInventoryLink: type: object - description: The product's ID. + description: The details of an association between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLink required: - - productService - - inventoryService + - Product + - Inventory properties: - productService: + Product: type: object - description: The id's productservice. + description: The product variant's details. required: - variant_id properties: variant_id: type: string title: variant_id - description: The productservice's variant id. - inventoryService: + description: The ID of the product variant. + Inventory: type: object - description: The id's inventoryservice. + description: The inventory item's details. required: - inventory_item_id properties: inventory_item_id: type: string title: inventory_item_id - description: The inventoryservice's inventory item id. + description: The ID of the inventory item. AdminProductVariantInventoryLinkDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted associated between a product variant and an inventory item. x-schemaName: AdminProductVariantInventoryLinkDeleteResponse required: - id @@ -13610,752 +14234,16 @@ components: type: string title: object description: The name of the deleted object. + default: variant-inventory-item-link deleted: type: boolean title: deleted - description: Whether the Product was deleted. + description: Whether the association was deleted. parent: $ref: '#/components/schemas/AdminProductVariant' - AdminProductVariantParams: - type: object - description: SUMMARY - x-schemaName: AdminProductVariantParams - properties: - q: - type: string - title: q - description: The product's q. - id: - oneOf: - - type: string - title: id - description: The product's ID. - - type: array - description: The product's ID. - items: - type: string - title: id - description: The id's ID. - manage_inventory: - type: boolean - title: manage_inventory - description: The product's manage inventory. - allow_backorder: - type: boolean - title: allow_backorder - description: The product's allow backorder. - created_at: - type: object - description: The product's created at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - updated_at: - type: object - description: The product's updated at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - deleted_at: - type: object - description: The product's deleted at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - limit: - type: number - title: limit - description: The product's limit. - offset: - type: number - title: offset - description: The product's offset. - order: - type: string - title: order - description: The product's order. - fields: - type: string - title: fields - description: The product's fields. - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or AdminProductVariantResponse: type: object - description: SUMMARY + description: The product variant's details. x-schemaName: AdminProductVariantResponse required: - variant @@ -14369,6 +14257,13 @@ components: required: - id properties: + application_method: + type: object + rules: + type: array + description: The promotion's rules. + items: + $ref: '#/components/schemas/AdminPromotionRule' id: type: string title: id @@ -14377,6 +14272,7 @@ components: type: string title: code description: The promotion's code. + example: OFF50 type: type: string description: The promotion's type. @@ -14386,23 +14282,16 @@ components: 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' + description: Whether the promotion is applied on a cart automatically if it matches the promotion's rules. campaign_id: type: string title: campaign_id - description: The promotion's campaign id. + description: The ID of the campaign this promotion belongs to. campaign: $ref: '#/components/schemas/AdminCampaign' AdminPromotionResponse: type: object - description: SUMMARY + description: The promotion's details. x-schemaName: AdminPromotionResponse required: - promotion @@ -14411,7 +14300,7 @@ components: $ref: '#/components/schemas/AdminPromotion' AdminPromotionRule: type: object - description: The updated's details. + description: The promotion rule's details. x-schemaName: AdminPromotionRule required: - id @@ -14420,18 +14309,19 @@ components: id: type: string title: id - description: The updated's ID. + description: The promotion rule's ID. description: type: string title: description - description: The updated's description. + description: The promotion rule's description. attribute: type: string title: attribute - description: The updated's attribute. + description: The promotion rule's attribute. + example: customer_group_id operator: type: string - description: The updated's operator. + description: The rule's operator. enum: - gt - lt @@ -14442,9 +14332,50 @@ components: - gte values: type: array - description: The updated's values. + description: The rule's values. + example: + - cusgroup_123 items: $ref: '#/components/schemas/BasePromotionRuleValue' + AdminRefund: + type: object + description: The refund's details. + x-schemaName: AdminRefund + required: + - id + - amount + - created_at + - payment + properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + $ref: '#/components/schemas/BasePayment' + refund_reason: + $ref: '#/components/schemas/RefundReason' AdminRefundReason: type: object description: The refund reason's details. @@ -14470,25 +14401,25 @@ components: description: The refund reason's description. metadata: type: object - description: The refund reason's metadata. + description: The refund reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The refund reason's created at. + description: The date the refund reason was created. updated_at: type: string format: date-time title: updated_at - description: The refund reason's updated at. + description: The date the refund reason was updated. AdminRegion: type: object description: The region's details. x-schemaName: AdminRegion required: - - id - name - currency_code + - id properties: id: type: string @@ -14502,15 +14433,16 @@ components: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are applied automatically during checkout. countries: type: array description: The region's countries. items: - $ref: '#/components/schemas/BaseRegionCountry' + $ref: '#/components/schemas/AdminRegionCountry' payment_providers: type: array description: The region's payment providers. @@ -14518,24 +14450,54 @@ components: $ref: '#/components/schemas/AdminPaymentProvider' metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. AdminRegionCountry: type: object - description: The billing address's country. + description: The country's details. x-schemaName: AdminRegionCountry + required: + - id + properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. AdminRegionResponse: type: object - description: SUMMARY + description: The region's details. x-schemaName: AdminRegionResponse required: - region @@ -14554,7 +14516,6 @@ components: - external_id - description - inventory_item_id - - inventory_item properties: id: type: string @@ -14563,11 +14524,11 @@ components: line_item_id: type: string title: line_item_id - description: The reservation's line item id. + description: The ID of the line item this reservation is for. location_id: type: string title: location_id - description: The reservation's location id. + description: The ID of the location the quantity is reserved from. quantity: type: number title: quantity @@ -14575,7 +14536,7 @@ components: external_id: type: string title: external_id - description: The reservation's external id. + description: An ID in an external system description: type: string title: description @@ -14583,35 +14544,34 @@ components: inventory_item_id: type: string title: inventory_item_id - description: The reservation's inventory item id. + description: The ID of the inventory item this reservation is associated with. inventory_item: - type: object - description: The reservation's inventory item. + $ref: '#/components/schemas/AdminInventoryItem' metadata: type: object - description: The reservation's metadata. + description: The reservation's metadata, can hold custom key-value pairs. created_by: type: string title: created_by - description: The reservation's created by. + description: The ID of the user that created this reservation. deleted_at: type: string format: date-time title: deleted_at - description: The reservation's deleted at. + description: The date this reservation was deleted. created_at: type: string format: date-time title: created_at - description: The reservation's created at. + description: The date this reservation was created. updated_at: type: string format: date-time title: updated_at - description: The reservation's updated at. + description: The date this reservation was updated. AdminReservationResponse: type: object - description: SUMMARY + description: The reservation's details. x-schemaName: AdminReservationResponse required: - reservation @@ -14620,14 +14580,14 @@ components: $ref: '#/components/schemas/AdminReservation' AdminReturn: type: object - description: The exchange's return. + description: The return's details. x-schemaName: AdminReturn required: + - items - id - order_id - order_version - display_id - - items - received_at - created_at - canceled_at @@ -14636,14 +14596,37 @@ components: type: string title: id description: The return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. order_id: type: string title: order_id - description: The return's order id. - status: + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/AdminReturnItem' + created_at: type: string - title: status - description: The return's status. + format: date-time + title: created_at + description: The date the return was created. + canceled_at: + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time exchange_id: type: string title: exchange_id @@ -14667,32 +14650,14 @@ components: 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' + description: Whether the customer should receive notifications about the return's updates. 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. - canceled_at: - type: string - title: canceled_at - description: The return's canceled at. + description: The date the return was received. AdminReturnItem: type: object - description: The return item's return items. + description: The return item's details. x-schemaName: AdminReturnItem required: - id @@ -14713,33 +14678,33 @@ components: received_quantity: type: number title: received_quantity - description: The return item's received quantity. + description: The received quantity of the item. This quantity is added to the stocked inventory quantity of the item. damaged_quantity: type: number title: damaged_quantity - description: The return item's damaged quantity. + description: The received damaged quantity of the item, which isn't added to the stocked inventory quantity of the item. reason_id: type: string title: reason_id - description: The return item's reason id. + description: The ID of the return reason associated with the item. note: type: string title: note - description: The return item's note. + description: A note about why the item was returned. item_id: type: string title: item_id - description: The return item's item id. + description: The ID of the associated order item. return_id: type: string title: return_id - description: The return item's return id. + description: The ID of the return this return item belongs to. metadata: type: object - description: The return item's metadata. + description: The return item's metadata, can hold custom key-value pairs. AdminReturnPreviewResponse: type: object - description: SUMMARY + description: The details of a return and a preview of the order once the return is applied. x-schemaName: AdminReturnPreviewResponse required: - order_preview @@ -14778,20 +14743,20 @@ components: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. AdminReturnReasonDeleteResponse: type: object - description: SUMMARY + description: The details of the return reason deletion. x-schemaName: AdminReturnReasonDeleteResponse required: - id @@ -14810,10 +14775,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Return Reason was deleted. + description: Whether the return reason was deleted. AdminReturnReasonListResponse: type: object - description: SUMMARY + description: The paginated list of return reasons. x-schemaName: AdminReturnReasonListResponse required: - limit @@ -14824,23 +14789,23 @@ components: limit: type: number title: limit - description: The return reason's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The return reason's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The return reason's count. + description: The total number of items. return_reasons: type: array - description: The return reason's return reasons. + description: The list of return reasons. items: $ref: '#/components/schemas/AdminReturnReason' AdminReturnReasonResponse: type: object - description: SUMMARY + description: The return reason's details. x-schemaName: AdminReturnReasonResponse required: - return_reason @@ -14849,7 +14814,7 @@ components: $ref: '#/components/schemas/AdminReturnReason' AdminReturnResponse: type: object - description: SUMMARY + description: The return's details. x-schemaName: AdminReturnResponse required: - return @@ -14858,50 +14823,38 @@ components: $ref: '#/components/schemas/AdminReturn' AdminRevokeApiKey: type: object - description: SUMMARY + description: The details of revoking the API key. x-schemaName: AdminRevokeApiKey properties: revoke_in: type: number title: revoke_in - description: The api key's revoke in. + description: The time in seconds to revoke the API key after. If not set, the API key is revoked immediately. AdminRuleAttributeOption: type: object - description: The attribute's attributes. + description: The details of a potential rule attribute. x-schemaName: AdminRuleAttributeOption required: - id - value - label - - field_type - - required - - disguised - operators properties: id: type: string title: id - description: The attribute's ID. + description: The rule attribute's ID, which is a rule's `attribute` it refers to. + example: customer_group value: type: string title: value - description: The attribute's value. + description: The rule attribute's value. + example: customer.groups.id 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. + description: The rule attribute option's label. + example: Customer Group operators: type: array description: The attribute's operators. @@ -14909,28 +14862,25 @@ components: $ref: '#/components/schemas/BaseRuleOperatorOptions' AdminRuleValueOption: type: object - description: The value's values. + description: The details of a potential rule value. 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. + description: The rule value's value. + example: reg_123 label: type: string title: label - description: The value's label. + description: The rule value's label. + example: Europe Region AdminSalesChannel: type: object - description: The order's sales channel. + description: The sales channel's details. x-schemaName: AdminSalesChannel required: - id @@ -14957,28 +14907,28 @@ components: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The sales channel's created at. + description: The date the sales channel was created. updated_at: type: string format: date-time title: updated_at - description: The sales channel's updated at. + description: The date the sales channel was updated. deleted_at: type: string format: date-time title: deleted_at - description: The sales channel's deleted at. + description: The date the sales channel was deleted. AdminSalesChannelDeleteResponse: type: object - description: SUMMARY + description: The details of deleting a sales channel. x-schemaName: AdminSalesChannelDeleteResponse required: - id @@ -14997,10 +14947,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Sales Channel was deleted. + description: Whether the sales channel was deleted. AdminSalesChannelResponse: type: object - description: SUMMARY + description: The sales channel's details. x-schemaName: AdminSalesChannelResponse required: - sales_channel @@ -15009,7 +14959,7 @@ components: $ref: '#/components/schemas/AdminSalesChannel' AdminServiceZone: type: object - description: The service zone's service zones. + description: The shipping option's service zone. x-schemaName: AdminServiceZone required: - id @@ -15063,7 +15013,7 @@ components: description: The service zone's deleted at. AdminServiceZoneDeleteResponse: type: object - description: SUMMARY + description: The details of the service zone deletion. x-schemaName: AdminServiceZoneDeleteResponse required: - id @@ -15073,20 +15023,21 @@ components: id: type: string title: id - description: The fulfillment set's ID. + description: The service zone's ID. object: type: string title: object description: The name of the deleted object. + default: service_zone deleted: type: boolean title: deleted - description: Whether the Fulfillment Set was deleted. + description: Whether the service zone was deleted. parent: $ref: '#/components/schemas/AdminFulfillmentSet' AdminServiceZoneResponse: type: object - description: SUMMARY + description: The service zone's details. x-schemaName: AdminServiceZoneResponse required: - service_zone @@ -15095,11 +15046,102 @@ components: $ref: '#/components/schemas/AdminServiceZone' AdminShippingOption: type: object - description: The shipping option's shipping options. + description: The shipping option's details. x-schemaName: AdminShippingOption + required: + - id + - name + - price_type + - service_zone_id + - service_zone + - provider_id + - provider + - shipping_option_type_id + - type + - shipping_profile_id + - shipping_profile + - rules + - prices + - data + - metadata + - created_at + - updated_at + - deleted_at + 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 + description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider. + enum: + - calculated + - flat + service_zone_id: + type: string + title: service_zone_id + description: The ID of the service zone this option belongs to. + service_zone: + type: object + provider_id: + type: string + title: provider_id + description: The ID of the provider handling fulfillments created from this shipping option. + provider: + $ref: '#/components/schemas/AdminFulfillmentProvider' + shipping_option_type_id: + type: string + title: shipping_option_type_id + description: The ID of the associated shipping option type. + type: + $ref: '#/components/schemas/AdminShippingOptionType' + shipping_profile_id: + type: string + title: shipping_profile_id + description: The ID of the associated shipping profile. + shipping_profile: + $ref: '#/components/schemas/AdminShippingProfile' + rules: + type: array + description: The shipping option's rules. + items: + $ref: '#/components/schemas/AdminShippingOptionRule' + prices: + type: array + description: The shipping option's prices. If the `price_type` is `calculated`, this array will be empty since the price is calculated by the fulfillment provider during checkout. + items: + $ref: '#/components/schemas/AdminShippingOptionPrice' + data: + type: object + description: The shipping option's data, useful for the fulfillment provider handling fulfillments created from this option. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + metadata: + type: object + description: The shipping option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. AdminShippingOptionDeleteResponse: type: object - description: SUMMARY + description: The details of the shipping option's deletion. x-schemaName: AdminShippingOptionDeleteResponse required: - id @@ -15118,10 +15160,101 @@ components: deleted: type: boolean title: deleted - description: Whether the Shipping Option was deleted. + description: Whether the shipping option was deleted. + AdminShippingOptionPrice: + type: object + description: The details of the shipping option's price. + x-schemaName: AdminShippingOptionPrice + required: + - price_rules + - rules_count + - id + - title + - currency_code + - amount + - raw_amount + - min_quantity + - max_quantity + - price_set_id + - created_at + - updated_at + - deleted_at + properties: + price_rules: + type: array + description: The price's rules. + items: + $ref: '#/components/schemas/AdminShippingOptionPriceRule' + rules_count: + type: number + title: rules_count + description: The number of rules the price has. + 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. + example: usd + 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 minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity that the cart's items must not surpass for this price to apply. + price_set_id: + type: string + title: price_set_id + description: The ID of the price set this price belongs to. + created_at: + type: string + format: date-time + title: created_at + description: The date the price was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the price was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the price was deleted. + AdminShippingOptionPriceRule: + type: object + description: The details of a shipping option price's rule. + x-schemaName: AdminShippingOptionPriceRule + required: + - id + - value + properties: + id: + type: string + title: id + description: The price rule's ID. + value: + type: string + title: value + description: The price rule's value. AdminShippingOptionResponse: type: object - description: SUMMARY + description: The shipping option's details. x-schemaName: AdminShippingOptionResponse required: - shipping_option @@ -15130,7 +15263,7 @@ components: $ref: '#/components/schemas/AdminShippingOption' AdminShippingOptionRule: type: object - description: The updated's details. + description: The shipping option rule's details. x-schemaName: AdminShippingOptionRule required: - id @@ -15145,52 +15278,144 @@ components: id: type: string title: id - description: The updated's ID. + description: The shipping option rule's ID. attribute: type: string title: attribute - description: The updated's attribute. + description: The shipping option rule's attribute. + example: is_return operator: type: string title: operator - description: The updated's operator. + description: The shipping option rule's operator. + example: eq value: oneOf: - type: string title: value - description: The updated's value. + description: The rule's value. + example: '"true"' - type: array - description: The updated's value. + description: The rule's values. items: type: string title: value - description: The value's details. + description: A rule's value + example: '"true"' shipping_option_id: type: string title: shipping_option_id - description: The updated's shipping option id. + description: The ID of the shipping option this rule is for. created_at: type: string format: date-time title: created_at - description: The updated's created at. + description: The date the shipping option rule was created. updated_at: type: string format: date-time title: updated_at - description: The updated's updated at. + description: The date the shipping option rule was updated. deleted_at: type: string format: date-time title: deleted_at - description: The updated's deleted at. + description: The date the shipping option rule was deleted. + AdminShippingOptionType: + type: object + description: The shipping option's details. + x-schemaName: AdminShippingOptionType + required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The shipping option's ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping option was deleted. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The type's shipping option id. AdminShippingProfile: type: object - description: The shipping option's shipping profile. + description: The shipping profile's details.. x-schemaName: AdminShippingProfile + properties: + id: + type: string + title: id + description: The shipping profile's ID. + name: + type: string + title: name + description: The shipping profile's name. + type: + type: string + title: type + description: The shipping profile's type. + metadata: + type: object + description: The shipping profile's metadata, holds custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping profile was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping profile was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the shipping profile was deleted. + required: + - id + - name + - type + - metadata + - created_at + - updated_at + - deleted_at AdminShippingProfileDeleteResponse: type: object - description: SUMMARY + description: The details of the shipping profile's deletion. x-schemaName: AdminShippingProfileDeleteResponse required: - id @@ -15209,10 +15434,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Shipping Profile was deleted. + description: Whether the shipping profile was deleted. AdminShippingProfileResponse: type: object - description: SUMMARY + description: The shipping profile's details. x-schemaName: AdminShippingProfileResponse required: - shipping_profile @@ -15221,7 +15446,7 @@ components: $ref: '#/components/schemas/AdminShippingProfile' AdminStockLocation: type: object - description: The parent's location. + description: The stock location's details. x-schemaName: AdminStockLocation required: - id @@ -15239,31 +15464,79 @@ components: address_id: type: string title: address_id - description: The location's address id. + description: The ID of the associated address. address: $ref: '#/components/schemas/AdminStockLocationAddress' sales_channels: type: array - description: The location's sales channels. + description: The sales channels associated with the location. items: $ref: '#/components/schemas/AdminSalesChannel' fulfillment_providers: type: array - description: The location's fulfillment providers. + description: The fulfillment providers associated with the location. items: $ref: '#/components/schemas/AdminFulfillmentProvider' fulfillment_sets: type: array - description: The location's fulfillment sets. + description: The fulfillment sets associated with the location. items: type: object AdminStockLocationAddress: type: object - description: The location's address. + description: The details of the stock location address. x-schemaName: AdminStockLocationAddress + properties: + id: + type: string + title: id + description: The address's ID. + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + company: + type: string + title: company + description: The address's company. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + city: + type: string + title: city + description: The address's city. + phone: + type: string + title: phone + description: The address's phone. + postal_code: + type: string + title: postal_code + description: The address's postal code. + province: + type: string + title: province + description: The address's province. + required: + - id + - address_1 + - address_2 + - company + - country_code + - city + - phone + - postal_code + - province AdminStockLocationDeleteResponse: type: object - description: SUMMARY + description: The details of the stock location's deletion. x-schemaName: AdminStockLocationDeleteResponse required: - id @@ -15282,10 +15555,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Stock Location was deleted. + description: Whether the stock location was deleted. AdminStockLocationListResponse: type: object - description: SUMMARY + description: The paginated list of stock locations. x-schemaName: AdminStockLocationListResponse required: - limit @@ -15296,23 +15569,23 @@ components: limit: type: number title: limit - description: The stock location's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The stock location's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The stock location's count. + description: The total number of items. stock_locations: type: array - description: The stock location's stock locations. + description: The list of stock locations. items: $ref: '#/components/schemas/AdminStockLocation' AdminStockLocationResponse: type: object - description: SUMMARY + description: The stock location's details. x-schemaName: AdminStockLocationResponse required: - stock_location @@ -15350,31 +15623,31 @@ components: default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the sales channel used by default in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the region used by default in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the stock location used by default in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The store's created at. + description: The date the store was created. updated_at: type: string format: date-time title: updated_at - description: The store's updated at. + description: The date the store was updated. AdminStoreCurrency: type: object - description: The supported currency's supported currencies. + description: The details of a store's currency. x-schemaName: AdminStoreCurrency required: - id @@ -15389,39 +15662,40 @@ components: id: type: string title: id - description: The supported currency's ID. + description: The currency's ID. currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd store_id: type: string title: store_id - description: The supported currency's store id. + description: The ID of the store this currency belongs to. is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether this currency is the default in the store. currency: $ref: '#/components/schemas/AdminCurrency' created_at: type: string format: date-time title: created_at - description: The supported currency's created at. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The supported currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The supported currency's deleted at. + description: The date the currency was deleted. AdminStoreListResponse: type: object - description: SUMMARY + description: The paginated list of stores. x-schemaName: AdminStoreListResponse required: - limit @@ -15432,23 +15706,23 @@ components: limit: type: number title: limit - description: The store's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The store's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The store's count. + description: The total number of items. stores: type: array - description: The store's stores. + description: The list of stores. items: $ref: '#/components/schemas/AdminStore' AdminStoreResponse: type: object - description: SUMMARY + description: The store's details. x-schemaName: AdminStoreResponse required: - store @@ -15457,7 +15731,7 @@ components: $ref: '#/components/schemas/AdminStore' AdminTaxRate: type: object - description: The tax rate's parent. + description: The tax rate's details. x-schemaName: AdminTaxRate required: - id @@ -15478,63 +15752,66 @@ components: id: type: string title: id - description: The parent's ID. + description: The tax rate's ID. rate: type: number title: rate - description: The parent's rate. + description: The rate to charge. + example: 10 code: type: string title: code - description: The parent's code. + description: The code the tax rate is identified by. name: type: string title: name - description: The parent's name. + description: The tax rate's name. metadata: type: object - description: The parent's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. tax_region_id: type: string title: tax_region_id - description: The parent's tax region id. + description: The ID of the tax region this rate belongs to. is_combinable: type: boolean title: is_combinable - description: The parent's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates is_default: type: boolean title: is_default - description: The parent's is default. + description: Whether this tax rate is the default in the tax region. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the tax rate was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the tax rate was updated. deleted_at: type: string format: date-time title: deleted_at - description: The parent's deleted at. + description: The date the tax rate was deleted. created_by: type: string title: created_by - description: The parent's created by. + description: The ID of the user that created the tax rate. tax_region: $ref: '#/components/schemas/AdminTaxRegion' rules: type: array - description: The parent's rules. + description: The tax rate's rules. items: $ref: '#/components/schemas/AdminTaxRateRule' AdminTaxRateDeleteResponse: type: object - description: SUMMARY + description: The details of the tax rate deletion. x-schemaName: AdminTaxRateDeleteResponse required: - id @@ -15553,10 +15830,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Tax Rate was deleted. + description: Whether the tax rate was deleted. AdminTaxRateResponse: type: object - description: SUMMARY + description: The tax rate's details. x-schemaName: AdminTaxRateResponse required: - tax_rate @@ -15565,7 +15842,7 @@ components: $ref: '#/components/schemas/AdminTaxRate' AdminTaxRateRule: type: object - description: The rule's rules. + description: The tax rate rule's details. x-schemaName: AdminTaxRateRule required: - reference @@ -15574,26 +15851,22 @@ components: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of a record in the table that this rule references. + example: ptyp_1 AdminTaxRegion: type: object - description: The parent's tax region. + description: The tax region's details. 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 @@ -15607,67 +15880,44 @@ components: 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. + example: us 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. + description: The tax region's metadata, can hold custom key-value pairs. parent_id: type: string title: parent_id - description: The tax region's parent id. + description: The ID of the parent tax region. created_at: type: string format: date-time title: created_at - description: The tax region's created at. + description: The date the tax region was created. updated_at: type: string format: date-time title: updated_at - description: The tax region's updated at. + description: The date the tax region was updated. deleted_at: type: string format: date-time title: deleted_at - description: The tax region's deleted at. + description: The date the tax region was deleted. created_by: type: string title: created_by - description: The tax region's created by. + description: The ID of the user that created the tax region. tax_rates: type: array - description: The tax region's tax rates. + description: The tax region's rates. items: type: object parent: @@ -15679,7 +15929,7 @@ components: type: object AdminTaxRegionDeleteResponse: type: object - description: SUMMARY + description: The details of the tax region deletion. x-schemaName: AdminTaxRegionDeleteResponse required: - id @@ -15698,10 +15948,10 @@ components: deleted: type: boolean title: deleted - description: Whether the Tax Region was deleted. + description: Whether the tax region was deleted. AdminTaxRegionResponse: type: object - description: SUMMARY + description: The tax region's details. x-schemaName: AdminTaxRegionResponse required: - tax_region @@ -15710,7 +15960,7 @@ components: $ref: '#/components/schemas/AdminTaxRegion' AdminUpdateApiKey: type: object - description: SUMMARY + description: The details to update in an API key. x-schemaName: AdminUpdateApiKey required: - title @@ -15718,10 +15968,10 @@ components: title: type: string title: title - description: The api key's title. + description: The API key's title. AdminUpdateCollection: type: object - description: SUMMARY + description: The details to update in a collection. x-schemaName: AdminUpdateCollection properties: title: @@ -15734,10 +15984,10 @@ components: description: The collection's handle. metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. AdminUpdateCustomerGroup: type: object - description: SUMMARY + description: The details to update in a customer group. x-schemaName: AdminUpdateCustomerGroup properties: name: @@ -15746,10 +15996,10 @@ components: description: The customer group's name. metadata: type: object - description: The customer group's metadata. + description: The customer group's metadata, can hold custom key-value pairs. AdminUpdatePriceList: type: object - description: SUMMARY + description: the details to update in a price list. x-schemaName: AdminUpdatePriceList properties: title: @@ -15763,11 +16013,11 @@ components: starts_at: type: string title: starts_at - description: The price list's starts at. + description: The date the price list starts. ends_at: type: string title: ends_at - description: The price list's ends at. + description: The date the price list ends. status: type: string description: The price list's status. @@ -15783,72 +16033,77 @@ components: rules: type: object description: The price list's rules. + example: + customer_group_id: + - cusgrp_123 AdminUpdatePricePreference: type: object - description: SUMMARY + description: The details to update in the price preference. x-schemaName: AdminUpdatePricePreference properties: attribute: type: string title: attribute description: The price preference's attribute. + example: region_id value: type: string title: value description: The price preference's value. + example: reg_123 is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The price preference's is tax inclusive. + description: Whether prices are tax inclusive for this price preference. AdminUpdateProduct: type: object - description: The update's details. + description: The product's details. x-schemaName: AdminUpdateProduct properties: title: type: string title: title - description: The update's title. + description: The product's title. subtitle: type: string title: subtitle - description: The update's subtitle. + description: The product's subtitle. description: type: string title: description - description: The update's description. + description: The product's description. is_giftcard: type: boolean title: is_giftcard - description: The update's is giftcard. + description: Whether the product is a gift card. discountable: type: boolean title: discountable - description: The update's discountable. + description: Whether discounts can be applied on the product. images: type: array - description: The update's images. + description: The product's images. items: type: object - description: The image's images. + description: The image's details. required: - url properties: url: type: string title: url - description: The image's url. + description: The image's URL. thumbnail: type: string title: thumbnail - description: The update's thumbnail. + description: The product's thumbnail URL. handle: type: string title: handle - description: The update's handle. + description: The product's unique handle. status: type: string - description: The update's status. + description: The product's status. enum: - draft - proposed @@ -15857,17 +16112,17 @@ components: type_id: type: string title: type_id - description: The update's type id. + description: The ID of the product's type. collection_id: type: string title: collection_id - description: The update's collection id. + description: The ID of the product's collection. categories: type: array - description: The update's categories. + description: The product's categories. items: type: object - description: The category's categories. + description: The product's category. required: - id properties: @@ -15877,10 +16132,10 @@ components: description: The category's ID. tags: type: array - description: The update's tags. + description: The product's tags. items: type: object - description: The tag's tags. + description: The product's tag. required: - id properties: @@ -15890,181 +16145,22 @@ components: description: The tag's ID. options: type: array - description: The update's options. + description: The product's options. items: $ref: '#/components/schemas/AdminUpdateProductOption' variants: type: array - description: The update's variants. + description: The product's variants. You can add new variants or update existing ones, passing their IDs in the object. items: 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. + - $ref: '#/components/schemas/AdminCreateProductVariant' + - $ref: '#/components/schemas/AdminUpdateProductVariant' sales_channels: type: array - description: The update's sales channels. + description: The sales channels that the product is available in. items: type: object - description: The sales channel's sales channels. + description: The sales channel's details. required: - id properties: @@ -16075,137 +16171,205 @@ components: weight: type: number title: weight - description: The update's weight. + description: The product's weight. length: type: number title: length - description: The update's length. + description: The product's length. height: type: number title: height - description: The update's height. + description: The product's height. width: type: number title: width - description: The update's width. + description: The product's width. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product's MID code. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product's origin country. material: type: string title: material - description: The update's material. + description: The product's material. metadata: type: object - description: The update's metadata. + description: The product's metadata, can hold custom key-value pairs. AdminUpdateProductOption: type: object - description: SUMMARY + description: The details to update in a product option. x-schemaName: AdminUpdateProductOption properties: title: type: string title: title - description: The product's title. + description: The option's title. values: type: array - description: The product's values. + description: The option's values. items: type: string title: values - description: The value's values. + description: An option value. AdminUpdateProductVariant: type: object - description: The update's details. + description: The properties to update of a product variant. x-schemaName: AdminUpdateProductVariant properties: title: type: string title: title - description: The update's title. + description: The product variant's title. sku: type: string title: sku - description: The update's sku. + description: The product variant's SKU. ean: type: string title: ean - description: The update's ean. + description: The product variant's EAN. upc: type: string title: upc - description: The update's upc. + description: The product variant's UPC. barcode: type: string title: barcode - description: The update's barcode. + description: The product variant's barcode. hs_code: type: string title: hs_code - description: The update's hs code. + description: The product variant's HS code. mid_code: type: string title: mid_code - description: The update's mid code. + description: The product variant's MID code. allow_backorder: type: boolean title: allow_backorder - description: The update's allow backorder. + description: Whether customers can order the variant even if it's not in stock. manage_inventory: type: boolean title: manage_inventory - description: The update's manage inventory. + description: Whether the Medusa application manages the variant's inventory. If disabled, the product variant is always considered in stock. variant_rank: type: number title: variant_rank - description: The update's variant rank. + description: The product variant's rank among its siblings. weight: type: number title: weight - description: The update's weight. + description: The product variant's weight. length: type: number title: length - description: The update's length. + description: The product variant's length. height: type: number title: height - description: The update's height. + description: The product variant's height. width: type: number title: width - description: The update's width. + description: The product variant's width. origin_country: type: string title: origin_country - description: The update's origin country. + description: The product variant's origin country. material: type: string title: material - description: The update's material. + description: The product variant's material. metadata: type: object - description: The update's metadata. + description: The product variant's metadata, can hold custom key-value pairs. prices: type: array - description: The update's prices. + description: The product variant's prices. items: $ref: '#/components/schemas/AdminCreateProductVariantPrice' options: type: object - description: The update's options. + description: The product variant's options. + AdminUpdatePromotionRule: + type: object + description: The properties to update in a buy rule. + required: + - id + - values + properties: + id: + type: string + title: id + description: The buy rule's ID. + operator: + type: string + description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. + enum: + - gte + - lte + - gt + - lt + - eq + - ne + - in + description: + type: string + title: description + description: The buy rule's description. + attribute: + type: string + title: attribute + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id + values: + oneOf: + - type: string + title: values + description: The attribute's value. + example: prod_123 + - type: array + description: The allowed attribute values. + items: + type: string + title: values + description: An attribute value. + example: prod_123 + x-schemaName: AdminUpdatePromotionRule + AdminUpdateReturnReason: + type: object + description: The details to update in a return reason. + x-schemaName: AdminUpdateReturnReason + properties: + label: + type: string + title: label + description: The return reason's label. + value: + type: string + title: value + description: The return reason's value. + description: + type: string + title: description + description: The return reason's description. + metadata: + type: object + description: The return reason's metadata, can hold custom key-value pairs. + required: + - value + - label AdminUpdateSalesChannel: type: object - description: SUMMARY + description: The properties to update in the sales channel. x-schemaName: AdminUpdateSalesChannel properties: name: @@ -16219,13 +16383,57 @@ components: is_disabled: type: boolean title: is_disabled - description: The sales channel's is disabled. + description: Whether the sales channel is disabled. metadata: type: object - description: The sales channel's metadata. + description: The sales channel's metadata, can hold custom key-value pairs. + AdminUpdateShippingOptionRule: + type: object + description: The properties to update in the shipping option rule. + required: + - id + - operator + - attribute + - value + properties: + id: + type: string + title: id + description: The rule's ID. + operator: + type: string + description: The operator used to check whether a rule applies. + enum: + - in + - eq + - ne + - gt + - gte + - lt + - lte + - nin + attribute: + type: string + title: attribute + description: The name of a property or table that the rule applies to. + example: customer_group + value: + oneOf: + - type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 + - type: array + description: Values of the attribute that enable this rule. + items: + type: string + title: value + description: A value of the attribute that enables this rule. + example: cusgroup_123 + x-schemaName: AdminUpdateShippingOptionRule AdminUpdateStockLocation: type: object - description: SUMMARY + description: The properties to update in a stock location. x-schemaName: AdminUpdateStockLocation properties: name: @@ -16234,7 +16442,7 @@ components: description: The stock location's name. address: type: object - description: The stock location's address. + description: The stock location's address. Pass this property if you're creating a new address to associate with the location. required: - address_1 - country_code @@ -16242,11 +16450,11 @@ components: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -16259,6 +16467,7 @@ components: type: string title: country_code description: The address's country code. + example: us phone: type: string title: phone @@ -16274,13 +16483,13 @@ components: address_id: type: string title: address_id - description: The stock location's address id. + description: The ID of an existing stock location address to associate the stock location with. metadata: type: object - description: The stock location's metadata. + description: The stock location's metadata, can hold custom key-value pairs. AdminUpdateStore: type: object - description: SUMMARY + description: The properties to update in a store. x-schemaName: AdminUpdateStore properties: name: @@ -16292,56 +16501,57 @@ components: description: The store's supported currencies. items: type: object - description: The supported currency's supported currencies. + description: A store currency. required: - currency_code properties: currency_code: type: string title: currency_code - description: The supported currency's currency code. + description: The currency's code. + example: usd is_default: type: boolean title: is_default - description: The supported currency's is default. + description: Whether the currency is the default in the store. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The supported currency's is tax inclusive. + description: Whether prices using this currency are tax inclusive. default_sales_channel_id: type: string title: default_sales_channel_id - description: The store's default sales channel id. + description: The ID of the default sales channel in the store. default_region_id: type: string title: default_region_id - description: The store's default region id. + description: The ID of the default region in the store. default_location_id: type: string title: default_location_id - description: The store's default location id. + description: The ID of the default stock location in the store. metadata: type: object - description: The store's metadata. + description: The store's metadata, can hold custom key-value pairs. AdminUpdateTaxRate: type: object - description: SUMMARY + description: The properties to update in the tax rate. x-schemaName: AdminUpdateTaxRate properties: rate: type: number title: rate - description: The tax rate's rate. + description: The rate to charge. code: type: string title: code - description: The tax rate's code. + description: The code that the tax rate is identified by. rules: type: array description: The tax rate's rules. items: type: object - description: The rule's rules. + description: A tax rate rule. required: - reference - reference_id @@ -16349,11 +16559,13 @@ components: reference: type: string title: reference - description: The rule's reference. + description: The name of the table this rule references. + example: product_type reference_id: type: string title: reference_id - description: The rule's reference id. + description: The ID of the record in the table that the rule references. + example: ptyp_123 name: type: string title: name @@ -16361,17 +16573,19 @@ components: is_default: type: boolean title: is_default - description: The tax rate's is default. + description: Whether the tax rate is the default in the store. is_combinable: type: boolean title: is_combinable - description: The tax rate's is combinable. + description: Whether the tax rate should be combined with parent rates. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/tax/tax-rates-and-rules#combinable-tax-rates metadata: type: object - description: The tax rate's metadata. + description: The tax rate's metadata, can hold custom key-value pairs. AdminUpdateUser: type: object - description: SUMMARY + description: The properties to update in a user. x-schemaName: AdminUpdateUser properties: first_name: @@ -16385,10 +16599,10 @@ components: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. AdminUpdateVariantInventoryItem: type: object - description: SUMMARY + description: The properties to update of the variant's inventory item association. x-schemaName: AdminUpdateVariantInventoryItem required: - required_quantity @@ -16396,10 +16610,10 @@ components: required_quantity: type: number title: required_quantity - description: The product's required quantity. + description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. AdminUpsertStockLocationAddress: type: object - description: The stock location's address. + description: The details of the stock location address to create. x-schemaName: AdminUpsertStockLocationAddress required: - address_1 @@ -16408,11 +16622,11 @@ components: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. company: type: string title: company @@ -16421,6 +16635,7 @@ components: type: string title: country_code description: The address's country code. + example: usd city: type: string title: city @@ -16472,28 +16687,28 @@ components: avatar_url: type: string title: avatar_url - description: The user's avatar url. + description: The URL of the user's avatar. metadata: type: object - description: The user's metadata. + description: The user's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The user's created at. + description: The date the user was created. updated_at: type: string format: date-time title: updated_at - description: The user's updated at. + description: The date the user was updated. deleted_at: type: string format: date-time title: deleted_at - description: The user's deleted at. + description: The date the user was deleted. AdminUserDeleteResponse: type: object - description: SUMMARY + description: The details of the deleted user. x-schemaName: AdminUserDeleteResponse required: - id @@ -16512,10 +16727,10 @@ components: deleted: type: boolean title: deleted - description: Whether the User was deleted. + description: Whether the user was deleted. AdminUserListResponse: type: object - description: SUMMARY + description: The paginated list of users. x-schemaName: AdminUserListResponse required: - limit @@ -16526,23 +16741,23 @@ components: limit: type: number title: limit - description: The user's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The user's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The user's count. + description: The total number of items. users: type: array - description: The user's users. + description: The list of users. items: $ref: '#/components/schemas/AdminUser' AdminUserResponse: type: object - description: SUMMARY + description: The user's details. x-schemaName: AdminUserResponse required: - user @@ -16551,7 +16766,7 @@ components: $ref: '#/components/schemas/AdminUser' AdminWorkflowExecution: type: object - description: The workflows execution's workflow execution. + description: The workflows execution's details. x-schemaName: AdminWorkflowExecution required: - id @@ -16570,11 +16785,11 @@ components: workflow_id: type: string title: workflow_id - description: The workflow execution's workflow id. + description: The ID of the workflow. transaction_id: type: string title: transaction_id - description: The workflow execution's transaction id. + description: The workflow execution's transaction ID. execution: $ref: '#/components/schemas/AdminWorkflowExecutionExecution' context: @@ -16594,30 +16809,160 @@ components: type: string format: date-time title: created_at - description: The workflow execution's created at. + description: The date the workflow execution was created. updated_at: type: string format: date-time title: updated_at - description: The workflow execution's updated at. + description: The date the workflow execution was updated. deleted_at: type: string format: date-time title: deleted_at - description: The workflow execution's deleted at. + description: The date the workflow execution was deleted. AdminWorkflowExecutionExecution: type: object - description: The workflow execution's execution. + description: The workflow execution's steps details. x-schemaName: AdminWorkflowExecutionExecution required: - steps properties: steps: type: object - description: The execution's steps. + description: The execution's steps. Each object key is a step ID, and the value is the object whose properties are shown below. + required: + - id + - invoke + - definition + - compensate + - depth + - startedAt + additionalProperties: + type: object + properties: + id: + type: string + title: id + description: The step's ID. + invoke: + type: object + description: The state of the step's invokation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The invokation step's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The invokation step's state. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + definition: + type: object + description: The step's definition details. + x-schemaName: WorkflowExecutionDefinition + properties: + async: + type: boolean + title: async + description: Whether the step is async. + compensateAsync: + type: boolean + title: compensateAsync + description: Whether the compensation function of the step is async. + noCompensation: + type: boolean + title: noCompensation + description: Whether the step doesn't have a compensation function. + continueOnPermanentFailure: + type: boolean + title: continueOnPermanentFailure + description: Whether the step continues executing even if its status is changed to failed. + maxRetries: + type: number + title: maxRetries + description: The maximum number of times to retry the step. + noWait: + type: boolean + title: noWait + description: Whether the workflow shouldn't wait for the step to finish before moving to the next step. + default: false + retryInterval: + type: number + title: retryInterval + description: The interval in seconds between retry attempts when the step fails. + retryIntervalAwaiting: + type: number + title: retryIntervalAwaiting + description: The interval in seconds to retry a step even if its status is `waiting_response`. + saveResponse: + type: boolean + title: saveResponse + description: Whether the step's response is stored. + timeout: + type: number + title: timeout + description: The maximum time in seconds to wait for this step to complete. If the step exceeds this time, the step's state is changed to `timeout`, but the step continues executing. + compensate: + type: object + description: The state of the step's compensation function. + x-schemaName: WorkflowExecutionFn + properties: + state: + type: string + description: The compensation function's state. + enum: + - not_started + - invoking + - compensating + - done + - reverted + - failed + - dormant + - skipped + - skipped_failure + - timeout + status: + type: string + description: The compensation function's status. + enum: + - idle + - ok + - waiting_response + - temp_failure + - permanent_failure + required: + - state + - status + depth: + type: number + title: depth + description: The step's depth in the workflow's execution. + startedAt: + type: number + title: startedAt + description: The timestamp the step started executing. AdminWorkflowExecutionResponse: type: object - description: SUMMARY + description: The workflow execution's details. x-schemaName: AdminWorkflowExecutionResponse required: - workflow_execution @@ -16626,7 +16971,7 @@ components: $ref: '#/components/schemas/AdminWorkflowExecution' ApiKeyResponse: type: object - description: The api key's details. + description: The API key's details. x-schemaName: ApiKeyResponse required: - id @@ -16643,46 +16988,47 @@ components: id: type: string title: id - description: The api key's ID. + description: The API key's ID. token: type: string title: token - description: The api key's token. + description: The API key's token. redacted: type: string title: redacted - description: The api key's redacted. + description: The redacted form of the API key's token. This is useful when showing portion of the token. For example `sk_...123`. title: type: string title: title - description: The api key's title. + description: The API key's title. type: type: string + description: The API key's type. `secret` API keys are used for authenticating admin users, and `publishable` API key are used for storefronts and similar clients to scope requests to sales channels. enum: - secret - publishable last_used_at: type: string title: last_used_at - description: The api key's last used at. + description: The date the API key was last used. format: date-time created_by: type: string title: created_by - description: The api key's created by. + description: The ID of the user that created the API key. created_at: type: string title: created_at - description: The api key's created at. + description: The date the API key was created. format: date-time revoked_by: type: string title: revoked_by - description: The api key's revoked by. + description: The ID of the user that revoked the API key. revoked_at: type: string title: revoked_at - description: The api key's revoked at. + description: The date the API key was revoked. format: date-time AuthAdminSessionResponse: type: object @@ -16702,7 +17048,7 @@ components: required: - location properties: - token: + location: type: string title: location description: The location to redirect the user to for further authentication with the third-party provider. @@ -16728,71 +17074,9 @@ components: title: user description: The logged-in customer. $ref: '#/components/schemas/StoreCustomer' - 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 - description: The application method's type. - enum: - - fixed - - percentage - target_type: - type: string - description: The application method's target type. - enum: - - items - - shipping_methods - - order - allocation: - type: string - description: The application method's allocation. - enum: - - each - - across - 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 parent's calculated price. + description: The calculated price's details. x-schemaName: BaseCalculatedPriceSet required: - id @@ -16807,126 +17091,310 @@ components: is_calculated_price_price_list: type: boolean title: is_calculated_price_price_list - description: The calculated price's is calculated price price list. + description: Whether the calculated price belongs to a price list. is_calculated_price_tax_inclusive: type: boolean title: is_calculated_price_tax_inclusive - description: The calculated price's is calculated price tax inclusive. + description: Whether the calculated price is tax inclusive. calculated_amount: type: number title: calculated_amount - description: The calculated price's calculated amount. + description: The amount of the calculated price, or `null` if there isn't a calculated price. This is the amount shown to the customer. calculated_amount_with_tax: type: number title: calculated_amount_with_tax - description: The calculated price's calculated amount with tax. + description: The calculated price's amount with taxes applied. calculated_amount_without_tax: type: number title: calculated_amount_without_tax - description: The calculated price's calculated amount without tax. + description: The calculated price's amount without taxes applied. is_original_price_price_list: type: boolean title: is_original_price_price_list - description: The calculated price's is original price price list. + description: Whether the original price belongs to a price list. is_original_price_tax_inclusive: type: boolean title: is_original_price_tax_inclusive - description: The calculated price's is original price tax inclusive. + description: Whether the original price is tax inclusive. original_amount: type: number title: original_amount - description: The calculated price's original amount. + description: The amount of the original price, or `null` if there isn't an original price. This amount is useful to compare with the `calculated_amount`, such as to check for discounted value. currency_code: type: string title: currency_code description: The calculated price's currency code. + example: usd calculated_price: type: object description: The calculated price's details. + properties: + id: + type: string + title: id + description: The calculated price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity original_price: type: object - description: The calculated price's original price. + description: The original price's details. + properties: + id: + type: string + title: id + description: The original price's ID. + price_list_id: + type: string + title: price_list_id + description: The ID of the price list that the price belongs to. + price_list_type: + type: string + title: price_list_type + description: The price list's type. For example, `sale`. + min_quantity: + type: number + title: min_quantity + description: The minimum quantity required in the cart for this price to apply. + max_quantity: + type: number + title: max_quantity + description: The maximum quantity required in the cart for this price to apply. + required: + - id + - price_list_id + - price_list_type + - min_quantity + - max_quantity BaseCapture: type: object - description: The capture's captures. + description: The details of a captured payment. x-schemaName: BaseCapture - BaseCart: - type: object - description: The item's cart. - x-schemaName: BaseCart - BaseCartAddress: - type: object - description: The parent's billing address. - x-schemaName: BaseCartAddress required: - id + - amount - created_at - - updated_at + - payment 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. + description: The payment capture's ID. + amount: + type: number + title: amount + description: The captured amount. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the capture was created. + created_by: + type: string + title: created_by + description: The ID of the user that captured the payment. + payment: + type: object + BaseCart: + type: object + description: The item's cart. + x-schemaName: BaseCart + 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: + type: object + 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 billing address's updated at. + description: The cart's updated at. + original_item_total: + type: number + title: original_item_total + description: The cart's original item total. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The cart's original item subtotal. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The cart's original item tax total. + item_total: + type: number + title: item_total + description: The cart's item total. + item_subtotal: + type: number + title: item_subtotal + description: The cart's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The cart's item tax total. + original_total: + type: number + title: original_total + description: The cart's original total. + original_subtotal: + type: number + title: original_subtotal + description: The cart's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The cart's original tax total. + total: + type: number + title: total + description: The cart's total. + subtotal: + type: number + title: subtotal + description: The cart's subtotal. + tax_total: + type: number + title: tax_total + description: The cart's tax total. + discount_total: + type: number + title: discount_total + description: The cart's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The cart's discount tax total. + gift_card_total: + type: number + title: gift_card_total + description: The cart's gift card total. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The cart's gift card tax total. + shipping_total: + type: number + title: shipping_total + description: The cart's shipping total. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The cart's shipping subtotal. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The cart's shipping tax total. + original_shipping_total: + type: number + title: original_shipping_total + description: The cart's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The cart's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The cart's original shipping tax total. + BaseCartAddress: + type: object + description: The cart's shipping address. + x-schemaName: BaseCartAddress BaseCartLineItem: type: object - description: The item's items. + description: The tax line's item. x-schemaName: BaseCartLineItem required: - id @@ -16967,17 +17435,9 @@ components: 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' + type: number + title: quantity + description: The item's quantity. product: $ref: '#/components/schemas/BaseProduct' product_id: @@ -17042,34 +17502,18 @@ components: 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' + type: number + title: compare_at_unit_price + description: The item's compare at unit price. 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' + type: number + title: unit_price + description: The item's unit price. tax_lines: type: array description: The item's tax lines. items: - $ref: '#/components/schemas/BaseLineItemTaxLine' + type: object adjustments: type: array description: The item's adjustments. @@ -17100,140 +17544,52 @@ components: title: deleted_at description: The item's deleted at. 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' + type: number + title: original_total + description: The item's original total. 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' + type: number + title: original_subtotal + description: The item's original subtotal. 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' + type: number + title: original_tax_total + description: The item's original tax total. 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' + type: number + title: item_total + description: The item's item total. 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' + type: number + title: item_subtotal + description: The item's item subtotal. 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' + type: number + title: item_tax_total + description: The item's item tax total. 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' + type: number + title: total + description: The item's total. 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' + type: number + title: subtotal + description: The item's subtotal. 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' + type: number + title: tax_total + description: The item's tax total. 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' + type: number + title: discount_total + description: The item's discount total. 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' + type: number + title: discount_tax_total + description: The item's discount tax total. BaseCartShippingMethod: type: object - description: The shipping method's shipping methods. + description: A cart's shipping method. x-schemaName: BaseCartShippingMethod required: - id @@ -17259,7 +17615,7 @@ components: cart_id: type: string title: cart_id - description: The shipping method's cart id. + description: The ID of the cart this shipping method belongs to. name: type: string title: name @@ -17269,31 +17625,25 @@ components: 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' + 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. + description: Whether the shipping method's amount is tax inclusive. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: The shipping method's data, useful for fulfillment handling by third-party services. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -17301,122 +17651,54 @@ components: $ref: '#/components/schemas/BaseShippingMethodTaxLine' adjustments: type: array - description: The shipping method's adjustments. + description: The shipping method's adjustments, such as applied promotions. items: $ref: '#/components/schemas/BaseShippingMethodAdjustment' created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. 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' + type: string + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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' + type: string + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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' + type: string + title: original_tax_total + description: The total taxes applied on the shipping method's amount including promotions. 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' + type: string + title: total + description: The shipping method's total amount including taxes and promotions. 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' + type: string + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. 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' + type: string + title: tax_total + description: The total taxes applied on the shipping method's amount including promotions. 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' + type: string + title: discount_total + description: The total amount discounted. 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 + type: string + title: discount_total + description: The taxes applied on the discounted amount. BaseClaimItem: type: object - description: The claim item's claim items. + description: The claim item's details. x-schemaName: BaseClaimItem required: - id @@ -17434,22 +17716,22 @@ components: claim_id: type: string title: claim_id - description: The claim item's claim id. + description: The ID of the claim this item belongs to. order_id: type: string title: order_id - description: The claim item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The claim item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The claim item's quantity. + description: The quantity claimed. reason: type: string - description: The claim item's reason. + description: The claim's reason. enum: - missing_item - wrong_item @@ -17457,59 +17739,83 @@ components: - other raw_quantity: type: object - description: The claim item's raw quantity. + description: The quantity claimed. + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + required: + - value metadata: type: object - description: The claim item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The claim item's created at. + description: The date the claim was created. updated_at: type: string format: date-time title: updated_at - description: The claim item's updated at. + description: The date the claim was updated. BaseCollection: type: object - description: The product's collection. + description: The collection's details. x-schemaName: BaseCollection - BaseCustomer: + BaseCustomerAddress: type: object - description: The customer's details. - x-schemaName: BaseCustomer + description: The customer's address. + x-schemaName: BaseCustomerAddress required: - id - - email - - default_billing_address_id - - default_shipping_address_id - - company_name + - address_name + - is_default_shipping + - is_default_billing + - customer_id + - company - first_name - last_name - - addresses + - address_1 + - address_2 + - city + - country_code + - province + - postal_code + - phone + - metadata + - created_at + - updated_at properties: id: type: string title: id - description: The customer's ID. - email: + description: The address's ID. + address_name: type: string - title: email - description: The customer's email. - format: email - default_billing_address_id: + title: address_name + description: The address's name. + is_default_shipping: + type: boolean + title: is_default_shipping + description: Whether the address is the default shipping address. + is_default_billing: + type: boolean + title: is_default_billing + description: Whether the address is the default billing address. + customer_id: type: string - title: default_billing_address_id - description: The ID of the address used as the default billing address. - default_shipping_address_id: + title: customer_id + description: The ID of the customer that this address belongs to. + company: type: string - title: default_shipping_address_id - description: The ID of the address used as the default shipping address. - company_name: - type: string - title: company_name - description: The customer's company name. + title: company + description: The customer's company. first_name: type: string title: first_name @@ -17518,44 +17824,51 @@ components: type: string title: last_name description: The customer's last name. - addresses: - type: array - description: The customer's addresses. - items: - $ref: '#/components/schemas/BaseCustomerAddress' + address_1: + type: string + title: address_1 + description: The address's first line. + address_2: + type: string + title: address_2 + description: The address's second line. + city: + type: string + title: city + description: The address's city. + country_code: + type: string + title: country_code + description: The address's country code. + example: us + 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 customer's phone. + description: The address's phone. metadata: type: object - description: The customer's metadata, used to store custom key-value pairs. - created_by: - type: string - title: created_by - description: The ID of the user that created this customer, if available. + description: The address's metadata, used to store custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The customer's creation date. + description: The address's creation date. updated_at: type: string format: date-time title: updated_at - description: The customer's update date. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The customer's deletion date. - BaseCustomerAddress: - type: object - description: The address's addresses. - x-schemaName: BaseCustomerAddress + description: The address's update date. BaseExchangeItem: type: object - description: The additional item's additional items. + description: The item's details. x-schemaName: BaseExchangeItem required: - id @@ -17569,39 +17882,39 @@ components: id: type: string title: id - description: The additional item's ID. + description: The item's ID. exchange_id: type: string title: exchange_id - description: The additional item's exchange id. + description: The ID of the exchange this item belongs to. order_id: type: string title: order_id - description: The additional item's order id. + description: The ID of the order this item belongs to. item_id: type: string title: item_id - description: The additional item's item id. + description: The ID of the item in the order. quantity: type: number title: quantity - description: The additional item's quantity. + description: The item's quantity. metadata: type: object - description: The additional item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The additional item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The additional item's updated at. + description: The date the item was updated. BaseFulfillmentProvider: type: object - description: The shipping option's provider. + description: The fulfillment provider's details. x-schemaName: BaseFulfillmentProvider required: - id @@ -17614,22 +17927,369 @@ components: is_enabled: type: boolean title: is_enabled - description: The provider's is enabled. + description: Whether the provider is enabled. BaseLineItemAdjustment: type: object - description: The adjustment's adjustments. + description: The adjustment's details. x-schemaName: BaseLineItemAdjustment + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the cart this adjustment belongs to. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at BaseLineItemTaxLine: type: object - description: The tax line's tax lines. + description: The tax line's details x-schemaName: BaseLineItemTaxLine + properties: + item: + $ref: '#/components/schemas/BaseCartLineItem' + item_id: + type: string + title: item_id + description: The ID of the item the tax line applies on. + total: + type: number + title: total + description: The item's total, including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's subtotal excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the associated tax rate. + code: + type: string + title: code + description: The code the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at BaseOrder: type: object - description: The order change's order. + description: The order's details. x-schemaName: BaseOrder + 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' + fulfillments: + type: array + description: The order's fulfillments. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + sales_channel: + $ref: '#/components/schemas/AdminSalesChannel' + customer: + $ref: '#/components/schemas/AdminCustomer' + shipping_address: + $ref: '#/components/schemas/AdminOrderAddress' + billing_address: + $ref: '#/components/schemas/AdminOrderAddress' + id: + type: string + title: id + description: The order's ID. + version: + type: number + title: version + description: The order's version. + region_id: + type: string + title: region_id + description: The ID of the region associated with the order. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order is placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + display_id: + type: number + title: display_id + description: The order's display ID. + 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 + description: The order's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillment_status: + type: string + description: The order's fulfillment status. + 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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the order's items including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The total of the order's items excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the order's items excluding promotions. + item_total: + type: number + title: item_total + description: The total of the order's items including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The total of the order's items excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order's items including promotions. + original_total: + type: number + title: original_total + description: The order's total excluding promotions, including taxes. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The order's tax total, excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The order's tax total including promotions. + discount_total: + type: number + title: discount_total + description: The order's discount or promotions total. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total of order's discount or promotion. + 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 tax total of the order's gift card. + shipping_total: + type: number + title: shipping_total + description: The order's shipping total including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The tax total of the order's shipping. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The tax total of the order's shipping excluding promotions. BaseOrderAddress: type: object - description: The exchange's billing address. + description: An order address x-schemaName: BaseOrderAddress required: - id @@ -17640,215 +18300,153 @@ components: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer this address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us + country: + $ref: '#/components/schemas/AdminRegionCountry' province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. 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 - description: The order change's change type. - enum: - - return - - exchange - - claim - - edit - - return_request - 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' + description: The date the address was updated. BaseOrderChangeAction: type: object description: The action's actions. x-schemaName: BaseOrderChangeAction + properties: + order_change: + type: object + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change this action belongs to. + order_id: + type: string + title: order_id + description: The ID of the associated order. + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + title: action + description: The applied action. + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the order change action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order change action was updated. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: '#/components/schemas/BaseOrder' + required: + - order_change + - id + - order_change_id + - order_id + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at + - return_id + - claim_id + - exchange_id + - order BaseOrderFulfillment: type: object description: The fulfillment's fulfillments. @@ -17874,55 +18472,129 @@ components: location_id: type: string title: location_id - description: The fulfillment's location id. + description: The ID of the location the items are fulfilled from. packed_at: type: string title: packed_at - description: The fulfillment's packed at. + description: The date the items were packed. format: date-time shipped_at: type: string title: shipped_at - description: The fulfillment's shipped at. + description: The date the items were shipped. format: date-time delivered_at: type: string title: delivered_at - description: The fulfillment's delivered at. + description: The date the items were delivered. format: date-time canceled_at: type: string title: canceled_at - description: The fulfillment's canceled at. + description: The date the items were canceled. format: date-time data: type: object - description: The fulfillment's data. + description: Data useful for the fulfillment provider handling it. This is taken from the associated shipping option. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property provider_id: type: string title: provider_id - description: The fulfillment's provider id. + description: The ID of the fulfillment provider used to handle the fulfillment. shipping_option_id: type: string title: shipping_option_id - description: The fulfillment's shipping option id. + description: The ID of the associated shipping option. metadata: type: object - description: The fulfillment's metadata. + description: The fulfillment's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The fulfillment's created at. + description: The date the fulfillment was created. updated_at: type: string format: date-time title: updated_at - description: The fulfillment's updated at. + description: The date the fulfillment was updated. BaseOrderItemDetail: type: object description: The item's detail. x-schemaName: BaseOrderItemDetail + required: + - id + - item_id + - item + - quantity + - fulfilled_quantity + - delivered_quantity + - shipped_quantity + - return_requested_quantity + - return_received_quantity + - return_dismissed_quantity + - written_off_quantity + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: the detail's ID. + item_id: + type: string + title: id + description: the ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + delivered_quantity: + type: number + title: fulfilled_quantity + description: The item's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + return_received_quantity: + type: number + title: return_received_quantity + description: The item's quantity that's returned and added to the underlying variant's stocked quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The item's quantity that's returned but damaged. So, it's not added to the underlying variant's stocked quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed from the order. + metadata: + type: object + title: metadata + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the detail was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the detail was updated. BaseOrderLineItem: type: object description: The item's items. @@ -17982,19 +18654,19 @@ components: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The URL of the item's thumbnail. variant: $ref: '#/components/schemas/BaseProductVariant' variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated variant. product: $ref: '#/components/schemas/BaseProduct' product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -18014,7 +18686,7 @@ components: product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the collection the item's product belongs to. product_handle: type: string title: product_handle @@ -18022,7 +18694,7 @@ components: variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -18033,23 +18705,25 @@ components: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The values of the item variant's options. + example: + Color: Blue requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item is tax inclusive. compare_at_unit_price: type: number title: compare_at_unit_price - description: The item's compare at unit price. + description: The original price of the item before a promotion or sale. unit_price: type: number title: unit_price @@ -18074,78 +18748,233 @@ components: type: string format: date-time title: created_at - description: The item's created at. + description: The date the item was created. updated_at: type: string format: date-time title: updated_at - description: The item's updated at. + description: The date the item was updated. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. original_total: type: number title: original_total - description: The item's original total. + description: The item's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The item's original subtotal. + description: The item's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The item's original tax total. + description: The total taxes of the item, excluding promotions. item_total: type: number title: item_total - description: The item's item total. + description: The total taxes of the item, including promotions. item_subtotal: type: number title: item_subtotal - description: The item's item subtotal. + description: The item's total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The item's item tax total. + description: The total taxes of the item, including promotions. total: type: number title: total - description: The item's total. + description: The item's total, including taxes and promotions. subtotal: type: number title: subtotal - description: The item's subtotal. + description: The item's subtotal excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The item's tax total. + description: The tax total of the item including promotions. discount_total: type: number title: discount_total - description: The item's discount total. + description: The total discount amount of the item. discount_tax_total: type: number title: discount_tax_total - description: The item's discount tax total. + description: The total taxes applied on the discounted amount. refundable_total: type: number title: refundable_total - description: The item's refundable total. + description: The total refundable amount of the item's total. refundable_total_per_unit: type: number title: refundable_total_per_unit - description: The item's refundable total per unit. + description: The total refundable amount of the item's total for a single quantity. BaseOrderLineItemAdjustment: type: object - description: The adjustment's adjustments. + description: The adjustment's details. x-schemaName: BaseOrderLineItemAdjustment + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment applies to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion that this applies on the order's item. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at BaseOrderLineItemTaxLine: type: object description: The tax line's tax lines. x-schemaName: BaseOrderLineItemTaxLine + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the associated line item. + total: + type: number + title: total + description: The tax line's total including promotions. + subtotal: + type: number + title: subtotal + description: The tax line's subtotal excluding promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + BaseOrderShippingDetail: + type: object + description: Details of changes to a shipping method. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The ID of the new changes to the shipping method. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method. + shipping_method: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + return_id: + type: string + title: return_id + description: The ID of the associated return. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method change was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method change was updated. BaseOrderShippingMethod: type: object - description: The shipping method's shipping methods. + description: The shipping method's details. x-schemaName: BaseOrderShippingMethod required: - id @@ -18174,7 +19003,7 @@ components: order_id: type: string title: order_id - description: The shipping method's order id. + description: The ID of the order the shipping method belongs to. name: type: string title: name @@ -18190,17 +19019,19 @@ components: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping method's is tax inclusive. + description: Whether the shipping method's amount includes applied taxes. shipping_option_id: type: string title: shipping_option_id - description: The shipping method's shipping option id. + description: The ID of the shipping option this method was created from. data: type: object - description: The shipping method's data. + description: The shipping method's data, useful for fulfillment provider handling its fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping method's metadata. + description: The shipping method's metadata, can hold custom key-value pairs. tax_lines: type: array description: The shipping method's tax lines. @@ -18212,122 +19043,172 @@ components: 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' + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. 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' + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. 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' + type: number + title: original_tax_total + description: The shipping method's total taxes excluding promotions. 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' + type: number + title: total + description: The shipping method's total including taxes and promotions. 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' + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. 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' + type: number + title: tax_total + description: The shipping method's tax total including promotions. 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' + type: number + title: discount_total + description: The total discounts applied on the shipping method. 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' + type: number + title: discount_tax_total + description: The taxes applied on the discount amount. created_at: type: string format: date-time title: created_at - description: The shipping method's created at. + description: The date the shipping method was created. updated_at: type: string format: date-time title: updated_at - description: The shipping method's updated at. + description: The date the shipping method was updated. + detail: + $ref: '#/components/schemas/BaseOrderShippingDetail' BaseOrderShippingMethodAdjustment: type: object description: The adjustment's adjustments. x-schemaName: BaseOrderShippingMethodAdjustment + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment applies on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at BaseOrderShippingMethodTaxLine: type: object - description: The tax line's tax lines. + description: The tax line's details. x-schemaName: BaseOrderShippingMethodTaxLine + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider handling the tax calculation. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at BaseOrderSummary: type: object - description: The order's summary. + description: The order's summary details. x-schemaName: BaseOrderSummary required: - total @@ -18338,77 +19219,52 @@ components: - 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. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The summary's subtotal. + description: The order's total excluding taxes, including promotions. total_tax: type: number title: total_tax - description: The summary's total tax. + description: The order's total taxes. ordered_total: type: number title: ordered_total - description: The summary's ordered total. + description: The order's total when it was placed. fulfilled_total: type: number title: fulfilled_total - description: The summary's fulfilled total. + description: The total of the fulfilled items of the order. returned_total: type: number title: returned_total - description: The summary's returned total. + description: The total of the order's returned items. return_request_total: type: number title: return_request_total - description: The summary's return request total. + description: The total of the items requested to be returned. 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. + description: The total of the items removed from the order. paid_total: type: number title: paid_total - description: The summary's paid total. + description: The total amount paid. refunded_total: type: number title: refunded_total - description: The summary's refunded total. + description: The total amount refunded. BaseOrderTransaction: type: object - description: The transaction's transactions. + description: An order transaction's details. x-schemaName: BaseOrderTransaction required: - id @@ -18428,7 +19284,7 @@ components: order_id: type: string title: order_id - description: The transaction's order id. + description: The ID of the order this transaction belongs to. amount: type: number title: amount @@ -18437,34 +19293,127 @@ components: type: string title: currency_code description: The transaction's currency code. + example: usd reference: type: string title: reference - description: The transaction's reference. + description: The name of a table that this transaction references. If this transaction is for captured payment, its value is `capture`. If this transaction is for refunded payment, its value is `refund`. + enum: + - capture + - refund reference_id: type: string title: reference_id - description: The transaction's reference id. + description: The ID of the referenced record in the referenced table. metadata: type: object - description: The transaction's metadata. + description: The transaction's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The transaction's created at. + description: The date that the transaction was created. updated_at: type: string format: date-time title: updated_at - description: The transaction's updated at. + description: The date that the transaction was updated. BasePayment: type: object - description: The payment's payments. + description: The payment's details. x-schemaName: BasePayment + required: + - id + - amount + - currency_code + - provider_id + properties: + id: + type: string + title: id + description: The payment's ID. + amount: + type: number + title: amount + description: The payment's amount. + authorized_amount: + type: number + title: authorized_amount + description: The amount authorized of the payment. + currency_code: + type: string + title: currency_code + description: The payment's currency code. + provider_id: + type: string + title: provider_id + description: The ID of the payment provider used to process this payment. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + order_id: + type: string + title: order_id + description: The ID of the associated order. + order_edit_id: + type: string + title: order_edit_id + description: The ID of the associated order edit. + customer_id: + type: string + title: customer_id + description: ID of the associated customer. + data: + type: object + description: The payment's data, useful for processing by the payment provider. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment#whats-a-payment + created_at: + type: string + format: date-time + title: created_at + description: The date the payment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the payment was updated. + captured_at: + type: string + format: date-time + title: captured_at + description: The date the payment was captured. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the payment was canceled. + captured_amount: + type: number + title: captured_amount + description: The captured amount of the payment. + refunded_amount: + type: number + title: captured_amount + description: The refunded amount of the payment. + captures: + type: array + description: The details of payment captures. + items: + $ref: '#/components/schemas/BaseCapture' + refunds: + type: array + description: The details of payment refunds. + items: + $ref: '#/components/schemas/BaseRefund' + payment_collection: + type: object + payment_session: + type: object BasePaymentCollection: type: object - description: The payment collection's payment collections. + description: The payment collection's details. x-schemaName: BasePaymentCollection required: - id @@ -18485,77 +19434,41 @@ components: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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' + type: number + title: amount + description: The total amount to be paid. 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' + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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' + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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' + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -18567,7 +19480,7 @@ components: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: The payment provider used to process the collection's payments and sessions. items: $ref: '#/components/schemas/BasePaymentProvider' payment_sessions: @@ -18584,10 +19497,72 @@ components: type: object description: The payment provider's payment providers. x-schemaName: BasePaymentProvider + required: + - id + properties: + id: + type: string + title: id + description: The payment provider's ID. BasePaymentSession: type: object - description: The payment session's payment sessions. + description: The payment session's details. x-schemaName: BasePaymentSession + properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: The payment session's data, useful for the payment provider processing the payment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: '#/components/schemas/BasePayment' + required: + - id + - amount + - currency_code + - provider_id + - data + - status BaseProduct: type: object description: The parent's product. @@ -18714,7 +19689,7 @@ components: type: array description: The product's variants. items: - $ref: '#/components/schemas/BaseProductVariant' + type: object options: type: array description: The product's options. @@ -18757,34 +19732,62 @@ components: x-schemaName: BaseProductCategory BaseProductImage: type: object - description: The image's images. + description: The image's details. x-schemaName: BaseProductImage - BaseProductOption: - type: object - description: The option's options. - x-schemaName: BaseProductOption - BaseProductOptionValue: - type: object - description: The option's options. - x-schemaName: BaseProductOptionValue + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. required: - id - - value + - url + BaseProductOption: + type: object + description: The product option's details. + x-schemaName: BaseProductOption properties: id: type: string title: id description: The option's ID. - value: + title: type: string - title: value - description: The option's value. - option: - $ref: '#/components/schemas/BaseProductOption' - option_id: + title: title + description: The option's title. + product: + type: object + product_id: type: string - title: option_id - description: The option's option id. + title: product_id + description: The option's product id. + values: + type: array + description: The option's values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' metadata: type: object description: The option's metadata. @@ -18803,14 +19806,182 @@ components: format: date-time title: deleted_at description: The option's deleted at. + required: + - id + - title + BaseProductOptionValue: + type: object + description: The product option value's details. + x-schemaName: BaseProductOptionValue + required: + - id + - value + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. BaseProductTag: type: object description: The tag's tags. x-schemaName: BaseProductTag BaseProductVariant: type: object - description: The variant's variants. + description: The product variant's details. x-schemaName: BaseProductVariant + required: + - id + - title + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + - hs_code + - origin_country + - mid_code + - material + - weight + - length + - height + - width + - options + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The variant's ID. + title: + type: string + title: title + description: The variant's title. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN code. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's out of stock. + manage_inventory: + type: boolean + title: manage_inventory + description: Whether the Medusa application manages the variant's inventory quantity and availablility. If disabled, the variant is always considered in stock. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. This is only included if you pass in the `fields` query parameter a `+variants.inventory_quantity` parameter. + hs_code: + type: string + title: hs_code + description: The variant's HS code. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + mid_code: + type: string + title: mid_code + description: The variant's MID code. + material: + type: string + title: material + description: The variant's material. + 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. + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its sibling variants. + options: + type: array + description: The variant's option values. + items: + $ref: '#/components/schemas/BaseProductOptionValue' + product: + $ref: '#/components/schemas/BaseProduct' + product_id: + type: string + title: product_id + description: The ID of the product that the variant belongs to. + calculated_price: + $ref: '#/components/schemas/BaseCalculatedPriceSet' + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. BasePromotion: type: object description: The application method's promotion. @@ -18853,7 +20024,7 @@ components: $ref: '#/components/schemas/BasePromotionRuleValue' BasePromotionRuleValue: type: object - description: The value's values. + description: The rule value's details. x-schemaName: BasePromotionRuleValue required: - id @@ -18865,14 +20036,49 @@ components: value: type: string title: value - description: The value's details. + description: The value. BaseRefund: type: object - description: The refund's refunds. + description: The refund's details. x-schemaName: BaseRefund + required: + - id + - amount + - created_at + - payment + properties: + id: + type: string + title: id + description: The refund's ID. + amount: + type: number + title: amount + description: The refund's amount. + refund_reason_id: + type: string + title: refund_reason_id + description: The ID of the refund reason. + note: + type: string + title: note + description: More details about the refund. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund was created. + created_by: + type: string + title: created_by + description: The ID of the user that created the refund. + payment: + type: object + refund_reason: + $ref: '#/components/schemas/RefundReason' BaseRegion: type: object - description: The parent's region. + description: The region's details. x-schemaName: BaseRegion required: - id @@ -18920,15 +20126,41 @@ components: description: The region's updated at. BaseRegionCountry: type: object - description: The country's countries. + description: The country's details. x-schemaName: BaseRegionCountry - BaseReturnItem: - type: object - description: The item's items. - x-schemaName: BaseReturnItem + properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's iso 2. + example: us + iso_3: + type: string + title: iso_3 + description: The country's iso 3. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + example: 840 + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. + required: + - id BaseRuleOperatorOptions: type: object - description: The operator's operators. + description: The operator's details. x-schemaName: BaseRuleOperatorOptions required: - id @@ -18939,22 +20171,137 @@ components: type: string title: id description: The operator's ID. + example: in value: type: string title: value description: The operator's value. + example: in label: type: string title: label description: The operator's label. + example: In BaseShippingMethodAdjustment: type: object - description: The adjustment's adjustments. + description: The adjustment's details. x-schemaName: BaseShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method the adjustment is applied on. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. BaseShippingMethodTaxLine: type: object - description: The tax line's tax lines. + description: The tax line's details. x-schemaName: BaseShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of this shipping method the tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider that calculated the taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. CampaignResponse: type: object description: The campaign's details. @@ -19030,293 +20377,60 @@ components: description: The budget's used. CreateAddress: type: object - description: The cart's shipping address. + description: The address to create. x-schemaName: CreateAddress properties: customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. - CreateCartAddress: - type: object - description: The cart's billing address. - x-schemaName: CreateCartAddress - properties: - 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. - CreateCartCreateLineItem: - type: object - description: The item's items. - x-schemaName: CreateCartCreateLineItem - required: - - quantity - - variant_id - properties: - quantity: - type: string - title: quantity - description: The item's quantity. - variant_id: - type: string - title: variant_id - description: The item's variant 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. - 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. - is_giftcard: - type: boolean - title: is_giftcard - description: The item's is giftcard. - compare_at_unit_price: - type: string - title: compare_at_unit_price - description: The item's compare at unit price. - unit_price: - type: string - title: unit_price - description: The item's unit price. - 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 - x-schemaName: CreateOrderReturnReason - required: - - value - - label - properties: - 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. - parent_return_reason_id: - type: string - title: parent_return_reason_id - description: The return reason's parent return reason id. - metadata: - type: object - description: The return reason's metadata. + description: The address's metadata, can hold custom key-value pairs. CustomerGroupInCustomerFilters: type: object - description: The customer's groups. + description: Filter by customer groups to get their associated customers. x-schemaName: CustomerGroupInCustomerFilters required: - id @@ -19329,27 +20443,27 @@ components: oneOf: - type: string title: id - description: The group's ID. + description: Filter by a group's ID. - type: array - description: The group's ID. + description: Filter by group IDs. items: type: string title: id - description: The id's ID. + description: A group's ID. name: oneOf: - type: string title: name - description: The group's name. + description: Filter by a group's name. - type: array - description: The group's name. + description: Filter by group names. items: type: string title: name - description: The name's details. + description: A group's name. created_at: type: object - description: The group's created at. + description: Filter by the group's creation date. properties: $and: type: array @@ -19369,7 +20483,7 @@ components: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -19464,7 +20578,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). updated_at: type: object - description: The group's updated at. + description: Filter by the group's update date. properties: $and: type: array @@ -19484,7 +20598,7 @@ components: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -19579,7 +20693,7 @@ components: description: Filter by whether a value for this parameter exists (not `null`). deleted_at: type: object - description: The group's deleted at. + description: Filter by the group's deletion date. properties: $and: type: array @@ -19599,7 +20713,7 @@ components: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by exact matches. items: type: string title: $eq @@ -19726,78 +20840,13 @@ components: - unexpected_state - invalid_argument - unknown_error - File: - type: object - description: The product's file. - x-schemaName: File - required: - - lastModified - - name - - webkitRelativePath - - size - - type - - arrayBuffer - - stream - - text - properties: - lastModified: - type: number - title: lastModified - description: The file's lastmodified. - name: - type: string - title: name - description: The file's name. - webkitRelativePath: - type: string - title: webkitRelativePath - description: The file's webkitrelativepath. - size: - type: number - title: size - description: The file's size. - type: - type: string - title: type - description: The file's type. - arrayBuffer: - type: object - description: The file's arraybuffer. - slice: - type: object - description: The file's slice. - stream: - type: object - description: The file's stream. - text: - type: object - description: The file's text. - FileList: - type: object - description: SUMMARY - x-schemaName: FileList - required: - - length - - item - - __@iterator@258 - properties: - length: - type: number - title: length - description: The upload's length. - item: - type: object - description: The upload's item. - __@iterator@258: - type: object - description: The upload's @iterator@258. IBigNumber: type: object description: The shipping method's discount tax total. x-schemaName: IBigNumber InventoryLevel: type: object - description: The inventory level's inventory levels. + description: The inventory level's details x-schemaName: InventoryLevel required: - id @@ -19815,11 +20864,11 @@ components: inventory_item_id: type: string title: inventory_item_id - description: The inventory level's inventory item id. + description: The ID of the associated inventory item. location_id: type: string title: location_id - description: The inventory level's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity @@ -19838,14 +20887,307 @@ components: description: The inventory level's incoming quantity. metadata: type: object - description: The inventory level's metadata. + description: The inventory level's metadata, can hold custom key-value pairs. Order: type: object - description: The transaction's order. + description: The order change's order. x-schemaName: Order + required: + - id + - version + - status + - currency_code + - 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_subtotal + - 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's ID. + version: + type: number + title: version + description: The order's version. + order_change: + type: object + status: + type: string + description: The order's status. + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived + region_id: + type: string + title: region_id + description: The ID of the region the order belongs to. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the order was placed in. + email: + type: string + title: email + description: The email of the customer that placed the order. + format: email + currency_code: + type: string + title: currency_code + description: The order's currency code. + example: usd + shipping_address: + $ref: '#/components/schemas/OrderAddress' + billing_address: + $ref: '#/components/schemas/OrderAddress' + items: + type: array + description: The order's items. + items: + $ref: '#/components/schemas/OrderLineItem' + shipping_methods: + type: array + description: The order's shipping methods. + items: + $ref: '#/components/schemas/OrderShippingMethod' + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/OrderTransaction' + summary: + type: object + description: The order's summary. + metadata: + type: object + description: The order's metadata, can hold custom key-value pairs. + canceled_at: + type: string + format: date-time + title: canceled_at + description: The date the order was canceled. + created_at: + type: string + format: date-time + title: created_at + description: The date the order was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the order was updated. + original_item_total: + type: number + title: original_item_total + description: The order items' total including taxes, excluding promotions. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The order items' total excluding taxes, including promotions. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The taxes total for order items, excluding promotions. + item_total: + type: number + title: item_total + description: The order items' total including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The order items' total excluding taxes, including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the order items including promotions. + original_total: + type: number + title: original_total + description: The order's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The order's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order excluding promotions. + total: + type: number + title: total + description: The order's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The order's subtotal excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The tax total of the order including promotions. + discount_subtotal: + type: number + title: discount_subtotal + description: The total discount excluding taxes. + discount_total: + type: number + title: discount_total + description: The total discount including taxes. + discount_tax_total: + type: number + title: discount_tax_total + description: The tax total applied on the discount. + 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 including taxes and promotions. + shipping_subtotal: + type: number + title: shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + shipping_tax_total: + type: number + title: shipping_tax_total + description: The total taxes of the order's shipping including taxes. + original_shipping_total: + type: number + title: original_shipping_total + description: The order's shipping total including taxes, excluding promotions. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping total excluding taxes, including promotions. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The total taxes of the order's shipping excluding promotions. + raw_original_item_total: + type: object + description: The order's raw original item total. + raw_original_item_subtotal: + type: object + description: The order's raw original item subtotal. + raw_original_item_tax_total: + type: object + description: The order's raw original item tax total. + raw_item_total: + type: object + description: The order's raw item total. + raw_item_subtotal: + type: object + description: The order's raw item subtotal. + raw_item_tax_total: + type: object + description: The order's raw item tax total. + raw_original_total: + type: object + description: The order's raw original total. + raw_original_subtotal: + type: object + description: The order's raw original subtotal. + raw_original_tax_total: + type: object + description: The order's raw original tax total. + raw_total: + type: object + description: The order's raw total. + raw_subtotal: + type: object + description: The order's raw subtotal. + raw_tax_total: + type: object + description: The order's raw tax total. + raw_discount_total: + type: object + description: The order's raw discount total. + raw_discount_tax_total: + type: object + description: The order's raw discount tax total. + raw_gift_card_total: + type: object + description: The order's raw gift card total. + raw_gift_card_tax_total: + type: object + description: The order's raw gift card tax total. + raw_shipping_total: + type: object + description: The order's raw shipping total. + raw_shipping_subtotal: + type: object + description: The order's raw shipping subtotal. + raw_shipping_tax_total: + type: object + description: The order's raw shipping tax total. + raw_original_shipping_total: + type: object + description: The order's raw original shipping total. + raw_original_shipping_subtotal: + type: object + description: The order's raw original shipping subtotal. + raw_original_shipping_tax_total: + type: object + description: The order's raw original shipping tax total. OrderAddress: type: object - description: The order preview's billing address. + description: The address's details. x-schemaName: OrderAddress required: - id @@ -19855,67 +21197,68 @@ components: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The billing address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The billing address's updated at. + description: The date the address was updated. OrderChange: type: object - description: The order preview's order change. + description: The order change's details. x-schemaName: OrderChange required: - id @@ -19950,10 +21293,10 @@ components: version: type: number title: version - description: The order change's version. + description: The order change's version. This will be the order's version when the change is applied. change_type: type: string - description: The order change's change type. + description: The order change's type. enum: - return - exchange @@ -19962,23 +21305,23 @@ components: order_id: type: string title: order_id - description: The order change's order id. + description: The ID of the order this change applies on. return_id: type: string title: return_id - description: The order change's return id. + description: The ID of the associated return. exchange_id: type: string title: exchange_id - description: The order change's exchange id. + description: The ID of the associated exchange. claim_id: type: string title: claim_id - description: The order change's claim id. + description: The ID of the associated claim. order: type: object return_order: - $ref: '#/components/schemas/Return' + type: object exchange: $ref: '#/components/schemas/OrderExchange' claim: @@ -19990,111 +21333,188 @@ components: $ref: '#/components/schemas/OrderChangeAction' status: type: string - title: status description: The order change's status. + enum: + - canceled + - requested + - pending + - confirmed + - declined requested_by: type: string title: requested_by - description: The order change's requested by. + description: The ID of the user that requested the change. 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 + type: string + title: requested_at + description: The date the order change was requested. + format: date-time confirmed_by: type: string title: confirmed_by - description: The order change's confirmed by. + description: The ID of the user that confirmed the order change. 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 + type: string + title: confirmed_at + description: The date the order change was confirmed. + format: date-time declined_by: type: string title: declined_by - description: The order change's declined by. + description: The ID of the user that declined the order change. declined_reason: type: string title: declined_reason - description: The order change's declined reason. + description: The reason the order change was declined. metadata: type: object - description: The order change's metadata. + description: The order change's metadata, can hold custom key-value pairs. 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 + type: string + title: declined_at + description: The date the order change was declined. + format: date-time canceled_by: type: string title: canceled_by - description: The order change's canceled by. + description: The ID of the user that canceled the order change. 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 + type: string + title: canceled_at + description: The date the order change was canceled. + format: date-time created_at: type: string format: date-time title: created_at - description: The order change's created at. + description: The date the order change was created. updated_at: type: string format: date-time title: updated_at - description: The order change's updated at. + description: The date the order change was updated. OrderChangeAction: type: object - description: The action's actions. + description: The order change action's details. x-schemaName: OrderChangeAction + required: + - id + - order_change_id + - order_change + - order_id + - return_id + - claim_id + - exchange_id + - order + - reference + - reference_id + - action + - details + - internal_note + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The action's ID. + order_change_id: + type: string + title: order_change_id + description: The ID of the order change that the action belongs to. + order_change: + type: object + order_id: + type: string + title: order_id + description: The ID of the order the associated change is for. + return_id: + type: string + title: return_id + description: The ID of the associated return. + claim_id: + type: string + title: claim_id + description: The ID of the associated claim. + exchange_id: + type: string + title: exchange_id + description: The ID of the associated exchange. + order: + $ref: '#/components/schemas/Order' + reference: + type: string + title: reference + description: The name of the table this action applies on. + enum: + - claim + - exchange + - return + - order_shipping_method + reference_id: + type: string + title: reference_id + description: The ID of the record in the referenced table. + action: + type: string + description: The applied action. + enum: + - CANCEL_RETURN_ITEM + - FULFILL_ITEM + - DELIVER_ITEM + - CANCEL_ITEM_FULFILLMENT + - ITEM_ADD + - ITEM_REMOVE + - ITEM_UPDATE + - RECEIVE_DAMAGED_RETURN_ITEM + - RECEIVE_RETURN_ITEM + - RETURN_ITEM + - SHIPPING_ADD + - SHIPPING_REMOVE + - SHIP_ITEM + - WRITE_OFF_ITEM + - REINSTATE_ITEM + details: + type: object + description: The action's details. + example: + reference_id: 123 + quantity: 1 + internal_note: + type: string + title: internal_note + description: A note that's viewed only by admin users. + created_at: + type: string + format: date-time + title: created_at + description: The date the action was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the action was updated. 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 - OrderLineItemAdjustment: - type: object - description: The adjustment's adjustments. - x-schemaName: OrderLineItemAdjustment - OrderLineItemTaxLine: - type: object - description: The tax line's tax lines. - x-schemaName: OrderLineItemTaxLine - OrderPreview: - type: object - description: The order edit's order preview. - x-schemaName: OrderPreview required: - - order_change - - status + - order_id + - claim_items + - additional_items - currency_code - - version - 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 @@ -20117,6 +21537,1704 @@ components: - original_shipping_total - original_shipping_subtotal - original_shipping_tax_total + properties: + id: + type: string + title: id + description: The claim's ID. + order_id: + type: string + title: order_id + description: The ID of the order associated with the claim. + claim_items: + type: array + description: The order items targetted by the claim. + items: + $ref: '#/components/schemas/BaseClaimItem' + additional_items: + type: array + description: The outbound or new items of the claim. + items: + $ref: '#/components/schemas/BaseClaimItem' + return: + type: object + return_id: + type: string + title: return_id + description: The ID of the associated return. + no_notification: + type: boolean + title: no_notification + description: Whether the customer should be notified about changes in the claim. + refund_amount: + type: number + title: refund_amount + description: The amount to be refunded. + currency_code: + type: string + title: currency_code + description: The claim's currency code. + region_id: + type: string + title: region_id + description: The ID of the region associated with the claim. + customer_id: + type: string + title: customer_id + description: The ID of the customer associated with the claim's order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the claim's order is created in. + email: + type: string + title: email + description: The email associated with the claim's order. + format: email + display_id: + type: number + 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 + description: The claim's payment status. + 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 + description: The claim's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The claim's transactions. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + description: Learn more about transactions of orders and associated models. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The claim's metadata, used to store custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The claim's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The claim's update date. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the associated order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the associated order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The tax total of the original items in the associated order. + item_total: + type: number + title: item_total + description: The total of the claim's items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the claim's items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the claim's items. + original_total: + type: number + title: original_total + description: The associated order's original total. + original_subtotal: + type: number + title: original_subtotal + description: The associated order's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The associated order's original tax total. + total: + type: number + title: total + description: The associated order'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 associated order's original shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The associated order's original shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The associated order's original shipping tax total. + OrderExchange: + type: object + description: The order change's exchange. + x-schemaName: OrderExchange + 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 ID of the order the exchange is created for. + return_items: + type: array + description: The items returned (inbound) by the exchange. + items: + $ref: '#/components/schemas/AdminReturnItem' + additional_items: + type: array + description: The new items (outbound) sent by the exchange. + items: + $ref: '#/components/schemas/BaseExchangeItem' + no_notification: + type: boolean + title: no_notification + description: Whether to send the customer notifications when the exchange is updated. + difference_due: + type: number + title: difference_due + description: The amount to be exchanged or refunded. If the amount is negative, it must be refunded. If positive, additional payment is required from the customer. + return: + description: the return associated with the exchange. + $ref: '#/components/schemas/AdminReturn' + return_id: + type: string + title: return_id + description: The ID of the associated exchange. + 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 ID of the associated order's region. + customer_id: + type: string + title: customer_id + description: The ID of the customer that placed the order. + sales_channel_id: + type: string + title: sales_channel_id + description: The ID of the sales channel the associated order belongs to. + email: + type: string + title: email + description: The email used when placing the order. + format: email + display_id: + type: number + title: display_id + description: The exchange's display ID. + shipping_address: + description: The shipping address to send new items to. + $ref: '#/components/schemas/BaseOrderAddress' + billing_address: + description: The customer's billing address. + $ref: '#/components/schemas/BaseOrderAddress' + shipping_methods: + type: array + description: The shipping methods used to send the new (outbound) items. + items: + $ref: '#/components/schemas/BaseOrderShippingMethod' + payment_collections: + type: array + description: The exchange's payment collections. + items: + $ref: '#/components/schemas/BasePaymentCollection' + payment_status: + type: string + description: The exchange's payment status. + enum: + - canceled + - not_paid + - awaiting + - authorized + - partially_authorized + - captured + - partially_captured + - partially_refunded + - refunded + - requires_action + fulfillments: + type: array + description: The exchange's fulfillments of new (outbound) items. + items: + $ref: '#/components/schemas/BaseOrderFulfillment' + fulfillment_status: + type: string + description: The exchange's fulfillment status. + enum: + - canceled + - not_fulfilled + - partially_fulfilled + - fulfilled + - partially_shipped + - shipped + - partially_delivered + - delivered + transactions: + type: array + description: The exchange's transactions. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/transactions + items: + $ref: '#/components/schemas/BaseOrderTransaction' + summary: + description: The totals summary of the exchange. + $ref: '#/components/schemas/BaseOrderSummary' + metadata: + type: object + description: The exchange's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date that the exchange was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date that the exchange was updated. + original_item_total: + type: number + title: original_item_total + description: The total of the original items in the order. + original_item_subtotal: + type: number + title: original_item_subtotal + description: The subtotal of the original items in the order. + original_item_tax_total: + type: number + title: original_item_tax_total + description: The total tax of the original items in the order. + item_total: + type: number + title: item_total + description: The total of the exchange's new items. + item_subtotal: + type: number + title: item_subtotal + description: The subtotal of the exchange's new items. + item_tax_total: + type: number + title: item_tax_total + description: The tax total of the exchange's new items. + original_total: + type: number + title: original_total + description: The total of the order. + original_subtotal: + type: number + title: original_subtotal + description: The subtotal of the order. + original_tax_total: + type: number + title: original_tax_total + description: The tax total of the order. + total: + type: number + title: total + description: The total of the exchange. + subtotal: + type: number + title: subtotal + description: The subtotal of the exchange. + tax_total: + type: number + title: tax_total + description: The tax total of the exchange. + discount_total: + type: number + title: discount_total + description: The discount total of the exchange. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on discount of the exchange. + gift_card_total: + type: number + title: gift_card_total + description: The gift cards total of the exchange. + gift_card_tax_total: + type: number + title: gift_card_tax_total + description: The total taxes on the gift card of the exchange. + 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 order's shipping total. + original_shipping_subtotal: + type: number + title: original_shipping_subtotal + description: The order's shipping subtotal. + original_shipping_tax_total: + type: number + title: original_shipping_tax_total + description: The order's shipping tax total. + OrderItem: + type: object + description: The order item's detail. + x-schemaName: OrderItem + required: + - id + - item_id + - item + - quantity + - raw_quantity + - fulfilled_quantity + - raw_fulfilled_quantity + - delivered_quantity + - raw_delivered_quantity + - shipped_quantity + - raw_shipped_quantity + - return_requested_quantity + - raw_return_requested_quantity + - return_received_quantity + - raw_return_received_quantity + - return_dismissed_quantity + - raw_return_dismissed_quantity + - written_off_quantity + - raw_written_off_quantity + - metadata + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The item's ID. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + item: + type: object + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The item's fulfilled quantity. + raw_fulfilled_quantity: + type: object + description: The item's raw fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The item's delivered quantity. + raw_delivered_quantity: + type: object + description: The item's raw delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The item's shipped quantity. + raw_shipped_quantity: + type: object + description: The item's raw shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The item's quantity that's requested to be returned. + raw_return_requested_quantity: + type: object + description: The item's raw return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The item's quantity that's received through a return. + raw_return_received_quantity: + type: object + description: The item's raw return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The item's quantity that's returned but dismissed because it's damaged. + raw_return_dismissed_quantity: + type: object + description: The item's raw return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The item's quantity that's removed due to an order change. + raw_written_off_quantity: + type: object + description: The item's raw written off quantity. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + OrderLineItem: + type: object + description: The order line item's details. + 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 URL. + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product_id: + type: string + title: product_id + description: The ID of the associated product. + 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 ID of the associated product's type. + product_collection: + type: string + title: product_collection + description: The ID of the associated product's 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 associated variant's values for the associated product's options. + example: + Color: Red + requires_shipping: + type: boolean + title: requires_shipping + description: Whether the item requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: Whether the item is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the item's price includes taxes. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. + raw_compare_at_unit_price: + type: object + description: The item's raw compare at unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw compare at unit price's value. + - type: number + title: value + description: The raw compare at unit price's value. + unit_price: + type: number + title: unit_price + description: The item's price for a single quantity. + raw_unit_price: + type: object + description: The item's raw unit price. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw unit price's value. + - type: number + title: value + description: The raw unit price's value. + quantity: + type: number + title: quantity + description: The item's quantity. + raw_quantity: + type: object + description: The item's raw quantity. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw quantity's value. + - type: number + title: value + description: The raw quantity's value. + tax_lines: + type: array + description: The item's tax lines. + items: + $ref: '#/components/schemas/OrderLineItemTaxLine' + adjustments: + type: array + description: The item's adjustments. + items: + $ref: '#/components/schemas/OrderLineItemAdjustment' + detail: + $ref: '#/components/schemas/OrderItem' + created_at: + type: string + format: date-time + title: created_at + description: The date the item was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the item was updated. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + original_total: + type: number + title: original_total + description: The item's total including taxes and promotions. + original_subtotal: + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. + item_total: + type: number + title: item_total + description: The item's total for a single quantity, including taxes and promotions. + item_subtotal: + type: number + title: item_subtotal + description: The item's total for a single quantity, excluding taxes and including promotions. + item_tax_total: + type: number + title: item_tax_total + description: The total taxes of a single quantity of the item, including promotions. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the item, including promotions. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes on the discounted amount. + refundable_total: + type: number + title: refundable_total + description: The total amount of the item that can be refunded. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The total amount that can be refunded of a single quantity of the item. + raw_original_total: + type: object + description: The item'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 item'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 item'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_item_total: + type: object + description: The item'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 item'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 item'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_total: + type: object + description: The item'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 item'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 item'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 item'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 item'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_refundable_total: + type: object + description: The item's raw refundable total. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total's value. + - type: number + title: value + description: The raw refundable total's value. + raw_refundable_total_per_unit: + type: object + description: The item's raw refundable total per unit. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw refundable total per unit's value. + - type: number + title: value + description: The raw refundable total per unit's value. + OrderLineItemAdjustment: + type: object + description: The line item adjustment's details. + x-schemaName: OrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the item this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion applied by this adjustment. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + OrderLineItemTaxLine: + type: object + description: The line item tax line's details. + x-schemaName: OrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + item_id: + type: string + title: item_id + description: The ID of the line item that the tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax lines. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + OrderReturnItem: + type: object + description: The item's items. + x-schemaName: OrderReturnItem + required: + - id + - quantity + - received_quantity + - damaged_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 received quantity of the item. This quantity is added to the stocked inventory quantity of the item. + damaged_quantity: + type: number + title: damaged_quantity + description: The received damaged quantity of the item, which isn't added to the stocked inventory quantity of the item. + reason_id: + type: string + title: reason_id + description: The ID of the return reason associated with the item. + note: + type: string + title: note + description: A note about why the item was returned. + item_id: + type: string + title: item_id + description: The ID of the associated order item. + return_id: + type: string + title: return_id + description: The ID of the return this return item belongs to. + metadata: + type: object + description: The return item's metadata, can hold custom key-value pairs. + OrderShippingMethod: + type: object + description: The shipping method's details. + 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 ID of the order that the shipping method belongs to. + 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. + raw_amount: + type: object + description: The shipping method's raw amount. + required: + - value + properties: + value: + oneOf: + - type: string + title: value + description: The raw amount's value. + - type: number + title: value + description: The raw amount's value. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: Whether the shipping method's amount includes taxes. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: The shipping method's data, useful for the fulfillment provider handling the fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + 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 date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's subtotal excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes of the shipping method excluding promotions. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes of the shipping method, including promotions. + discount_total: + type: number + title: discount_total + description: The shipping method's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The total taxes of the discount amount. + raw_original_total: + type: object + description: The shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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 shipping method'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. + OrderShippingMethodAdjustment: + type: object + description: The shipping method adjustment's details. + x-schemaName: OrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this adjustment is for. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + order_id: + type: string + title: order_id + description: The ID of the associated order. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the promotion this adjustment applies. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + OrderShippingMethodTaxLine: + type: object + description: The shipping method tax line's details. + x-schemaName: OrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - raw_total + - raw_subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method that this tax line is for. + total: + type: number + title: total + description: The shipping method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total excluding taxes, including promotions. + raw_total: + type: object + description: The tax line's raw total. + raw_subtotal: + type: object + description: The tax line's raw subtotal. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The rate to charge. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate taxes. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + OrderTransaction: + type: object + description: The transaction's details. + x-schemaName: OrderTransaction + 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 ID of the order this transaction belongs to. + amount: + type: number + title: amount + description: The transaction's amount. + currency_code: + type: string + title: currency_code + description: The transaction's currency code. + example: usd + reference: + type: string + title: reference + description: The name of a table that this transaction references. If this transaction is for captured payment, its value is `capture`. If this transaction is for refunded payment, its value is `refund`. + enum: + - capture + - refund + reference_id: + type: string + title: reference_id + description: The ID of the referenced record in the referenced table. + metadata: + type: object + description: The transaction's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date that the transaction was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date that the transaction was updated. + RefundReason: + type: object + description: The refund reason's details. + x-schemaName: RefundReason + 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, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the refund reason was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the refund reason was updated. + RefundReasonResponse: + type: object + description: The refund reason's details. + x-schemaName: RefundReasonResponse + required: + - refund_reason + properties: + refund_reason: + $ref: '#/components/schemas/AdminRefundReason' + Return: + type: object + description: The return's details. + x-schemaName: Return + required: + - id + - status + - order_id + - items + - currency_code + - 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 + - discount_subtotal - raw_original_item_total - raw_original_item_subtotal - raw_original_item_tax_total @@ -20140,1660 +23258,251 @@ components: - raw_original_shipping_subtotal - raw_original_shipping_tax_total properties: - order_change: - $ref: '#/components/schemas/OrderChange' - items: - type: array - description: The order preview's items. - items: - allOf: - - type: object - description: The item's items. - x-schemaName: OrderLineItem - required: - - id - - title - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - - raw_unit_price - - quantity - - raw_quantity - - detail - - created_at - - updated_at - - original_total - - original_subtotal - - original_tax_total - - item_total - - item_subtotal - - item_tax_total - - total - - subtotal - - tax_total - - discount_total - - discount_tax_total - - refundable_total - - refundable_total_per_unit - - raw_original_total - - raw_original_subtotal - - raw_original_tax_total - - raw_item_total - - raw_item_subtotal - - raw_item_tax_total - - raw_total - - raw_subtotal - - raw_tax_total - - raw_discount_total - - raw_discount_tax_total - - raw_refundable_total - - raw_refundable_total_per_unit - properties: - id: - type: string - title: id - description: The item's ID. - title: - type: string - title: title - description: The item's title. - subtitle: - type: string - title: subtitle - description: The item's subtitle. - thumbnail: - type: string - title: thumbnail - description: The item's thumbnail. - variant_id: - type: string - title: variant_id - description: The item's variant id. - product_id: - type: string - title: product_id - description: The item's product id. - product_title: - type: string - title: product_title - description: The item's product title. - product_description: - type: string - title: product_description - description: The item's product description. - product_subtitle: - type: string - title: product_subtitle - description: The item's product subtitle. - product_type: - type: string - title: product_type - description: The item's product type. - product_collection: - type: string - title: product_collection - description: The item's product collection. - product_handle: - type: string - title: product_handle - description: The item's product handle. - variant_sku: - type: string - title: variant_sku - description: The item's variant sku. - variant_barcode: - type: string - title: variant_barcode - description: The item's variant barcode. - variant_title: - type: string - title: variant_title - description: The item's variant title. - variant_option_values: - type: object - description: The item's variant option values. - requires_shipping: - type: boolean - title: requires_shipping - description: The item's requires shipping. - is_discountable: - type: boolean - title: is_discountable - description: The item's is discountable. - is_tax_inclusive: - type: boolean - title: is_tax_inclusive - description: The item's is tax inclusive. - compare_at_unit_price: - type: number - title: compare_at_unit_price - description: The item's compare at unit price. - raw_compare_at_unit_price: - type: object - description: The item's raw compare at unit price. - unit_price: - type: number - title: unit_price - description: The item's unit price. - raw_unit_price: - type: object - description: The item's raw unit price. - quantity: - type: number - title: quantity - description: The item's quantity. - raw_quantity: - type: object - description: The item's raw quantity. - tax_lines: - type: array - description: The item's tax lines. - items: - $ref: '#/components/schemas/OrderLineItemTaxLine' - adjustments: - type: array - description: The item's adjustments. - items: - $ref: '#/components/schemas/OrderLineItemAdjustment' - detail: - $ref: '#/components/schemas/OrderItem' - created_at: - type: string - format: date-time - title: created_at - description: The item's created at. - updated_at: - type: string - format: date-time - title: updated_at - description: The item's updated at. - metadata: - type: object - description: The item's metadata. - original_total: - oneOf: - - type: string - title: original_total - description: The item's original total. - - type: number - title: original_total - description: The item's original total. - - type: string - title: original_total - description: The item's original total. - - $ref: '#/components/schemas/IBigNumber' - original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The item's original subtotal. - - type: number - title: original_subtotal - description: The item's original subtotal. - - type: string - title: original_subtotal - description: The item's original subtotal. - - $ref: '#/components/schemas/IBigNumber' - original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The item's original tax total. - - type: number - title: original_tax_total - description: The item's original tax total. - - type: string - title: original_tax_total - description: The item's original tax total. - - $ref: '#/components/schemas/IBigNumber' - item_total: - oneOf: - - type: string - title: item_total - description: The item's item total. - - type: number - title: item_total - description: The item's item total. - - type: string - title: item_total - description: The item's item total. - - $ref: '#/components/schemas/IBigNumber' - item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The item's item subtotal. - - type: number - title: item_subtotal - description: The item's item subtotal. - - type: string - title: item_subtotal - description: The item's item subtotal. - - $ref: '#/components/schemas/IBigNumber' - item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The item's item tax total. - - type: number - title: item_tax_total - description: The item's item tax total. - - type: string - title: item_tax_total - description: The item's item tax total. - - $ref: '#/components/schemas/IBigNumber' - total: - oneOf: - - type: string - title: total - description: The item's total. - - type: number - title: total - description: The item's total. - - type: string - title: total - description: The item's total. - - $ref: '#/components/schemas/IBigNumber' - subtotal: - oneOf: - - type: string - title: subtotal - description: The item's subtotal. - - type: number - title: subtotal - description: The item's subtotal. - - type: string - title: subtotal - description: The item's subtotal. - - $ref: '#/components/schemas/IBigNumber' - tax_total: - oneOf: - - type: string - title: tax_total - description: The item's tax total. - - type: number - title: tax_total - description: The item's tax total. - - type: string - title: tax_total - description: The item's tax total. - - $ref: '#/components/schemas/IBigNumber' - discount_total: - oneOf: - - type: string - title: discount_total - description: The item's discount total. - - type: number - title: discount_total - description: The item's discount total. - - type: string - title: discount_total - description: The item's discount total. - - $ref: '#/components/schemas/IBigNumber' - discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The item's discount tax total. - - type: number - title: discount_tax_total - description: The item's discount tax total. - - type: string - title: discount_tax_total - description: The item's discount tax total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total: - oneOf: - - type: string - title: refundable_total - description: The item's refundable total. - - type: number - title: refundable_total - description: The item's refundable total. - - type: string - title: refundable_total - description: The item's refundable total. - - $ref: '#/components/schemas/IBigNumber' - refundable_total_per_unit: - oneOf: - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: number - title: refundable_total_per_unit - description: The item's refundable total per unit. - - type: string - title: refundable_total_per_unit - description: The item's refundable total per unit. - - $ref: '#/components/schemas/IBigNumber' - raw_original_total: - type: object - description: The item's raw original total. - raw_original_subtotal: - type: object - description: The item's raw original subtotal. - raw_original_tax_total: - type: object - description: The item's raw original tax total. - raw_item_total: - type: object - description: The item's raw item total. - raw_item_subtotal: - type: object - description: The item's raw item subtotal. - raw_item_tax_total: - type: object - description: The item's raw item tax total. - raw_total: - type: object - description: The item's raw total. - raw_subtotal: - type: object - description: The item's raw subtotal. - raw_tax_total: - type: object - description: The item's raw tax total. - raw_discount_total: - type: object - description: The item's raw discount total. - raw_discount_tax_total: - type: object - description: The item's raw discount tax total. - raw_refundable_total: - type: object - description: The item's raw refundable total. - raw_refundable_total_per_unit: - type: object - description: The item's raw refundable total per unit. - - 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: OrderChangeAction - shipping_methods: - type: array - description: The order preview's shipping methods. - items: - allOf: - - 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. - - 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: OrderChangeAction - status: - type: string - description: The order preview's status. - enum: - - canceled - - requires_action - - pending - - completed - - draft - - archived - currency_code: - type: string - title: currency_code - description: The order preview's currency code. - version: - type: number - title: version - description: The order preview's version. id: type: string title: id - description: The order preview's ID. + description: The return's ID. + status: + type: string + description: The return's status. + enum: + - canceled + - requested + - received + - partially_received + refund_amount: + type: number + title: refund_amount + description: The amount refunded by this return. + order_id: + type: string + title: order_id + description: The ID of the associated order. + items: + type: array + description: The return's items. + items: + $ref: '#/components/schemas/OrderReturnItem' region_id: type: string title: region_id - description: The order preview's region id. + description: The ID of the region this return belongs to. customer_id: type: string title: customer_id - description: The order preview's customer id. + description: The ID of the customer that placed the order. sales_channel_id: type: string title: sales_channel_id - description: The order preview's sales channel id. + description: The ID of the associated order's sales channel. email: type: string title: email - description: The order preview's email. + description: The email of the customer that placed the order. format: email + currency_code: + type: string + title: currency_code + description: The return's currency code. + example: usd shipping_address: $ref: '#/components/schemas/OrderAddress' billing_address: $ref: '#/components/schemas/OrderAddress' + shipping_methods: + type: array + description: The return's shipping methods. + items: + $ref: '#/components/schemas/OrderShippingMethod' transactions: type: array - description: The order preview's transactions. + description: The return'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 - - pending_difference - - raw_pending_difference - 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 - pending_difference: - oneOf: - - type: string - title: pending_difference - description: The summary's pending difference. - - type: number - title: pending_difference - description: The summary's pending difference. - - type: string - title: pending_difference - description: The summary's pending difference. - - type: object - description: The summary's pending difference. - x-schemaName: IBigNumber - raw_pending_difference: - type: object - description: The summary's raw pending difference. + description: The return's summary. metadata: type: object - description: The order preview's metadata. + description: The return's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The order preview's created at. + description: The date the return was created. updated_at: type: string format: date-time title: updated_at - description: The order preview's updated at. + description: The date the return was updated. 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' + type: number + title: original_item_total + description: The return's original item total. 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' + type: number + title: original_item_subtotal + description: The return's original item subtotal. 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' + type: number + title: original_item_tax_total + description: The return's original item tax total. 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' + type: number + title: item_total + description: The return's item total. 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' + type: number + title: item_subtotal + description: The return's item subtotal. 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' + type: number + title: item_tax_total + description: The return's item tax total. 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' + type: number + title: original_total + description: The return's original total. 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' + type: number + title: original_subtotal + description: The return's original subtotal. 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' + type: number + title: original_tax_total + description: The return's original tax total. 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' + type: number + title: total + description: The return's total. 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' + type: number + title: subtotal + description: The return's subtotal. 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' + type: number + title: tax_total + description: The return's tax total. 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' + type: number + title: discount_total + description: The return's discount total. 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' + type: number + title: discount_tax_total + description: The return's discount tax total. 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' + type: number + title: gift_card_total + description: The return's gift card total. 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' + type: number + title: gift_card_tax_total + description: The return's gift card tax total. 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' + type: number + title: shipping_total + description: The return's shipping total. 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' + type: number + title: shipping_subtotal + description: The return's shipping subtotal. 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' + type: number + title: shipping_tax_total + description: The return's shipping tax total. 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' + type: number + title: original_shipping_total + description: The return's original shipping total. 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' + type: number + title: original_shipping_subtotal + description: The return's original shipping subtotal. 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' + type: number + title: original_shipping_tax_total + description: The return's original shipping tax total. + order_change: + $ref: '#/components/schemas/OrderChange' 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 + type: string + title: canceled_at + description: The date the return was canceled. + format: date-time + discount_subtotal: + type: number + title: discount_subtotal + description: The return's discount subtotal. 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. + description: The return's raw original item total. 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. + description: The return's raw original item subtotal. 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. + description: The return's raw original item tax total. 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. + description: The return's raw item total. 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. + description: The return's raw item subtotal. 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. + description: The return's raw item tax total. 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. + description: The return's raw original total. 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. + description: The return's raw original subtotal. 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. + description: The return's raw original tax total. 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. + description: The return's raw total. 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. + description: The return's raw subtotal. 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. + description: The return's raw tax total. 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. + description: The return's raw discount total. 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. + description: The return's raw discount tax total. 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. + description: The return's raw gift card total. 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. + description: The return's raw gift card tax total. 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. + description: The return's raw shipping total. 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. + description: The return's raw shipping subtotal. 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. + description: The return's raw shipping tax total. 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. + description: The return's raw original shipping total. 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. + description: The return's raw original shipping subtotal. 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. - 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 + description: The return's raw original shipping tax total. StoreAddCartLineItem: type: object - description: SUMMARY + description: The details of the line item to add. x-schemaName: StoreAddCartLineItem required: - variant_id @@ -21802,30 +23511,21 @@ components: variant_id: type: string title: variant_id - description: The cart's variant id. + description: The ID of the product variant to add to the cart. quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. - StoreCalculateCartTaxes: - type: object - description: SUMMARY - x-schemaName: StoreCalculateCartTaxes - properties: - fields: - type: string - title: fields - description: The cart's fields. + description: The item's metadata, can hold custom key-value pairs. StoreCart: type: object - description: The cart's parent. + description: The cart's details. x-schemaName: StoreCart required: - - id - currency_code + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -21852,326 +23552,151 @@ components: id: type: string title: id - description: The parent's ID. + description: The cart's ID. region: - $ref: '#/components/schemas/BaseRegion' + $ref: '#/components/schemas/StoreRegion' region_id: type: string title: region_id - description: The parent's region id. + description: The ID of the region the cart belongs to. customer_id: type: string title: customer_id - description: The parent's customer id. + description: The ID of the customer the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The parent's sales channel id. + description: The ID of the cart's sales channel. Only products that belong to the same sales channel can be added to the cart. The created order will be associated with the same sales channel. email: type: string title: email - description: The parent's email. + description: The email of the customer the cart belongs to. format: email currency_code: type: string title: currency_code - description: The parent's currency code. + description: The cart's currency code. + example: usd shipping_address: - $ref: '#/components/schemas/BaseCartAddress' + $ref: '#/components/schemas/StoreCartAddress' billing_address: - $ref: '#/components/schemas/BaseCartAddress' + $ref: '#/components/schemas/StoreCartAddress' items: type: array - description: The parent's items. + description: The cart's items. items: - $ref: '#/components/schemas/BaseCartLineItem' + $ref: '#/components/schemas/StoreCartLineItem' shipping_methods: type: array - description: The parent's shipping methods. + description: The cart's shipping methods. items: - $ref: '#/components/schemas/BaseCartShippingMethod' + $ref: '#/components/schemas/StoreCartShippingMethod' payment_collection: - $ref: '#/components/schemas/BasePaymentCollection' + $ref: '#/components/schemas/StorePaymentCollection' metadata: type: object - description: The parent's metadata. + description: The cart's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the cart was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the cart was updated. original_item_total: - oneOf: - - type: string - title: original_item_total - description: The parent's original item total. - - type: number - title: original_item_total - description: The parent's original item total. - - type: string - title: original_item_total - description: The parent's original item total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_item_total + description: The cart items' total including taxes, excluding promotions. original_item_subtotal: - oneOf: - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - type: number - title: original_item_subtotal - description: The parent's original item subtotal. - - type: string - title: original_item_subtotal - description: The parent's original item subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_item_subtotal + description: The cart items' total excluding taxes, including promotions. original_item_tax_total: - oneOf: - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - type: number - title: original_item_tax_total - description: The parent's original item tax total. - - type: string - title: original_item_tax_total - description: The parent's original item tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_item_tax_total + description: The cart items' tax total excluding promotions. item_total: - oneOf: - - type: string - title: item_total - description: The parent's item total. - - type: number - title: item_total - description: The parent's item total. - - type: string - title: item_total - description: The parent's item total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: item_total + description: The cart items' total including taxes and promotions. item_subtotal: - oneOf: - - type: string - title: item_subtotal - description: The parent's item subtotal. - - type: number - title: item_subtotal - description: The parent's item subtotal. - - type: string - title: item_subtotal - description: The parent's item subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: item_subtotal + description: The cart items' total excluding taxes, including promotions. item_tax_total: - oneOf: - - type: string - title: item_tax_total - description: The parent's item tax total. - - type: number - title: item_tax_total - description: The parent's item tax total. - - type: string - title: item_tax_total - description: The parent's item tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: item_tax_total + description: The cart items' tax total including promotions. original_total: - oneOf: - - type: string - title: original_total - description: The parent's original total. - - type: number - title: original_total - description: The parent's original total. - - type: string - title: original_total - description: The parent's original total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_total + description: The cart's total including taxes, excluding promotions. original_subtotal: - oneOf: - - type: string - title: original_subtotal - description: The parent's original subtotal. - - type: number - title: original_subtotal - description: The parent's original subtotal. - - type: string - title: original_subtotal - description: The parent's original subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_subtotal + description: The cart's total excluding taxes, including promotions. original_tax_total: - oneOf: - - type: string - title: original_tax_total - description: The parent's original tax total. - - type: number - title: original_tax_total - description: The parent's original tax total. - - type: string - title: original_tax_total - description: The parent's original tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_tax_total + description: The cart's tax total excluding promotions. total: - oneOf: - - type: string - title: total - description: The parent's total. - - type: number - title: total - description: The parent's total. - - type: string - title: total - description: The parent's total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: total + description: The cart's total including taxes and promotions. subtotal: - oneOf: - - type: string - title: subtotal - description: The parent's subtotal. - - type: number - title: subtotal - description: The parent's subtotal. - - type: string - title: subtotal - description: The parent's subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: subtotal + description: The cart's total excluding taxes, including promotions. tax_total: - oneOf: - - type: string - title: tax_total - description: The parent's tax total. - - type: number - title: tax_total - description: The parent's tax total. - - type: string - title: tax_total - description: The parent's tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: tax_total + description: The cart's tax total including promotions. discount_total: - oneOf: - - type: string - title: discount_total - description: The parent's discount total. - - type: number - title: discount_total - description: The parent's discount total. - - type: string - title: discount_total - description: The parent's discount total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: discount_total + description: The cart's discount total. discount_tax_total: - oneOf: - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - type: number - title: discount_tax_total - description: The parent's discount tax total. - - type: string - title: discount_tax_total - description: The parent's discount tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: discount_tax_total + description: The tax total applied on the discounted amount. gift_card_total: - oneOf: - - type: string - title: gift_card_total - description: The parent's gift card total. - - type: number - title: gift_card_total - description: The parent's gift card total. - - type: string - title: gift_card_total - description: The parent's gift card total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: gift_card_total + description: The total gift card amount applied on the cart. gift_card_tax_total: - oneOf: - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: number - title: gift_card_tax_total - description: The parent's gift card tax total. - - type: string - title: gift_card_tax_total - description: The parent's gift card tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: gift_card_tax_total + description: The total taxes applied on the gift card amount. shipping_total: - oneOf: - - type: string - title: shipping_total - description: The parent's shipping total. - - type: number - title: shipping_total - description: The parent's shipping total. - - type: string - title: shipping_total - description: The parent's shipping total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: shipping_total + description: The cart's shipping total including taxes and promotions. shipping_subtotal: - oneOf: - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: number - title: shipping_subtotal - description: The parent's shipping subtotal. - - type: string - title: shipping_subtotal - description: The parent's shipping subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. shipping_tax_total: - oneOf: - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - type: number - title: shipping_tax_total - description: The parent's shipping tax total. - - type: string - title: shipping_tax_total - description: The parent's shipping tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: shipping_tax_total + description: The total taxes applied on the cart's shipping amount. original_shipping_total: - oneOf: - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - type: number - title: original_shipping_total - description: The parent's original shipping total. - - type: string - title: original_shipping_total - description: The parent's original shipping total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_shipping_total + description: The cart's shipping total including taxes, excluding promotions. original_shipping_subtotal: - oneOf: - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: number - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - type: string - title: original_shipping_subtotal - description: The parent's original shipping subtotal. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_shipping_subtotal + description: The cart's shipping total excluding taxes, including promotions. original_shipping_tax_total: - oneOf: - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: number - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - type: string - title: original_shipping_tax_total - description: The parent's original shipping tax total. - - $ref: '#/components/schemas/IBigNumber' + type: number + title: original_shipping_tax_total + description: The total taxes applied on the cart's shipping amount. StoreCartAddress: type: object - description: The cart's billing address. + description: The address's details. x-schemaName: StoreCartAddress required: - id @@ -22181,97 +23706,90 @@ components: id: type: string title: id - description: The billing address's ID. + description: The address's ID. customer_id: type: string title: customer_id - description: The billing address's customer id. + description: The ID of the customer the address belongs to. first_name: type: string title: first_name - description: The billing address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The billing address's last name. + description: The address's last name. phone: type: string title: phone - description: The billing address's phone. + description: The address's phone. company: type: string title: company - description: The billing address's company. + description: The address's company. address_1: type: string title: address_1 - description: The billing address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The address's second line. city: type: string title: city - description: The billing address's city. + description: The address's city. country_code: type: string title: country_code - description: The billing address's country code. + description: The address's country code. + example: us province: type: string title: province - description: The billing address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The billing address's postal code. + description: The address's postal code. metadata: type: object - description: The billing address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: - oneOf: - - type: string - title: created_at - description: The billing address's created at. - - type: string - title: created_at - description: The billing address's created at. - format: date-time + type: string + title: created_at + description: The date the address was created. + format: date-time updated_at: - oneOf: - - type: string - title: updated_at - description: The billing address's updated at. - - type: string - title: updated_at - description: The billing address's updated at. - format: date-time + type: string + title: updated_at + description: The date the address was updated. + format: date-time StoreCartLineItem: type: object - description: The item's items. + description: The item's details. x-schemaName: StoreCartLineItem required: - - id - - title - - quantity - - requires_shipping - - is_discountable - - is_tax_inclusive - - unit_price - cart - - cart_id - - original_total - - original_subtotal - - original_tax_total + - title + - id - item_total - item_subtotal - item_tax_total + - original_total + - original_subtotal + - original_tax_total - total - subtotal - tax_total - discount_total - discount_tax_total + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - cart_id properties: id: type: string @@ -22288,25 +23806,17 @@ components: thumbnail: type: string title: thumbnail - description: The item's thumbnail. + description: The item's thumbnail URL. 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' + type: number + title: quantity + description: The item's quantity. product: - $ref: '#/components/schemas/BaseProduct' + $ref: '#/components/schemas/StoreProduct' product_id: type: string title: product_id - description: The item's product id. + description: The ID of the associated product. product_title: type: string title: product_title @@ -22322,25 +23832,25 @@ components: product_type: type: string title: product_type - description: The item's product type. + description: The ID of the associated product's type. product_collection: type: string title: product_collection - description: The item's product collection. + description: The ID of the associated product's collection. product_handle: type: string title: product_handle description: The item's product handle. variant: - $ref: '#/components/schemas/BaseProductVariant' + $ref: '#/components/schemas/StoreProductVariant' variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. variant_sku: type: string title: variant_sku - description: The item's variant sku. + description: The item's variant SKU. variant_barcode: type: string title: variant_barcode @@ -22351,230 +23861,517 @@ components: description: The item's variant title. variant_option_values: type: object - description: The item's variant option values. + description: The associated variant's value for the product's options. + example: + Color: Red requires_shipping: type: boolean title: requires_shipping - description: The item's requires shipping. + description: Whether the item requires shipping. is_discountable: type: boolean title: is_discountable - description: The item's is discountable. + description: Whether the item is discountable. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The item's is tax inclusive. + description: Whether the item's price includes taxes. 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' + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. 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' + type: number + title: unit_price + description: The price of a single quantity of the item. tax_lines: type: array description: The item's tax lines. items: - $ref: '#/components/schemas/BaseLineItemTaxLine' + allOf: + - type: object + description: The tax line's details. + x-schemaName: BaseLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + item_id: + type: string + title: item_id + description: The ID of the line item this tax line belongs to. + total: + type: number + title: total + description: The item's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the tax line belongs to. + description: The tax line's details adjustments: type: array description: The item's adjustments. items: - $ref: '#/components/schemas/BaseLineItemAdjustment' + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseLineItemAdjustment + required: + - item + - item_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + item_id: + type: string + title: item_id + description: The ID of the item that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - item + properties: + item: + type: object + title: item + description: The details of the item that the adjustment belongs to. + description: The adjustment's details. cart: - $ref: '#/components/schemas/BaseCart' + type: object cart_id: type: string title: cart_id - description: The item's cart id. + description: The ID of the cart that the line item belongs to. metadata: type: object - description: The item's metadata. + description: The item's metadata, can hold custom key-value pairs. created_at: type: string title: created_at - description: The item's created at. + description: The date the item was created. format: date-time updated_at: type: string title: updated_at - description: The item's updated at. + description: The date the item was updated. format: date-time deleted_at: type: string title: deleted_at - description: The item's deleted at. + description: The date the item was deleted. 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' + type: number + title: original_total + description: The item's total including taxes, excluding promotions. 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' + type: number + title: original_subtotal + description: The item's total excluding taxes, including promotions. 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' + type: number + title: original_tax_total + description: The total taxes of the item excluding promotions. 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' + type: number + title: original_tax_total + description: The item's total including taxes and promotions. 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' + type: number + title: item_subtotal + description: The item's total excluding taxes, including promotions. 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' + type: number + title: item_tax_total + description: The total taxes of the item including promotions. 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' + type: number + title: total + description: The item's total including taxes and promotions. 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' + type: number + title: subtotal + description: The item's total excluding taxes, including promotions. 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' + type: number + title: tax_total + description: The total taxes of the item including promotions. 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' + type: number + title: discount_total + description: The total discount of the item. 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' + type: number + title: discount_tax_total + description: The total taxes applied on the discounted amount. StoreCartResponse: type: object - description: SUMMARY + description: The cart's details. x-schemaName: StoreCartResponse required: - cart properties: cart: $ref: '#/components/schemas/StoreCart' + StoreCartShippingMethod: + type: object + description: A cart's shipping method. + x-schemaName: StoreCartShippingMethod + 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 ID of the cart this shipping method belongs to. + 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: Whether the shipping method's amount is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the shipping option this method was created from. + data: + type: object + description: The shipping method's data, useful for fulfillment handling by third-party services. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/cart/concepts#data-property + metadata: + type: object + description: The shipping method's metadata, can hold custom key-value pairs. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's details + x-schemaName: BaseShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + shipping_method_id: + type: string + title: shipping_method_id + description: The ID of the shipping method this tax line belongs to. + total: + type: number + title: total + description: The method's total including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The method's total excluding taxes, including promotions. + id: + type: string + title: id + description: The tax line's ID. + description: + type: string + title: description + description: The tax line's description. + tax_rate_id: + type: string + title: tax_rate_id + description: The ID of the applied tax rate. + code: + type: string + title: code + description: The code that the tax rate is identified by. + rate: + type: number + title: rate + description: The charged rate. + provider_id: + type: string + title: provider_id + description: The ID of the tax provider used to calculate the tax line. + created_at: + type: string + format: date-time + title: created_at + description: The date the tax line was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tax line was updated. + - type: object + description: The tax line's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the tax line belongs to. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments, such as applied promotions. + items: + allOf: + - type: object + description: The adjustment's details. + x-schemaName: BaseShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - cart_id + - created_at + - updated_at + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + id: + type: string + title: id + description: The adjustment's ID. + code: + type: string + title: code + description: The adjustment's code. + amount: + type: number + title: amount + description: The adjustment's amount. + cart_id: + type: string + title: cart_id + description: The ID of the associated cart. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The ID of the applied promotion. + provider_id: + type: string + title: provider_id + description: The adjustment's provider ID. + created_at: + type: string + format: date-time + title: created_at + description: The date the adjustment was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the adjustment was updated. + - type: object + description: The adjustment's details. + required: + - shipping_method + properties: + shipping_method: + type: object + title: shipping_method + description: The details of the method that the adjustment belongs to. + description: The adjustment's details. + created_at: + type: string + format: date-time + title: created_at + description: The date the shipping method was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the shipping method was updated. + original_total: + type: number + title: original_total + description: The shipping method's total including taxes, excluding promotions. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's total excluding taxes, including promotions. + original_tax_total: + type: number + title: original_tax_total + description: The total taxes applied on the shipping method's amount including promotions. + total: + type: number + title: total + description: The shipping method's total amount including taxes and promotions. + subtotal: + type: number + title: subtotal + description: The shipping method's total amount excluding taxes, including promotions. + tax_total: + type: number + title: tax_total + description: The total taxes applied on the shipping method's amount including promotions. + discount_total: + type: number + title: discount_total + description: The total amount discounted. + discount_tax_total: + type: number + title: discount_tax_total + description: The taxes applied on the discounted amount. StoreCollection: type: object description: The collection's details. x-schemaName: StoreCollection required: - - id - title + - metadata + - id - handle - created_at - updated_at - deleted_at - - metadata properties: id: type: string @@ -22592,28 +24389,28 @@ components: type: string format: date-time title: created_at - description: The collection's created at. + description: The date the collection was created. updated_at: type: string format: date-time title: updated_at - description: The collection's updated at. + description: The date the collection was updated. deleted_at: type: string format: date-time title: deleted_at - description: The collection's deleted at. + description: The date the collection was deleted. products: type: array description: The collection's products. items: - $ref: '#/components/schemas/AdminProduct' + type: object metadata: type: object - description: The collection's metadata. + description: The collection's metadata, can hold custom key-value pairs. StoreCollectionResponse: type: object - description: SUMMARY + description: The collection's details. x-schemaName: StoreCollectionResponse required: - collection @@ -22622,13 +24419,13 @@ components: $ref: '#/components/schemas/StoreCollection' StoreCreateCart: type: object - description: SUMMARY + description: The details of the cart to be created. x-schemaName: StoreCreateCart properties: region_id: type: string title: region_id - description: The cart's region id. + description: The ID of the cart's region. This affects the prices and currency of the cart. shipping_address: $ref: '#/components/schemas/StoreCartAddress' billing_address: @@ -22636,12 +24433,13 @@ components: email: type: string title: email - description: The cart's email. + description: The email of the cart's customer. format: email currency_code: type: string title: currency_code - description: The cart's currency code. + description: The cart's currency code. If not provided, the region's currency is used. This affects prices in the cart, as well. + example: usd items: type: array description: The cart's items. @@ -22650,13 +24448,13 @@ components: sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The ID of the sales channel that cart is created in. Only products available in that sales channel can be added to the cart. If not provided, the store's default sales channel is associated with the cart instead. metadata: type: object - description: The cart's metadata. + description: The cart's metadata, can hold custom key-value pairs. StoreCreateCustomer: type: object - description: SUMMARY + description: The details of the customer to create. x-schemaName: StoreCreateCustomer required: - email @@ -22684,10 +24482,10 @@ components: description: The customer's phone. metadata: type: object - description: The customer's metadata. + description: The customer's metadata, can hold custom key-value pairs. StoreCreatePaymentCollection: type: object - description: SUMMARY + description: The details of the payment collection to create. x-schemaName: StoreCreatePaymentCollection required: - cart_id @@ -22695,10 +24493,10 @@ components: cart_id: type: string title: cart_id - description: The payment collection's cart id. + description: The ID of the cart this payment collection is for. StoreCreateReturn: type: object - description: SUMMARY + description: The details of the return to create. x-schemaName: StoreCreateReturn required: - order_id @@ -22708,7 +24506,7 @@ components: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. items: type: array description: The return's items. @@ -22719,18 +24517,18 @@ components: note: type: string title: note - description: The return's note. + description: A note with more details about the return. receive_now: type: boolean title: receive_now - description: The return's receive now. + description: Whether to mark the return as received. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location that items are returned to. StoreCreateReturnItem: type: object - description: The item's items. + description: The details of the line item to create. x-schemaName: StoreCreateReturnItem required: - id @@ -22747,14 +24545,14 @@ components: reason_id: type: string title: reason_id - description: The item's reason id. + description: The ID of the associated return reason. note: type: string title: note - description: The item's note. + description: A note with more details about the returned item. StoreCreateReturnShipping: type: object - description: The return's return shipping. + description: The return's shipping details. x-schemaName: StoreCreateReturnShipping required: - option_id @@ -22762,11 +24560,11 @@ components: option_id: type: string title: option_id - description: The return shipping's option id. + description: The ID of the shipping option to use. price: type: number title: price - description: The return shipping's price. + description: The shipping's price. StoreCurrency: type: object description: The currency's details. @@ -22778,7 +24576,6 @@ components: - name - decimal_digits - rounding - - raw_rounding - created_at - updated_at - deleted_at @@ -22787,6 +24584,7 @@ components: type: string title: code description: The currency's code. + example: usd symbol: type: string title: symbol @@ -22807,39 +24605,24 @@ components: 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. + description: The date the currency was created. updated_at: type: string format: date-time title: updated_at - description: The currency's updated at. + description: The date the currency was updated. deleted_at: type: string format: date-time title: deleted_at - description: The currency's deleted at. + description: The date the currency was deleted. StoreCurrencyListResponse: type: object - description: SUMMARY + description: The paginated list of currencies. x-schemaName: StoreCurrencyListResponse required: - limit @@ -22850,23 +24633,23 @@ components: limit: type: number title: limit - description: The currency's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The currency's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The currency's count. + description: The total count of items. currencies: type: array - description: The currency's currencies. + description: The list of currencies. items: $ref: '#/components/schemas/StoreCurrency' StoreCurrencyResponse: type: object - description: SUMMARY + description: The currency's details. x-schemaName: StoreCurrencyResponse required: - currency @@ -22875,81 +24658,77 @@ components: $ref: '#/components/schemas/StoreCurrency' StoreCustomer: type: object - description: The customer's parent. + description: The customer's details. x-schemaName: StoreCustomer required: + - addresses - id - email - - default_billing_address_id - - default_shipping_address_id - company_name - first_name - last_name - - addresses + - default_billing_address_id + - default_shipping_address_id properties: id: type: string title: id - description: The parent's ID. + description: The customer's ID. email: type: string title: email - description: The parent's email. + description: The customer's email. format: email default_billing_address_id: type: string title: default_billing_address_id - description: The parent's default billing address id. + description: The ID of the address used for billing by default. default_shipping_address_id: type: string title: default_shipping_address_id - description: The parent's default shipping address id. + description: The ID of the address used for shipping by default. company_name: type: string title: company_name - description: The parent's company name. + description: The customer's company name. first_name: type: string title: first_name - description: The parent's first name. + description: The customer's first name. last_name: type: string title: last_name - description: The parent's last name. + description: The customer's last name. addresses: type: array - description: The parent's addresses. + description: The customer's addresses. items: - $ref: '#/components/schemas/BaseCustomerAddress' + $ref: '#/components/schemas/StoreCustomerAddress' phone: type: string title: phone - description: The parent's phone. + description: The customer's phone. metadata: type: object - description: The parent's metadata. - created_by: - type: string - title: created_by - description: The parent's created by. - deleted_at: - type: string - format: date-time - title: deleted_at - description: The parent's deleted at. + description: The customer's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The parent's created at. + description: The date the customer was created. updated_at: type: string format: date-time title: updated_at - description: The parent's updated at. + description: The date the customer was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the customer was deleted. StoreCustomerAddress: type: object - description: The customer's address. + description: The customer address's details x-schemaName: StoreCustomerAddress required: - id @@ -22978,19 +24757,19 @@ components: address_name: type: string title: address_name - description: The address's address name. + description: The address's name. is_default_shipping: type: boolean title: is_default_shipping - description: The address's is default shipping. + description: Whether the address is used for shipping by default. is_default_billing: type: boolean title: is_default_billing - description: The address's is default billing. + description: Whether the address is used for billing by default. customer_id: type: string title: customer_id - description: The address's customer id. + description: The ID of the customer the address belongs to. company: type: string title: company @@ -23006,11 +24785,11 @@ components: address_1: type: string title: address_1 - description: The address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The address's address 2. + description: The address's second line. city: type: string title: city @@ -23019,6 +24798,7 @@ components: type: string title: country_code description: The address's country code. + example: usd province: type: string title: province @@ -23033,20 +24813,20 @@ components: description: The address's phone. metadata: type: object - description: The address's metadata. + description: The address's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The address's created at. + description: The date the address was created. updated_at: type: string format: date-time title: updated_at - description: The address's updated at. + description: The date the address was updated. StoreCustomerAddressListResponse: type: object - description: SUMMARY + description: The paginated list of customer addresses. x-schemaName: StoreCustomerAddressListResponse required: - limit @@ -23057,23 +24837,23 @@ components: limit: type: number title: limit - description: The customer's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The customer's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The customer's count. + description: The total number of items. addresses: type: array - description: The customer's addresses. + description: The list of addresses. items: $ref: '#/components/schemas/StoreCustomerAddress' StoreCustomerAddressResponse: type: object - description: SUMMARY + description: The address's details. x-schemaName: StoreCustomerAddressResponse required: - address @@ -23082,7 +24862,7 @@ components: $ref: '#/components/schemas/StoreCustomerAddress' StoreCustomerResponse: type: object - description: SUMMARY + description: The customer's details. x-schemaName: StoreCustomerResponse required: - customer @@ -23091,7 +24871,7 @@ components: $ref: '#/components/schemas/StoreCustomer' StoreOrder: type: object - description: The cart's order. + description: The order's details. x-schemaName: StoreOrder required: - id @@ -23143,28 +24923,29 @@ components: region_id: type: string title: region_id - description: The order's region id. + description: The ID of the associated region. customer_id: type: string title: customer_id - description: The order's customer id. + description: The ID of the customer that placed the order. sales_channel_id: type: string title: sales_channel_id - description: The order's sales channel id. + description: The ID of the sales channel the order was placed in. email: type: string title: email - description: The order's email. + description: The email of the customer that placed the order. format: email currency_code: type: string title: currency_code description: The order's currency code. + example: usd display_id: type: number title: display_id - description: The order's display id. + description: The order's display ID. shipping_address: $ref: '#/components/schemas/BaseOrderAddress' billing_address: @@ -23215,74 +24996,69 @@ components: - 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. + description: The order's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The order's created at. + description: The date the order was created. updated_at: type: string format: date-time title: updated_at - description: The order's updated at. + description: The date the order was updated. original_item_total: type: number title: original_item_total - description: The order's original item total. + description: The order items' total including taxes, excluding promotions. original_item_subtotal: type: number title: original_item_subtotal - description: The order's original item subtotal. + description: The order items' total excluding taxes, including promotions. original_item_tax_total: type: number title: original_item_tax_total - description: The order's original item tax total. + description: The total taxes applied on the order items, excluding promotions. item_total: type: number title: item_total - description: The order's item total. + description: The order items' total including taxes and promotions. item_subtotal: type: number title: item_subtotal - description: The order's item subtotal. + description: The order items' total excluding taxes, including promotions. item_tax_total: type: number title: item_tax_total - description: The order's item tax total. + description: The total taxes applied on the order's items, including promotions. original_total: type: number title: original_total - description: The order's original total. + description: The order's total including taxes, excluding promotions. original_subtotal: type: number title: original_subtotal - description: The order's original subtotal. + description: The order's total excluding taxes, including promotions. original_tax_total: type: number title: original_tax_total - description: The order's original tax total. + description: The total taxes of the order excluding promotions. total: type: number title: total - description: The order's total. + description: The order's total including taxes and promotions. subtotal: type: number title: subtotal - description: The order's subtotal. + description: The order's total excluding taxes, including promotions. tax_total: type: number title: tax_total - description: The order's tax total. + description: The tax totals of the order including promotions. discount_total: type: number title: discount_total @@ -23290,7 +25066,7 @@ components: discount_tax_total: type: number title: discount_tax_total - description: The order's discount tax total. + description: The total taxes applied on the discounted amount. gift_card_total: type: number title: gift_card_total @@ -23298,34 +25074,34 @@ components: gift_card_tax_total: type: number title: gift_card_tax_total - description: The order's gift card tax total. + description: The total taxes applied on the gift card's amount. shipping_total: type: number title: shipping_total - description: The order's shipping total. + description: The order's shipping total including taxes and promotions. shipping_subtotal: type: number title: shipping_subtotal - description: The order's shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. shipping_tax_total: type: number title: shipping_tax_total - description: The order's shipping tax total. + description: The total taxes of the order's shipping including promotions. original_shipping_total: type: number title: original_shipping_total - description: The order's original shipping total. + description: The order's shipping total including taxes, excluding promotions. original_shipping_subtotal: type: number title: original_shipping_subtotal - description: The order's original shipping subtotal. + description: The order's shipping total excluding taxes, including promotions. original_shipping_tax_total: type: number title: original_shipping_tax_total - description: The order's original shipping tax total. + description: The total taxes of the order's shipping excluding promotions. StoreOrderResponse: type: object - description: SUMMARY + description: The order's details. x-schemaName: StoreOrderResponse required: - order @@ -23337,12 +25113,12 @@ components: description: The payment collection's details. x-schemaName: StorePaymentCollection required: + - payment_providers - id - currency_code - region_id - amount - status - - payment_providers properties: id: type: string @@ -23355,77 +25131,41 @@ components: region_id: type: string title: region_id - description: The payment collection's region id. + description: The ID of the region this payment collection is associated with. 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' + type: number + title: amount + description: The total amount to be paid. 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' + type: number + title: authorized_amount + description: The total authorized amount of the collection's payments. 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' + type: number + title: captured_amount + description: The total captured amount of the collection's payments. 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' + type: number + title: refunded_amount + description: The total refunded amount of the collection's payments. 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 + type: string + format: date-time + title: completed_at + description: The date the payment collection was completed. created_at: type: string format: date-time title: created_at - description: The payment collection's created at. + description: The date the payment collection was created. updated_at: type: string format: date-time title: updated_at - description: The payment collection's updated at. + description: The date the payment collection was updated. metadata: type: object - description: The payment collection's metadata. + description: The payment collection's metadata, can hold custom key-value pairs. status: type: string description: The payment collection's status. @@ -23437,14 +25177,14 @@ components: - partially_authorized payment_providers: type: array - description: The payment collection's payment providers. + description: The payment provider used to process the collection's payments and sessions. items: - $ref: '#/components/schemas/BasePaymentProvider' + $ref: '#/components/schemas/StorePaymentProvider' payment_sessions: type: array description: The payment collection's payment sessions. items: - $ref: '#/components/schemas/BasePaymentSession' + $ref: '#/components/schemas/StorePaymentSession' payments: type: array description: The payment collection's payments. @@ -23452,7 +25192,7 @@ components: $ref: '#/components/schemas/BasePayment' StorePaymentCollectionResponse: type: object - description: SUMMARY + description: The payment collection's details. x-schemaName: StorePaymentCollectionResponse required: - payment_collection @@ -23461,7 +25201,7 @@ components: $ref: '#/components/schemas/StorePaymentCollection' StorePaymentProvider: type: object - description: The payment provider's payment providers. + description: The payment provider's details x-schemaName: StorePaymentProvider required: - id @@ -23470,20 +25210,78 @@ components: type: string title: id description: The payment provider's ID. + StorePaymentSession: + type: object + description: The payment session's details. + x-schemaName: StorePaymentSession + properties: + id: + type: string + title: id + description: The payment session's ID. + amount: + type: number + title: amount + description: The payment session's amount. + currency_code: + type: string + title: currency_code + description: The payment session's currency code. + example: usd + provider_id: + type: string + title: provider_id + description: The ID of the payment provider processing this session. + data: + type: object + description: The payment session's data, useful for the payment provider processing the payment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-session#data-property + context: + type: object + description: The context around the payment, such as the customer's details. + example: + customer: + id: cus_123 + status: + type: string + description: The payment session's status. + enum: + - authorized + - captured + - canceled + - pending + - requires_more + - error + authorized_at: + type: string + title: authorized_at + description: The date the payment session was authorized. + format: date-time + payment_collection: + type: object + payment: + $ref: '#/components/schemas/BasePayment' + required: + - id + - amount + - currency_code + - provider_id + - data + - status StoreProduct: type: object description: The product's details. x-schemaName: StoreProduct required: + - variants + - options + - images - length - title - status - - options - description - id - - created_at - - updated_at - - variants - handle - subtitle - is_giftcard @@ -23497,9 +25295,10 @@ components: - material - collection_id - type_id - - images - discountable - external_id + - created_at + - updated_at - deleted_at properties: categories: @@ -23529,7 +25328,7 @@ components: type: array description: The product's options. items: - $ref: '#/components/schemas/BaseProductOption' + $ref: '#/components/schemas/StoreProductOption' description: type: string title: description @@ -23540,22 +25339,22 @@ components: description: The product's ID. metadata: type: object - description: The product's metadata. + description: The product's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The product's created at. + description: The date the product was created. updated_at: type: string format: date-time title: updated_at - description: The product's updated at. + description: The date the product was updated. variants: type: array description: The product's variants. items: - $ref: '#/components/schemas/BaseProductVariant' + $ref: '#/components/schemas/StoreProductVariant' handle: type: string title: handle @@ -23567,11 +25366,11 @@ components: is_giftcard: type: boolean title: is_giftcard - description: The product's is giftcard. + description: Whether the product is a gift card. thumbnail: type: string title: thumbnail - description: The product's thumbnail. + description: The product's thumbnail URL. width: type: number title: width @@ -23591,59 +25390,57 @@ components: hs_code: type: string title: hs_code - description: The product's hs code. + description: The product's HS code. mid_code: type: string title: mid_code - description: The product's mid code. + description: The product's MID code. material: type: string title: material description: The product's material. collection: - $ref: '#/components/schemas/BaseCollection' + $ref: '#/components/schemas/StoreCollection' collection_id: type: string title: collection_id - description: The product's collection id. + description: The ID of the collection that the product belongs to. type_id: type: string title: type_id - description: The product's type id. + description: The ID of the product's type. tags: type: array description: The product's tags. items: - $ref: '#/components/schemas/BaseProductTag' + $ref: '#/components/schemas/StoreProductTag' images: type: array description: The product's images. items: - $ref: '#/components/schemas/BaseProductImage' + $ref: '#/components/schemas/StoreProductImage' discountable: type: boolean title: discountable - description: The product's discountable. + description: Whether the product can be discounted. external_id: type: string title: external_id - description: The product's external id. + description: The ID of the product in an external service or system. deleted_at: type: string format: date-time title: deleted_at - description: The product's deleted at. + description: The date the product was deleted. StoreProductCategory: type: object - description: The category's categories. + description: The category's details. x-schemaName: StoreProductCategory required: - id - name - description - handle - - is_active - - is_internal - rank - parent_category_id - parent_category @@ -23673,14 +25470,6 @@ components: type: string title: handle description: The category's handle. - 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 @@ -23688,35 +25477,35 @@ components: parent_category_id: type: string title: parent_category_id - description: The category's parent category id. + description: The ID of the category's parent. parent_category: - $ref: '#/components/schemas/BaseProductCategory' + type: object category_children: type: array - description: The category's category children. + description: The category's children. items: - $ref: '#/components/schemas/BaseProductCategory' + type: object metadata: type: object - description: The category's metadata. + description: The category's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The category's created at. + description: The date the category was created. updated_at: type: string format: date-time title: updated_at - description: The category's updated at. + description: The date the category was updated. deleted_at: type: string format: date-time title: deleted_at - description: The category's deleted at. + description: The date the category was deleted. StoreProductCategoryListResponse: type: object - description: SUMMARY + description: The paginated list of product categories. x-schemaName: StoreProductCategoryListResponse required: - limit @@ -23727,111 +25516,328 @@ components: limit: type: number title: limit - description: The product category's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The product category's offset. + description: The number of items skipped before retrieving the returned items. count: type: number title: count - description: The product category's count. + description: The total number of items. product_categories: type: array - description: The product category's product categories. + description: The list of product categories. items: $ref: '#/components/schemas/StoreProductCategory' StoreProductCategoryResponse: type: object - description: SUMMARY + description: The product category's details. x-schemaName: StoreProductCategoryResponse required: - product_category properties: product_category: $ref: '#/components/schemas/StoreProductCategory' + StoreProductImage: + type: object + description: The image's details. + x-schemaName: StoreProductImage + required: + - id + - url + properties: + id: + type: string + title: id + description: The image's ID. + url: + type: string + title: url + description: The image's URL. + created_at: + type: string + format: date-time + title: created_at + description: The date the image was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the image was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the image was deleted. + metadata: + type: object + description: The image's metadata, can hold custom key-value pairs. + StoreProductOption: + type: object + description: The product option's details. + x-schemaName: StoreProductOption + properties: + id: + type: string + title: id + description: The option's ID. + title: + type: string + title: title + description: The option's title. + product: + type: object + product_id: + type: string + title: product_id + description: The ID of the product this option belongs to. + values: + type: array + description: The option's values. + items: + $ref: '#/components/schemas/StoreProductOptionValue' + metadata: + type: object + description: The option's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the product option was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the product option was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the product option was deleted. + required: + - title + - id + StoreProductOptionValue: + type: object + description: The product option value's details. + x-schemaName: StoreProductOptionValue + required: + - value + - id + properties: + id: + type: string + title: id + description: The value's ID. + value: + type: string + title: value + description: The value. + option: + type: object + option_id: + type: string + title: option_id + description: The ID of the option this value belongs to. + metadata: + type: object + description: The value's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the value was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the value was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the value was deleted. StoreProductResponse: type: object - description: SUMMARY + description: The product's details. x-schemaName: StoreProductResponse required: - product properties: product: $ref: '#/components/schemas/StoreProduct' - StoreProductVariantParams: + StoreProductTag: type: object - description: The product's variants. - x-schemaName: StoreProductVariantParams + description: The tag's details. + x-schemaName: StoreProductTag properties: - q: - type: string - title: q - description: The variant's q. id: - oneOf: - - type: string - title: id - description: The variant's ID. - - type: array - description: The variant's ID. - items: - type: string - title: id - description: The id's ID. - sku: - oneOf: - - type: string - title: sku - description: The variant's sku. - - type: array - description: The variant's sku. - items: - type: string - title: sku - description: The sku's details. - product_id: - oneOf: - - type: string - title: product_id - description: The variant's product id. - - type: array - description: The variant's product id. - items: - type: string - title: product_id - description: The product id's details. - options: + type: string + title: id + description: The tag's ID. + value: + type: string + title: value + description: The tag's value. + created_at: + type: string + format: date-time + title: created_at + description: The date the tag was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the tag was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the tag was deleted. + metadata: type: object + description: The tag's metadata, can hold custom key-value pairs. + required: + - id + - value + - created_at + - updated_at + StoreProductVariant: + type: object + description: The variant's details. + x-schemaName: StoreProductVariant + properties: + options: + type: array description: The variant's options. - limit: - type: number - title: limit - description: The variant's limit. - offset: - type: number - title: offset - description: The variant's offset. - order: - type: string - title: order - description: The variant's order. - fields: - type: string - title: fields - description: The variant's fields. - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or + $ref: '#/components/schemas/StoreProductOptionValue' + product: + type: object + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + metadata: + type: object + description: The variant's metadata, can hold custom key-value pairs. + id: + type: string + title: id + description: The variant's ID. + width: + type: number + title: width + description: The variant's width. + weight: + type: number + title: weight + description: The variant's weight. + height: + type: number + title: height + description: The variant's height. + origin_country: + type: string + title: origin_country + description: The variant's origin country. + 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. + material: + type: string + title: material + description: The variant's material. + created_at: + type: string + format: date-time + title: created_at + description: The date the variant was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the variant was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the variant was deleted. + product_id: + type: string + title: product_id + description: The ID of the product this variant belongs to. + sku: + type: string + title: sku + description: The variant's SKU. + barcode: + type: string + title: barcode + description: The variant's barcode. + ean: + type: string + title: ean + description: The variant's EAN. + upc: + type: string + title: upc + description: The variant's UPC. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether the variant can be ordered even if it's not in stock. + manage_inventory: + type: boolean + title: manage_inventory + description: Whether Medusa manages the variant's inventory. If disabled, the variant is always considered in stock. + externalDocs: + url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. This property is only available if you pass `+variants.inventory_quantity` in the `fields` query parameter. + externalDocs: + url: https://docs.medusajs.com/v2/resources/storefront-development/products/inventory + description: 'Storefront guide: How to retrieve a product variant''s inventory details.' + variant_rank: + type: number + title: variant_rank + description: The variant's rank among its siblings. + calculated_price: + $ref: '#/components/schemas/BaseCalculatedPriceSet' + required: + - options + - length + - title + - id + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - created_at + - updated_at + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory StoreRegion: type: object description: The region's details. @@ -23853,10 +25859,11 @@ components: type: string title: currency_code description: The region's currency code. + example: usd automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are calculated automatically during checkout for carts that belong to this region. countries: type: array description: The region's countries. @@ -23869,30 +25876,62 @@ components: $ref: '#/components/schemas/AdminPaymentProvider' metadata: type: object - description: The region's metadata. + description: The region's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The region's created at. + description: The date the region was created. updated_at: type: string format: date-time title: updated_at - description: The region's updated at. + description: The date the region was updated. + StoreRegionCountry: + type: object + description: The country's details. + x-schemaName: StoreRegionCountry + required: + - id + properties: + id: + type: string + title: id + description: The country's ID. + iso_2: + type: string + title: iso_2 + description: The country's ISO 2 code. + example: us + iso_3: + type: string + title: iso_3 + description: The country's ISO 3 codel. + example: usa + num_code: + type: string + title: num_code + description: The country's num code. + name: + type: string + title: name + description: The country's name. + display_name: + type: string + title: display_name + description: The country's display name. StoreReturn: type: object description: The return's details. x-schemaName: StoreReturn required: - - id - - order_id - - order_version - - display_id - items - - received_at + - order_id + - id - created_at + - display_id - canceled_at + - received_at properties: id: type: string @@ -23901,7 +25940,7 @@ components: order_id: type: string title: order_id - description: The return's order id. + description: The ID of the order this return is created for. status: type: string title: status @@ -23909,49 +25948,88 @@ components: exchange_id: type: string title: exchange_id - description: The return's exchange id. + description: The ID of the associated exchange. location_id: type: string title: location_id - description: The return's location id. + description: The ID of the location the items are returned to. 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. + description: The ID of the associated claim. 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. + description: The return's display ID. refund_amount: type: number title: refund_amount - description: The return's refund amount. + description: The return's refunded amount. items: type: array description: The return's items. items: - $ref: '#/components/schemas/BaseReturnItem' + $ref: '#/components/schemas/StoreReturnItem' received_at: type: string title: received_at - description: The return's received at. + description: The date the return was received. created_at: type: string format: date-time title: created_at - description: The return's created at. + description: The date the return was created. canceled_at: type: string title: canceled_at - description: The return's canceled at. + description: The date the return was updated. + StoreReturnItem: + type: object + description: The return item's details. + x-schemaName: StoreReturnItem + properties: + id: + type: string + title: id + description: The item's ID. + quantity: + type: number + title: quantity + description: The item's quantity. + received_quantity: + type: number + title: received_quantity + description: The item's received quantity. + damaged_quantity: + type: number + title: damaged_quantity + description: The item's damaged quantity. + reason_id: + type: string + title: reason_id + description: The ID of the item's reason. + note: + type: string + title: note + description: A note with more details on why the item is returned. + item_id: + type: string + title: item_id + description: The ID of the item in the order. + return_id: + type: string + title: return_id + description: The ID of the return this item belongs to. + metadata: + type: object + description: The item's metadata, can hold custom key-value pairs. + required: + - id + - quantity + - received_quantity + - damaged_quantity + - item_id + - return_id StoreReturnReason: type: object description: The return reason's details. @@ -23981,20 +26059,20 @@ components: description: The return reason's description. metadata: type: object - description: The return reason's metadata. + description: The return reason's metadata, can hold custom key-value pairs. created_at: type: string format: date-time title: created_at - description: The return reason's created at. + description: The date the return reason was created. updated_at: type: string format: date-time title: updated_at - description: The return reason's updated at. + description: The date the return reason was updated. StoreReturnReasonResponse: type: object - description: SUMMARY + description: The return reason's details. x-schemaName: StoreReturnReasonResponse required: - return_reason @@ -24003,7 +26081,7 @@ components: $ref: '#/components/schemas/StoreReturnReason' StoreReturnResponse: type: object - description: SUMMARY + description: The return's details. x-schemaName: StoreReturnResponse required: - return @@ -24012,7 +26090,7 @@ components: $ref: '#/components/schemas/StoreReturn' StoreShippingOption: type: object - description: The shipping option's shipping options. + description: The shipping option's details. x-schemaName: StoreShippingOption required: - id @@ -24039,30 +26117,30 @@ components: description: The shipping option's name. price_type: type: string - description: The shipping option's price type. + description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider. enum: - flat - calculated service_zone_id: type: string title: service_zone_id - description: The shipping option's service zone id. + description: The ID of the service zone the shipping option belongs to. provider_id: type: string title: provider_id - description: The shipping option's provider id. + description: The ID of the fulfillment provider handling this option. 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. + description: The ID of the shipping option's type. type: - type: object + $ref: '#/components/schemas/StoreShippingOptionType' shipping_profile_id: type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: The ID of the associated shipping profile. amount: type: number title: amount @@ -24070,16 +26148,18 @@ components: is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The shipping option's is tax inclusive. + description: Whether the amount includes taxes. data: type: object - description: The shipping option's data. + description: The shipping option's data, useful for the provider handling fulfillment. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property metadata: type: object - description: The shipping option's metadata. + description: The shipping option's metadata, can hold custom key-value pairs. StoreShippingOptionListResponse: type: object - description: SUMMARY + description: The shipping option's details. x-schemaName: StoreShippingOptionListResponse required: - shipping_options @@ -24089,9 +26169,58 @@ components: description: The shipping option's shipping options. items: $ref: '#/components/schemas/StoreShippingOption' + StoreShippingOptionType: + type: object + description: The shipping option type's details. + x-schemaName: StoreShippingOptionType + required: + - id + - label + - description + - code + - shipping_option_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The type's ID. + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. + shipping_option_id: + type: string + title: shipping_option_id + description: The ID of the associated shipping option. + created_at: + type: string + format: date-time + title: created_at + description: The date the type was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the type was updated. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the type was deleted. StoreUpdateCartLineItem: type: object - description: SUMMARY + description: The details to update in the line item. x-schemaName: StoreUpdateCartLineItem required: - quantity @@ -24099,13 +26228,13 @@ components: quantity: type: number title: quantity - description: The cart's quantity. + description: The item's quantity. metadata: type: object - description: The cart's metadata. + description: The item's metadata, can hold custom key-value pairs. StoreUpdateCustomer: type: object - description: SUMMARY + description: The details to update in the customer. x-schemaName: StoreUpdateCustomer properties: company_name: @@ -24126,7 +26255,7 @@ components: description: The customer's phone. UpdateAddress: type: object - description: The cart's shipping address. + description: The details to update in the address. x-schemaName: UpdateAddress required: - id @@ -24134,88 +26263,90 @@ components: id: type: string title: id - description: The shipping address's ID. + description: The ID of an existing address to update. customer_id: type: string title: customer_id - description: The shipping address's customer id. + description: The ID of the customer that this address belongs to. company: type: string title: company - description: The shipping address's company. + description: The address's company. first_name: type: string title: first_name - description: The shipping address's first name. + description: The address's first name. last_name: type: string title: last_name - description: The shipping address's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The address's second line. city: type: string title: city - description: The shipping address's city. + description: The address's city. country_code: type: string title: country_code - description: The shipping address's country code. + description: The address's country code. + example: usd province: type: string title: province - description: The shipping address's province. + description: The address's province. postal_code: type: string title: postal_code - description: The shipping address's postal code. + description: The address's postal code. phone: type: string title: phone - description: The shipping address's phone. + description: The address's phone. metadata: type: object - description: The shipping address's metadata. + description: The address's metadata, can hold custom key-value pairs. UpdateCartData: type: object - description: SUMMARY + description: The details to update in a cart. x-schemaName: UpdateCartData properties: region_id: type: string title: region_id - description: The cart's region id. + description: The ID of the associated region. This can affect the prices and currency code of the cart. customer_id: type: string title: customer_id - description: The cart's customer id. + description: The ID of the customer that the cart belongs to. sales_channel_id: type: string title: sales_channel_id - description: The cart's sales channel id. + description: The ID of the associated sales channel. Only products available in this channel can be added to the cart. email: type: string title: email - description: The cart's email. + description: The email of the customer that the cart belongs to. format: email currency_code: type: string title: currency_code description: The cart's currency code. + example: usd shipping_address_id: type: string title: shipping_address_id - description: The cart's shipping address id. + description: The ID of the cart's shipping address. billing_address_id: type: string title: billing_address_id - description: The cart's billing address id. + description: The ID of the cart's billing address. billing_address: oneOf: - $ref: '#/components/schemas/CreateAddress' @@ -24226,31 +26357,7 @@ components: - $ref: '#/components/schemas/UpdateAddress' metadata: type: object - description: The cart's metadata. - UpdateOrderReturnReason: - type: object - description: SUMMARY - x-schemaName: UpdateOrderReturnReason - properties: - id: - type: string - title: id - description: The return reason's ID. - label: - type: string - title: label - description: The return reason's label. - value: - type: string - title: value - description: The return reason's value. - description: - type: string - title: description - description: The return reason's description. - metadata: - type: object - description: The return reason's metadata. + description: The cart's metadata, ca hold custom key-value pairs. WorkflowExecutionContext: type: object description: The workflow execution's context. @@ -24262,6 +26369,30 @@ components: data: type: object description: The context's data. + properties: + invoke: + type: object + description: The step's invokation details. + required: + - output + additionalProperties: + type: object + properties: + output: + type: object + description: The invokation's details. + required: + - output + - compensateInput + properties: + output: + description: the step's output + compensateInput: + description: the compensation function's input. + payload: + description: the payload of the transaction. + required: + - invoke compensate: type: object description: The context's compensate. @@ -24270,7 +26401,23 @@ components: description: The context's errors. items: type: object - description: The error's errors. + description: The error's details. + properties: + error: + type: object + description: The error's details. + action: + type: string + title: action + description: The error's action. + handlerType: + type: string + title: handlerType + description: The error's handler type. + required: + - error + - action + - handlerType responses: default_error: description: Default Error diff --git a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml index 1dee2c6650..167457e4db 100644 --- a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml +++ b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}.yaml @@ -36,14 +36,10 @@ post: label: EmailPass Provider source: $ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh - - lang: Shell + - lang: Bash label: Google Provider source: - $ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh - - lang: Shell - label: GitHub Provider - source: - $ref: ../code_samples/Shell/auth_customer_{auth_provider}/post.sh + $ref: ../code_samples/Bash/auth_customer_{auth_provider}/post.sh tags: - Auth responses: diff --git a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml index 0f205dabbf..d27eae5a0f 100644 --- a/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml +++ b/www/apps/api-reference/specs/store/paths/auth_customer_{auth_provider}_callback.yaml @@ -33,10 +33,10 @@ post: label: Google Provider source: $ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh - - lang: Shell + - lang: Bash label: GitHub Provider source: - $ref: ../code_samples/Shell/auth_customer_{auth_provider}_callback/post.sh + $ref: ../code_samples/Bash/auth_customer_{auth_provider}_callback/post.sh tags: - Auth responses: diff --git a/www/apps/api-reference/specs/store/paths/auth_session.yaml b/www/apps/api-reference/specs/store/paths/auth_session.yaml index 9e89642476..6a0c182498 100644 --- a/www/apps/api-reference/specs/store/paths/auth_session.yaml +++ b/www/apps/api-reference/specs/store/paths/auth_session.yaml @@ -51,7 +51,7 @@ delete: application/json: schema: type: object - description: SUMMARY + description: The deletion's details. required: - success properties: 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 da42134043..b3acb44b1e 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -30,6 +30,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: 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 2ad50decf8..9c5bc4811b 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -104,6 +106,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: 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 e9220c58af..2753f1a285 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 @@ -40,6 +40,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -63,7 +65,9 @@ post: type: type: string title: type - description: The type of the returned object. + description: >- + The type of the returned object. In this case, the order + is returned because the cart was completed successfully. default: order order: $ref: ../components/schemas/StoreOrder.yaml @@ -77,7 +81,9 @@ post: type: type: string title: type - description: The type of the returned object. + description: >- + The type of the returned object. In this case, the cart is + returned because an error has occurred. default: cart cart: $ref: ../components/schemas/StoreCart.yaml 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 9bfa14e8fc..6d47ad4d1a 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 @@ -41,6 +41,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: 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 fe22872570..624db1819c 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 @@ -47,6 +47,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -128,6 +130,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL 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 135e79ea63..4da5438a5b 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 @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -118,6 +120,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL 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 71bf8f3eed..268a1feccd 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 @@ -43,6 +43,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -64,7 +66,7 @@ post: externalDocs: url: >- https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping#data-request-body-parameter - description: Learn more about the `data` parameter. + description: Learn more about the data parameter. x-codeSamples: - lang: Shell label: cURL 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 9096f876ac..53083c97a2 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 @@ -37,11 +37,8 @@ post: 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. - requestBody: - content: - application/json: - schema: - $ref: ../components/schemas/StoreCalculateCartTaxes.yaml + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL 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 84190dc75b..6e1d04c206 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -36,6 +36,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -44,6 +46,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -52,6 +56,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -965,7 +971,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of collections. required: - limit - offset @@ -974,17 +980,19 @@ get: limit: type: number title: limit - description: The collection's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The collection's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The collection's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of collections. required: - collections properties: 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 83c4e37a8e..b0372f85a0 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 @@ -42,6 +42,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_currencies.yaml b/www/apps/api-reference/specs/store/paths/store_currencies.yaml index 4c770c56d2..311bd31b20 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies.yaml @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 a5adc037a7..8923514148 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL 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 bfefdf2b95..e7559cb943 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -37,6 +37,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: @@ -69,3 +71,6 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: createCustomerAccountWorkflow + security: + - cookie_auth: [] + - jwt_token: [] 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 f6c0668822..15fb5f297b 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 @@ -37,6 +37,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -102,6 +104,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] 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 97175791aa..d6e5ff8cd4 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -46,6 +48,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -54,6 +58,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -70,31 +76,52 @@ get: - name: city in: query description: Filter by the address's city. - required: true + required: false schema: - type: string - title: city - description: Filter by the address's city. + oneOf: + - type: string + title: city + description: Filter by a city. + - type: array + description: Filter by cities. + items: + type: string + title: city + description: A city. - name: postal_code in: query description: Filter by the address's postal code. - required: true + required: false schema: - type: string - title: postal_code - description: Filter by the address's postal code. + oneOf: + - type: string + title: postal_code + description: Filter by a postal code. + - type: array + description: Filter by postal codes. + items: + type: string + title: postal_code + description: A postal code. - name: country_code in: query description: Filter by the address's country code. - required: true + required: false schema: - type: string - title: country_code - description: Filter by the address's country code. + oneOf: + - type: string + title: country_code + description: Filter by a country code. + - type: array + description: Filter by country codes. + items: + type: string + title: country_code + description: A country code. - name: q in: query description: Search term to filter the address's searchable properties. - required: true + required: false schema: type: string title: q @@ -165,6 +192,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] 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 1e57fb9afe..57d7a06e97 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 @@ -39,6 +39,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -111,6 +113,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] @@ -251,6 +255,8 @@ delete: 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. + externalDocs: + url: '#select-fields-and-relations' security: - cookie_auth: [] - jwt_token: [] 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 aaffc78e24..b925e4ea8b 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -33,6 +33,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -41,6 +43,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -49,6 +53,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -144,7 +150,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of orders. required: - limit - offset @@ -153,17 +159,19 @@ get: limit: type: number title: limit - description: The order's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The order's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The order's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of orders. required: - orders properties: 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 119b56c25e..e912e58703 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL 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 f71a4d82de..b1ba01acf5 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 @@ -36,6 +36,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: 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 f4367f0599..c928693c72 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 @@ -45,6 +45,8 @@ post: 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. + externalDocs: + url: '#select-fields-and-relations' requestBody: content: application/json: 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 7b6b549833..ff2cc3665a 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 @@ -36,6 +36,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -44,6 +46,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -52,6 +56,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 855923a5e8..5f57286785 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 @@ -37,6 +37,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -45,6 +47,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -53,6 +57,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml index c12d3a15db..543b1b7b9e 100644 --- a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml @@ -42,6 +42,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: include_ancestors_tree in: query description: >- 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 d92dd42cf3..87c50646a5 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -36,6 +36,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -44,6 +46,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -52,6 +56,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -1020,18 +1026,6 @@ get: url: >- https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price description: 'Storefront guide: How to show product variants'' prices with taxes.' - - name: country_code - in: query - description: >- - The country code the products are being viewed from. This is required if - you're retrieving product variant prices with taxes. - required: false - schema: - type: string - title: country_code - description: >- - The country code the products are being viewed from. This is required - if you're retrieving product variant prices with taxes. - name: province in: query description: >- @@ -1046,20 +1040,6 @@ get: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. - - name: cart_id - in: query - description: >- - The ID of the customer's cart. If set, the cart's region and shipping - address's country code and province are used instead of the `region_id`, - `country_code`, and `province` properties. - required: false - schema: - type: string - title: cart_id - description: >- - The ID of the customer's cart. If set, the cart's region and shipping - address's country code and province are used instead of the - `region_id`, `country_code`, and `province` properties. - name: sales_channel_id in: query required: false @@ -1088,6 +1068,38 @@ get: type: string title: category_id description: A product category's ID. + - name: currency_code + in: query + description: The currency code to retrieve prices in. + required: false + schema: + type: string + title: currency_code + description: The currency code to retrieve prices in. + - name: variants + in: query + description: Filter the products' variants. + required: false + schema: + type: object + description: Filter the products' variants. + x-schemaName: StoreProductVariantParams + properties: + options: + type: object + description: Filter by the variants' options. + required: + - value + - option_id + properties: + option_id: + type: string + title: option_id + description: The ID of the option to filter by. + value: + type: string + title: value + description: Filter by a value of the option. x-codeSamples: - lang: Shell label: cURL 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 181c70e219..433f898614 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 @@ -42,6 +42,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: region_id in: query description: >- 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 7cf386f27e..d29f094f66 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -35,6 +35,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -43,6 +45,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -51,6 +55,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- @@ -159,7 +165,7 @@ get: schema: allOf: - type: object - description: SUMMARY + description: The paginated list of regions. required: - limit - offset @@ -168,23 +174,25 @@ get: limit: type: number title: limit - description: The region's limit. + description: The maximum number of items returned. offset: type: number title: offset - description: The region's offset. + description: >- + The number of items skipped before retrieving the returned + items. count: type: number title: count - description: The region's count. + description: The total number of items. - type: object - description: SUMMARY + description: The paginated list of regions. required: - regions properties: regions: type: array - description: The region's regions. + description: The list of regions. items: $ref: ../components/schemas/StoreRegion.yaml '400': 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 c18e9d349b..d363123774 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL @@ -52,7 +54,7 @@ get: application/json: schema: type: object - description: SUMMARY + description: The region's details. required: - region properties: 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 63b8a4156b..22f55f9017 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 @@ -32,6 +32,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -40,6 +42,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -48,6 +52,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 0adc679223..b829e8aac6 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 @@ -38,6 +38,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml index a4442cf35d..f59a443502 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 @@ -29,6 +29,8 @@ get: 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. + externalDocs: + url: '#select-fields-and-relations' - name: offset in: query description: The number of items to skip when retrieving a list. @@ -37,6 +39,8 @@ get: type: number title: offset description: The number of items to skip when retrieving a list. + externalDocs: + url: '#pagination' - name: limit in: query description: Limit the number of items returned in the list. @@ -45,6 +49,8 @@ get: type: number title: limit description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' - name: order in: query description: >- 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 22cff6691c..fcbddfa254 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 @@ -60,7 +60,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * x-workflow: deleteCustomersWorkflow + * x-workflow: removeCustomerAccountWorkflow * */ 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 index a0201380fa..0aab9eec8f 100644 --- 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 @@ -21,26 +21,6 @@ * 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. - * externalDocs: - * url: "#select-fields-and-relations" * security: * - api_token: [] * - cookie_auth: [] 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 5b5282b316..4296faeaf2 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 @@ -36,7 +36,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * x-workflow: deleteUsersWorkflow + * x-workflow: removeUserAccountWorkflow * */ 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 80608525d9..39d726cb35 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id]_[rule_type].ts @@ -3,12 +3,10 @@ * operationId: GetPromotionsIdRule_type * summary: List Rules of a Promotion * x-sidebar-summary: List Rules - * description: > + * description: | * Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter: - * * - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. * - * * - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved. * x-authenticated: true * parameters: diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts new file mode 100644 index 0000000000..32a0dc9a58 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options_[id].ts @@ -0,0 +1,69 @@ +/** + * @oas [get] /admin/shipping-options/{id} + * operationId: GetShippingOptionsId + * summary: Get a Shipping Option + * description: Retrieve a shipping option by its ID. You can expand the shipping option's relations or select the fields that should be returned. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The shipping option'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. + * externalDocs: + * url: "#select-fields-and-relations" + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/shipping-options/{id}' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Shipping Options + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminShippingOptionResponse" + * "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_claims_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_request.ts index 3b820cc039..8ca64468da 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 @@ -63,10 +63,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * x-workflow: confirmClaimRequestWorkflow * */ 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 index 02a53b17dc..c331bbc559 100644 --- 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 @@ -63,10 +63,6 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: confirmExchangeRequestWorkflow - * requestBody: - * content: - * application/json: - * schema: {} * */ 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 367617318d..19844288d0 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 @@ -56,10 +56,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * x-workflow: refreshInviteTokensWorkflow * */ 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 7ba711bee8..b907bb17ef 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 @@ -62,10 +62,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_archive.ts index 896217ff01..eca5af12f9 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 @@ -35,11 +35,6 @@ * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminArchiveOrder" * x-codeSamples: * - lang: Shell * label: cURL 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 e2a938a0c7..90160ffc14 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 @@ -70,10 +70,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * x-workflow: cancelOrderWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts index de21839dcf..8ba52958c1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_mark-as-delivered.ts @@ -42,11 +42,6 @@ * - api_token: [] * - cookie_auth: [] * - jwt_token: [] - * requestBody: - * content: - * application/json: - * schema: - * $ref: "#/components/schemas/AdminMarkOrderFulfillmentDelivered" * x-codeSamples: * - lang: Shell * label: cURL 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 71b719b142..26cc844134 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 @@ -31,8 +31,8 @@ * description: A price's details. * required: * - currency_code - * - amount * - variant_id + * - amount * properties: * currency_code: * type: string 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 6d6ba1abba..ba94d2f1f9 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 @@ -33,7 +33,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/AdminCreateProduct" + * $ref: "#/components/schemas/AdminCreateProductType" * x-codeSamples: * - lang: Shell * label: cURL 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 79ce80a9dc..48a9166d25 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 @@ -30,9 +30,9 @@ * type: object * description: The associations to create between a product variant and an inventory item. * required: - * - required_quantity - * - inventory_item_id * - variant_id + * - inventory_item_id + * - required_quantity * properties: * required_quantity: * type: number @@ -53,9 +53,9 @@ * type: object * description: Update a product variant's association with an inventory item. * required: - * - required_quantity - * - inventory_item_id * - variant_id + * - inventory_item_id + * - required_quantity * properties: * required_quantity: * type: number @@ -76,8 +76,8 @@ * type: object * description: Delete a product variant's association with an inventory item. * required: - * - inventory_item_id * - variant_id + * - inventory_item_id * properties: * inventory_item_id: * type: string 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 977ef886aa..6306add98d 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 @@ -47,93 +47,12 @@ * type: array * description: The buy rules to create. * items: - * type: object - * description: A buy rule's details. - * required: - * - operator - * - attribute - * - values - * properties: - * operator: - * type: string - * description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The buy rule's description. - * attribute: - * type: string - * title: attribute - * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: items.product.id - * values: - * oneOf: - * - type: string - * title: values - * description: The attribute's value. - * example: prod_123 - * - type: array - * description: The allowed attribute values. - * items: - * type: string - * title: values - * description: An attribute value. - * example: prod_123 + * $ref: "#/components/schemas/AdminCreatePromotionRule" * update: * type: array * description: The buy rules to update. * items: - * type: object - * description: The properties to update in a buy rule. - * required: - * - id - * - values - * properties: - * id: - * type: string - * title: id - * description: The buy rule's ID. - * operator: - * type: string - * description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The buy rule's description. - * attribute: - * type: string - * title: attribute - * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: items.product.id - * values: - * oneOf: - * - type: string - * title: values - * description: The attribute's value. - * example: prod_123 - * - type: array - * description: The allowed attribute values. - * items: - * type: string - * title: values - * description: An attribute value. - * example: prod_123 + * $ref: "#/components/schemas/AdminUpdatePromotionRule" * delete: * type: array * description: The buy rules to delete. 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 d5eae4e36e..6180fb2e45 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 @@ -47,93 +47,12 @@ * type: array * description: The rules to create. * items: - * type: object - * description: A rule's details. - * required: - * - operator - * - attribute - * - values - * properties: - * operator: - * type: string - * description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: items.product.id - * values: - * oneOf: - * - type: string - * title: values - * description: The attribute's value. - * example: prod_123 - * - type: array - * description: The allowed attribute values. - * items: - * type: string - * title: values - * description: An attribute value. - * example: prod_123 + * $ref: "#/components/schemas/AdminCreatePromotionRule" * update: * type: array * description: The rules to update. * items: - * type: object - * description: The properties to update in a rule. - * required: - * - id - * - values - * properties: - * id: - * type: string - * title: id - * description: The rule's ID. - * operator: - * type: string - * description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The rule's description. - * attribute: - * type: string - * title: attribute - * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: items.product.id - * values: - * oneOf: - * - type: string - * title: values - * description: The attribute's value. - * example: prod_123 - * - type: array - * description: The allowed attribute values. - * items: - * type: string - * title: values - * description: An attribute value. - * example: prod_123 + * $ref: "#/components/schemas/AdminUpdatePromotionRule" * delete: * type: array * description: The rules to delete. 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 0527d3fd82..c2abaca8e7 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 @@ -47,93 +47,12 @@ * type: array * description: The target rules to create. * items: - * type: object - * description: A target rule's details. - * required: - * - operator - * - attribute - * - values - * properties: - * operator: - * type: string - * description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The target rule's description. - * attribute: - * type: string - * title: attribute - * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: items.product.id - * values: - * oneOf: - * - type: string - * title: values - * description: The attribute's value. - * example: prod_123 - * - type: array - * description: The allowed attribute values. - * items: - * type: string - * title: values - * description: An attribute value. - * example: prod_123 + * $ref: "#/components/schemas/AdminCreatePromotionRule" * update: * type: array * description: The target rules to update. * items: - * type: object - * description: The properties to update in a target rule. - * required: - * - id - * - values - * properties: - * id: - * type: string - * title: id - * description: The target rule's ID. - * operator: - * type: string - * description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. - * enum: - * - gte - * - lte - * - gt - * - lt - * - eq - * - ne - * - in - * description: - * type: string - * title: description - * description: The target rule's description. - * attribute: - * type: string - * title: attribute - * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: items.product.id - * values: - * oneOf: - * - type: string - * title: values - * description: The attribute's value. - * example: prod_123 - * - type: array - * description: The allowed attribute values. - * items: - * type: string - * title: values - * description: An attribute value. - * example: prod_123 + * $ref: "#/components/schemas/AdminUpdatePromotionRule" * delete: * type: array * description: The target rules to delete. 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 1eaa68aac7..e4bfc2172a 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 @@ -33,7 +33,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/CreateOrderReturnReason" + * $ref: "#/components/schemas/AdminCreateReturnReason" * x-codeSamples: * - lang: Shell * label: cURL 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 4092197e55..7b61d4139f 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 @@ -39,7 +39,7 @@ * content: * application/json: * schema: - * $ref: "#/components/schemas/UpdateOrderReturnReason" + * $ref: "#/components/schemas/AdminUpdateReturnReason" * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts index 6cf3f02e83..3b982d2d2c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options_[id].ts @@ -71,9 +71,9 @@ * type: object * description: The shipping option's type. * required: - * - label - * - description * - code + * - description + * - label * properties: * label: * type: string 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 df3486462d..c1eed17ac8 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 @@ -47,89 +47,12 @@ * type: array * description: The shipping option rules to create. * items: - * type: object - * description: A shipping option's details. - * required: - * - operator - * - attribute - * - value - * properties: - * operator: - * type: string - * description: The operator used to check whether a rule applies. - * enum: - * - in - * - eq - * - ne - * - gt - * - gte - * - lt - * - lte - * - nin - * attribute: - * type: string - * title: attribute - * description: The name of a property or table that the rule applies to. - * example: customer_group - * value: - * oneOf: - * - type: string - * title: value - * description: A value of the attribute that enables this rule. - * example: cusgroup_123 - * - type: array - * description: Values of the attribute that enable this rule. - * items: - * type: string - * title: value - * description: A value of the attribute that enables this rule. - * example: cusgroup_123 + * $ref: "#/components/schemas/AdminCreateShippingOptionRule" * update: * type: array * description: The shipping option rules to update. * items: - * type: object - * description: The properties to update in the shipping option rule. - * required: - * - id - * - operator - * - attribute - * - value - * properties: - * id: - * type: string - * title: id - * description: The rule's ID. - * operator: - * type: string - * description: The operator used to check whether a rule applies. - * enum: - * - in - * - eq - * - ne - * - gt - * - gte - * - lt - * - lte - * - nin - * attribute: - * type: string - * title: attribute - * description: The name of a property or table that the rule applies to. - * example: customer_group - * value: - * oneOf: - * - type: string - * title: value - * description: A value of the attribute that enables this rule. - * example: cusgroup_123 - * - type: array - * description: Values of the attribute that enable this rule. - * items: - * type: string - * title: value - * description: A value of the attribute that enables this rule. - * example: cusgroup_123 + * $ref: "#/components/schemas/AdminUpdateShippingOptionRule" * delete: * type: array * description: The shipping option rules to delete. 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 2f3e2200da..080e66439d 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 @@ -43,8 +43,8 @@ * type: object * description: The fulfillment set to create. * required: - * - name * - type + * - name * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts index 4ec6265a58..8e9b20d7ac 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider].ts @@ -36,10 +36,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts index 8614619a0d..caae23a2fd 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_callback.ts @@ -36,10 +36,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts index c69a949492..f0ecf6afd7 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_register.ts @@ -36,10 +36,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts index 810cc60779..b7c5df0384 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts @@ -24,8 +24,6 @@ * tags: * - "[actor_type]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": @@ -39,6 +37,11 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: generateResetPasswordTokenWorkflow + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/ResetPasswordRequest" * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts index 33f5b0f454..9f854c1759 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts @@ -24,8 +24,6 @@ * tags: * - "[actor_type]" * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts index 13eb92de15..f4320d1395 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts @@ -23,10 +23,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts b/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts index dd1b87493f..c7641f599c 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts @@ -4,7 +4,6 @@ * summary: Create Token * description: Create a token. * x-authenticated: false - * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL @@ -12,8 +11,6 @@ * tags: * - Token * responses: - * "200": - * description: OK * "400": * $ref: "#/components/responses/400_error" * "401": diff --git a/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts b/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts index 52edfaeee1..c3a92ed694 100644 --- a/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts +++ b/www/utils/generated/oas-output/operations/hooks/post_hooks_payment_[provider].ts @@ -30,10 +30,6 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * requestBody: - * content: - * application/json: - * schema: {} * */ diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts index 4f8a9bae92..86103b3618 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_line-items_[line_id].ts @@ -71,7 +71,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "line-item" + * default: line-item * deleted: * type: boolean * title: deleted 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 5abed16f56..f8905ce810 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 @@ -69,7 +69,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "address" + * default: address * deleted: * type: boolean * title: deleted 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 cd6329af4a..9aea198d32 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 @@ -883,14 +883,6 @@ * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/products/price/examples/tax-price * description: "Storefront guide: How to show product variants' prices with taxes." - * - name: country_code - * in: query - * description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. - * required: false - * schema: - * type: string - * title: country_code - * description: The country code the products are being viewed from. This is required if you're retrieving product variant prices with taxes. * - name: province * in: query * description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. @@ -899,14 +891,6 @@ * type: string * title: province * description: The province the products are being viewed from. This is useful to narrow down the tax context when calculating product variant prices with taxes. - * - name: cart_id - * in: query - * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. - * required: false - * schema: - * type: string - * title: cart_id - * description: The ID of the customer's cart. If set, the cart's region and shipping address's country code and province are used instead of the `region_id`, `country_code`, and `province` properties. * - name: sales_channel_id * in: query * required: false @@ -935,6 +919,38 @@ * type: string * title: category_id * description: A product category's ID. + * - name: currency_code + * in: query + * description: The currency code to retrieve prices in. + * required: false + * schema: + * type: string + * title: currency_code + * description: The currency code to retrieve prices in. + * - name: variants + * in: query + * description: Filter the products' variants. + * required: false + * schema: + * type: object + * description: Filter the products' variants. + * x-schemaName: StoreProductVariantParams + * properties: + * options: + * type: object + * description: Filter by the variants' options. + * required: + * - value + * - option_id + * properties: + * option_id: + * type: string + * title: option_id + * description: The ID of the option to filter by. + * value: + * type: string + * title: value + * description: Filter by a value of the option. * x-codeSamples: * - lang: Shell * label: cURL 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 4e1bfa0e7a..394167d3fb 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 @@ -34,8 +34,7 @@ * x-codeSamples: * - lang: Shell * label: cURL - * source: |- - * curl '{backend_url}/store/regions/{id}' + * source: curl '{backend_url}/store/regions/{id}' * tags: * - Regions * responses: 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 509b86e0e6..f16aa98cf9 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 @@ -2,10 +2,9 @@ * @oas [get] /store/shipping-options * operationId: GetShippingOptions * summary: List Shipping Options for Cart - * description: > + * description: | * Retrieve a list of shipping options for a cart. The cart's ID is set in the required `cart_id` query parameter. * - * * The shipping options also be sorted or paginated. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/shipping 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 7eb34f9cf0..c315b05dc6 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 @@ -96,8 +96,8 @@ * type: string * title: type * description: > - * The error's type. Can be a [MedusaError type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types) - * or `payment_authorization_error` or `payment_requires_more_error` for payment-related errors. + * The error's type. Can be a [MedusaError type](https://docs.medusajs.com/v2/advanced-development/api-routes/errors#medusaerror-types) or `payment_authorization_error` or + * `payment_requires_more_error` for payment-related errors. * "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 8ec46c66f3..b9e92dc3ca 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 @@ -70,6 +70,9 @@ * "500": * $ref: "#/components/responses/500_error" * x-workflow: createCustomerAccountWorkflow + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ 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 ecaf22c502..474c75fdc1 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 @@ -3,7 +3,8 @@ * operationId: PostPaymentCollectionsIdPaymentSessions * summary: Initialize Payment Session of a Payment Collection * x-sidebar-summary: Initialize Payment Session - * description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the payment provider that the customer chooses. + * description: Initialize and add a payment session to a payment collection. This is used during checkout, where you create a payment collection for the cart, then initialize a payment session for the + * payment provider that the customer chooses. * externalDocs: * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment * description: "Storefront guide: How to implement payment during checkout." diff --git a/www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts b/www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts deleted file mode 100644 index 738a1c45c8..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminArchiveOrder.ts +++ /dev/null @@ -1,15 +0,0 @@ -/** - * @schema AdminArchiveOrder - * type: object - * description: The archive details. - * x-schemaName: AdminArchiveOrder - * 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/AdminCampaign.ts b/www/utils/generated/oas-output/schemas/AdminCampaign.ts index 3d94ccbe52..d1fa693d31 100644 --- a/www/utils/generated/oas-output/schemas/AdminCampaign.ts +++ b/www/utils/generated/oas-output/schemas/AdminCampaign.ts @@ -58,8 +58,8 @@ * type: * type: string * description: > - * The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total - * number of times the campaign's promotions can be used. + * The budget's type. `spend` means the limit is set on the total amount discounted by the campaign's promotions; `usage` means the limit is set on the total number of times the campaign's + * promotions can be used. * enum: * - spend * - usage @@ -75,8 +75,8 @@ * type: number * title: used * description: > - * How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds - * the number of times the campaign's promotions have been used so far. + * How much of the budget has been used. If the limit is `spend`, this property holds the total amount discounted so far. If the limit is `usage`, it holds the number of times the campaign's + * promotions have been used so far. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts index 5c3753d082..7a31abdced 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimPreviewResponse.ts @@ -8,7 +8,7 @@ * - claim * properties: * order_preview: - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * 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 index ed77912751..b09200f9f0 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimRequestResponse.ts @@ -11,7 +11,7 @@ * return: * $ref: "#/components/schemas/AdminReturn" * order_preview: - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * 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 index 24759943eb..cecc92e966 100644 --- a/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminClaimReturnPreviewResponse.ts @@ -8,7 +8,7 @@ * - return * properties: * order_preview: - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * return: * $ref: "#/components/schemas/AdminReturn" * diff --git a/www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts b/www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts deleted file mode 100644 index bf52fb5457..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminCreateApplicationMethod.ts +++ /dev/null @@ -1,66 +0,0 @@ -/** - * @schema AdminCreateApplicationMethod - * type: object - * description: The application method's details. - * x-schemaName: AdminCreateApplicationMethod - * required: - * - value - * - type - * - target_type - * properties: - * description: - * type: string - * title: description - * description: The application method's description. - * value: - * type: number - * title: value - * description: The discounted amount applied by the associated promotion based on the `type`. - * currency_code: - * type: string - * title: currency_code - * description: The application method's currency code. - * max_quantity: - * type: number - * title: max_quantity - * description: The max quantity allowed in the cart for the associated promotion to be applied. - * type: - * type: string - * description: The type of the application method indicating how the associated promotion is applied. - * enum: - * - fixed - * - percentage - * target_type: - * type: string - * description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order. - * enum: - * - items - * - shipping_methods - * - order - * allocation: - * type: string - * description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart. - * enum: - * - each - * - across - * target_rules: - * type: array - * description: The application method's target rules. - * items: - * $ref: "#/components/schemas/AdminCreatePromotionRule" - * buy_rules: - * type: array - * description: The application method's buy rules. - * items: - * $ref: "#/components/schemas/AdminCreatePromotionRule" - * apply_to_quantity: - * type: number - * title: apply_to_quantity - * description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`. - * buy_rules_min_quantity: - * type: number - * title: buy_rules_min_quantity - * description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts index 0895b47c1a..9fe2f69296 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts @@ -4,15 +4,14 @@ * description: The filfillment's details. * x-schemaName: AdminCreateFulfillment * required: + * - data + * - order_id + * - metadata + * - items * - location_id * - provider_id * - delivery_address - * - items * - labels - * - order - * - order_id - * - data - * - metadata * properties: * location_id: * type: string @@ -77,8 +76,8 @@ * description: An item to fulfill. * required: * - title - * - sku * - quantity + * - sku * - barcode * properties: * title: diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts index 1935f0e6b6..51e8a05b83 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts @@ -50,8 +50,8 @@ * description: A price's details. * required: * - currency_code - * - amount * - variant_id + * - amount * properties: * currency_code: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts index 110e73afd5..1142c05edc 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateProductVariant.ts @@ -84,5 +84,11 @@ * description: The variant's options, where the key is an option's name, and the value is the option's value. * example: * Color: Black + * inventory_items: + * type: array + * description: The variant's inventory items to create. + * items: + * $ref: "#/components/schemas/AdminCreateProductVariantInventoryKit" + * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts index 3e833859df..10170a650b 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreatePromotionRule.ts @@ -12,13 +12,13 @@ * type: string * description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. * enum: + * - gte + * - lte * - gt * - lt * - eq * - ne * - in - * - lte - * - gte * description: * type: string * title: description @@ -27,7 +27,7 @@ * type: string * title: attribute * description: The attribute to compare against when checking whether a promotion can be applied on a cart. - * example: item.product.id + * example: items.product.id * values: * oneOf: * - type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts b/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts index 0146e126de..ce585e7d24 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateReturnReason.ts @@ -1,7 +1,7 @@ /** * @schema AdminCreateReturnReason * type: object - * description: The details of a return reason to create. + * description: The details of the return reason to create. * x-schemaName: AdminCreateReturnReason * required: * - value diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts index ba2cdbe5f8..1b472c86b6 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRate.ts @@ -6,6 +6,7 @@ * required: * - name * - tax_region_id + * - code * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts index 4ed6a2838d..33caed8c48 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateTaxRegion.ts @@ -23,6 +23,7 @@ * type: object * description: The tax region's default tax rate. * required: + * - code * - name * properties: * rate: diff --git a/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts index 492005c32a..6b6ff947a2 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateVariantInventoryItem.ts @@ -4,8 +4,8 @@ * description: The details of the variant-inventory item association. * x-schemaName: AdminCreateVariantInventoryItem * required: - * - required_quantity * - inventory_item_id + * - required_quantity * properties: * required_quantity: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminCurrency.ts b/www/utils/generated/oas-output/schemas/AdminCurrency.ts index 1534e68d8d..dce4f79075 100644 --- a/www/utils/generated/oas-output/schemas/AdminCurrency.ts +++ b/www/utils/generated/oas-output/schemas/AdminCurrency.ts @@ -10,7 +10,6 @@ * - name * - decimal_digits * - rounding - * - raw_rounding * - created_at * - updated_at * - deleted_at diff --git a/www/utils/generated/oas-output/schemas/AdminCustomer.ts b/www/utils/generated/oas-output/schemas/AdminCustomer.ts index 9af5a8c409..8ec49e0b8a 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomer.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomer.ts @@ -5,6 +5,7 @@ * x-schemaName: AdminCustomer * required: * - has_account + * - addresses * - id * - email * - default_billing_address_id @@ -12,7 +13,6 @@ * - company_name * - first_name * - last_name - * - addresses * properties: * id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts index edfaed861c..c4b3d93828 100644 --- a/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminCustomerGroup.ts @@ -4,9 +4,9 @@ * description: The customer group's details. * x-schemaName: AdminCustomerGroup * required: + * - customers * - id * - name - * - customers * - metadata * - created_at * - updated_at diff --git a/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts index a6db844998..c257a76d4d 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangePreviewResponse.ts @@ -8,7 +8,7 @@ * - exchange * properties: * order_preview: - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * 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 index 27a0f26cf3..fb5e1b6da4 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeRequestResponse.ts @@ -9,11 +9,9 @@ * - exchange * properties: * return: - * description: The associated return's details. * $ref: "#/components/schemas/AdminReturn" * order_preview: - * description: A preview of the order once the exchange is applied. - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * 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 index 756d67aec2..2426fa11b8 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeReturnResponse.ts @@ -8,7 +8,7 @@ * - return * properties: * order_preview: - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * return: * $ref: "#/components/schemas/AdminReturn" * diff --git a/www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts b/www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts deleted file mode 100644 index 54d31e92e1..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminExportProductRequest.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @schema AdminExportProductRequest - * type: object - * description: The export's details - * x-schemaName: AdminExportProductRequest - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminFulfillment.ts index 54b0d33a48..f8987a2341 100644 --- a/www/utils/generated/oas-output/schemas/AdminFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminFulfillment.ts @@ -39,10 +39,8 @@ * title: shipping_option_id * description: The ID of the shipping option this fulfillment is created for. * provider: - * description: The details of the fulfillment provider using to handle this fulfillment. * $ref: "#/components/schemas/AdminFulfillmentProvider" * delivery_address: - * description: The address to deliver the item to. * $ref: "#/components/schemas/AdminFulfillmentAddress" * items: * type: array diff --git a/www/utils/generated/oas-output/schemas/AdminMarkOrderFulfillmentDelivered.ts b/www/utils/generated/oas-output/schemas/AdminMarkOrderFulfillmentDelivered.ts deleted file mode 100644 index 5bcfff9aa2..0000000000 --- a/www/utils/generated/oas-output/schemas/AdminMarkOrderFulfillmentDelivered.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @schema AdminMarkOrderFulfillmentDelivered - * type: object - * description: SUMMARY - * x-schemaName: AdminMarkOrderFulfillmentDelivered - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index 27cdcf4017..ef2d92706a 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -5,21 +5,20 @@ * x-schemaName: AdminOrder * required: * - payment_collections + * - items + * - shipping_methods + * - currency_code * - id + * - created_at + * - updated_at + * - email * - 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 @@ -52,7 +51,7 @@ * type: array * description: The order's fulfillments. * items: - * $ref: "#/components/schemas/BaseOrderFulfillment" + * $ref: "#/components/schemas/AdminOrderFulfillment" * sales_channel: * $ref: "#/components/schemas/AdminSalesChannel" * customer: @@ -98,12 +97,12 @@ * type: array * description: The order's items. * items: - * $ref: "#/components/schemas/BaseOrderLineItem" + * $ref: "#/components/schemas/AdminOrderLineItem" * shipping_methods: * type: array * description: The order's shipping methods. * items: - * $ref: "#/components/schemas/BaseOrderShippingMethod" + * $ref: "#/components/schemas/AdminOrderShippingMethod" * payment_status: * type: string * description: The order's payment status. diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts index 0f7e52cb6d..d260e276b1 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts @@ -1,154 +1,145 @@ /** * @schema AdminOrderChange * type: object - * description: The order preview's order change. + * description: The order change's details. * x-schemaName: AdminOrderChange * required: * - order * - claim - * - return + * - return_order * - exchange - * - id - * - version + * - actions + * - status * - order_id + * - metadata + * - id + * - created_at + * - updated_at + * - version + * - canceled_at * - return_id * - exchange_id * - claim_id - * - return_order - * - 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. - * 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. + * description: The order change's version. This will be the order's version when the change is applied. * change_type: * type: string - * description: The order change's change type. + * description: The order change's type. * enum: * - return * - exchange * - claim * - edit - * - return_request + * order_id: + * type: string + * title: order_id + * description: The ID of the order this change applies on. * return_id: * type: string * title: return_id - * description: The order change's return id. + * description: The ID of the associated return. * exchange_id: * type: string * title: exchange_id - * description: The order change's exchange id. + * description: The ID of the associated exchange. * claim_id: * type: string * title: claim_id - * description: The order change's claim id. + * description: The ID of the associated claim. * order: - * $ref: "#/components/schemas/AdminOrder" + * type: string + * title: order + * description: The order change's order. + * externalDocs: + * url: "#pagination" * return_order: * $ref: "#/components/schemas/AdminReturn" * exchange: * $ref: "#/components/schemas/AdminExchange" * claim: * $ref: "#/components/schemas/AdminClaim" + * actions: + * type: array + * description: The order change's actions. + * items: + * $ref: "#/components/schemas/AdminOrderChangeAction" + * status: + * type: string + * description: The order change's status. + * enum: + * - canceled + * - requested + * - pending + * - confirmed + * - declined + * requested_by: + * type: string + * title: requested_by + * description: The ID of the user that requested the change. + * requested_at: + * type: string + * title: requested_at + * description: The date the order change was requested. + * format: date-time + * confirmed_by: + * type: string + * title: confirmed_by + * description: The ID of the user that confirmed the order change. + * confirmed_at: + * type: string + * title: confirmed_at + * description: The date the order change was confirmed. + * format: date-time + * declined_by: + * type: string + * title: declined_by + * description: The ID of the user that declined the order change. + * declined_reason: + * type: string + * title: declined_reason + * description: The reason the order change was declined. + * metadata: + * type: object + * description: The order change's metadata, can hold custom key-value pairs. + * declined_at: + * type: string + * title: declined_at + * description: The date the order change was declined. + * format: date-time + * canceled_by: + * type: string + * title: canceled_by + * description: The ID of the user that canceled the order change. + * canceled_at: + * type: string + * title: canceled_at + * description: The date the order change was canceled. + * format: date-time + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the order change was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the order change was updated. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts b/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts index 568529b6a8..8faea3d175 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts @@ -1,11 +1,25 @@ /** * @schema AdminOrderChangeAction * type: object - * description: The action's details. + * description: The order change action's details. * x-schemaName: AdminOrderChangeAction + * required: + * - order_change + * - order + * - order_id + * - internal_note + * - id + * - created_at + * - updated_at + * - return_id + * - exchange_id + * - claim_id + * - order_change_id + * - reference + * - reference_id + * - action + * - details * properties: - * order_change: - * $ref: "#/components/schemas/AdminOrderChange" * id: * type: string * title: id @@ -13,11 +27,31 @@ * order_change_id: * type: string * title: order_change_id - * description: The ID of the order change this action belongs to. + * description: The ID of the order change that the action belongs to. + * order_change: + * $ref: "#/components/schemas/AdminOrderChange" * order_id: * type: string * title: order_id - * description: The ID of the associated order. + * description: The ID of the order the associated change is for. + * return_id: + * type: string + * title: return_id + * description: The ID of the associated return. + * claim_id: + * type: string + * title: claim_id + * description: The ID of the associated claim. + * exchange_id: + * type: string + * title: exchange_id + * description: The ID of the associated exchange. + * order: + * type: string + * title: order + * description: The order change's order. + * externalDocs: + * url: "#pagination" * reference: * type: string * title: reference @@ -33,8 +67,23 @@ * description: The ID of the record in the referenced table. * action: * type: string - * title: action * description: The applied action. + * enum: + * - CANCEL_RETURN_ITEM + * - FULFILL_ITEM + * - DELIVER_ITEM + * - CANCEL_ITEM_FULFILLMENT + * - ITEM_ADD + * - ITEM_REMOVE + * - ITEM_UPDATE + * - RECEIVE_DAMAGED_RETURN_ITEM + * - RECEIVE_RETURN_ITEM + * - RETURN_ITEM + * - SHIPPING_ADD + * - SHIPPING_REMOVE + * - SHIP_ITEM + * - WRITE_OFF_ITEM + * - REINSTATE_ITEM * details: * type: object * description: The action's details. @@ -44,47 +93,17 @@ * internal_note: * type: string * title: internal_note - * description: A note viewed only by admin users. + * description: A note that's viewed only by admin users. * created_at: * type: string * format: date-time * title: created_at - * description: The date the order change action was created. + * description: The date the action was created. * updated_at: * type: string * format: date-time * title: updated_at - * description: The date the order change action was updated. - * return_id: - * type: string - * title: return_id - * description: The ID of the associated return. - * claim_id: - * type: string - * title: claim_id - * description: The ID of the associated claim. - * exchange_id: - * type: string - * title: exchange_id - * description: The ID of the associated exchange. - * order: - * $ref: "#/components/schemas/BaseOrder" - * required: - * - order_change - * - id - * - order_change_id - * - order_id - * - reference - * - reference_id - * - action - * - details - * - internal_note - * - created_at - * - updated_at - * - return_id - * - claim_id - * - exchange_id - * - order + * description: The date the action was updated. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts index 2a0edf91b9..caf519784c 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChangesResponse.ts @@ -10,7 +10,7 @@ * type: array * description: An order's changes. * items: - * $ref: "#/components/schemas/BaseOrderChange" + * $ref: "#/components/schemas/AdminOrderChange" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts index d4ea88105f..7e84200037 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderEditPreviewResponse.ts @@ -7,7 +7,7 @@ * - order_preview * properties: * order_preview: - * $ref: "#/components/schemas/OrderPreview" + * $ref: "#/components/schemas/AdminOrderPreview" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderEditResponse.ts b/www/utils/generated/oas-output/schemas/AdminOrderEditResponse.ts index 733e24b919..44b69b919f 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderEditResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderEditResponse.ts @@ -7,7 +7,7 @@ * - order_change * properties: * order_change: - * $ref: "#/components/schemas/OrderChange" + * $ref: "#/components/schemas/AdminOrderChange" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts index 33887ec101..15948b07bb 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts @@ -4,10 +4,24 @@ * description: The item's details. * x-schemaName: AdminOrderLineItem * required: - * - id * - title + * - metadata + * - id * - subtitle * - thumbnail + * - created_at + * - updated_at + * - item_total + * - item_subtotal + * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total * - variant_id * - product_id * - product_title @@ -26,20 +40,6 @@ * - 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: @@ -66,7 +66,7 @@ * title: variant_id * description: The ID of the associated variant. * product: - * $ref: "#/components/schemas/BaseProduct" + * $ref: "#/components/schemas/AdminProduct" * product_id: * type: string * title: product_id diff --git a/www/utils/generated/oas-output/schemas/AdminPayment.ts b/www/utils/generated/oas-output/schemas/AdminPayment.ts index f5ba5a8298..c08218e88e 100644 --- a/www/utils/generated/oas-output/schemas/AdminPayment.ts +++ b/www/utils/generated/oas-output/schemas/AdminPayment.ts @@ -87,11 +87,11 @@ * type: array * description: The details of payment refunds. * items: - * $ref: "#/components/schemas/BaseRefund" + * $ref: "#/components/schemas/AdminRefund" * payment_collection: - * $ref: "#/components/schemas/BasePaymentCollection" + * $ref: "#/components/schemas/AdminPaymentCollection" * payment_session: - * $ref: "#/components/schemas/BasePaymentSession" + * $ref: "#/components/schemas/AdminPaymentSession" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts index de62171cbd..47f94e3ed2 100644 --- a/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts +++ b/www/utils/generated/oas-output/schemas/AdminPaymentCollection.ts @@ -4,12 +4,12 @@ * description: The payment collection's details. * x-schemaName: AdminPaymentCollection * required: + * - payment_providers * - id * - currency_code * - region_id * - amount * - status - * - payment_providers * properties: * id: * type: string @@ -70,17 +70,17 @@ * type: array * description: The payment provider used to process the collection's payments and sessions. * items: - * $ref: "#/components/schemas/BasePaymentProvider" + * $ref: "#/components/schemas/AdminPaymentProvider" * payment_sessions: * type: array * description: The payment collection's payment sessions. * items: - * $ref: "#/components/schemas/BasePaymentSession" + * $ref: "#/components/schemas/AdminPaymentSession" * payments: * type: array * description: The payment collection's payments. * items: - * $ref: "#/components/schemas/BasePayment" + * $ref: "#/components/schemas/AdminPayment" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts b/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts index de6914a19d..6da5a5f34d 100644 --- a/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminPriceListBatchResponse.ts @@ -37,7 +37,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "price" + * default: price * deleted: * type: boolean * title: deleted diff --git a/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts b/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts index 19225dae0e..acf2dc74a1 100644 --- a/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts +++ b/www/utils/generated/oas-output/schemas/AdminPriceListPrice.ts @@ -71,7 +71,7 @@ * type: string * format: date-time * title: deleted_at - * description: The date the price was deleted. + * description: The date the price was deleted. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index 6bee20d545..2080abf78d 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -4,15 +4,15 @@ * description: The product's details. * x-schemaName: AdminProduct * required: + * - variants * - type + * - options + * - images * - length * - title * - status - * - options * - description * - id - * - created_at - * - updated_at * - handle * - subtitle * - is_giftcard @@ -26,9 +26,10 @@ * - material * - collection_id * - type_id - * - images * - discountable * - external_id + * - created_at + * - updated_at * - deleted_at * properties: * collection: @@ -75,7 +76,7 @@ * type: array * description: The product's options. * items: - * $ref: "#/components/schemas/BaseProductOption" + * $ref: "#/components/schemas/AdminProductOption" * description: * type: string * title: description @@ -153,7 +154,7 @@ * type: array * description: The product's images. * items: - * $ref: "#/components/schemas/BaseProductImage" + * $ref: "#/components/schemas/AdminProductImage" * discountable: * type: boolean * title: discountable diff --git a/www/utils/generated/oas-output/schemas/AdminProductOption.ts b/www/utils/generated/oas-output/schemas/AdminProductOption.ts index 009389c3a0..33a6a6dee9 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductOption.ts @@ -25,7 +25,7 @@ * type: array * description: The product option's values. * items: - * $ref: "#/components/schemas/BaseProductOptionValue" + * $ref: "#/components/schemas/AdminProductOptionValue" * metadata: * type: object * description: The product option's metadata, can hold custom key-value pairs. diff --git a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts index fee9974e1e..2f4c9e7213 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductOptionDeleteResponse.ts @@ -16,7 +16,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "product_option" + * default: product_option * deleted: * type: boolean * title: deleted diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts index 61d132adcf..d1670f8d02 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -5,6 +5,7 @@ * x-schemaName: AdminProductVariant * required: * - prices + * - options * - id * - title * - sku @@ -21,7 +22,6 @@ * - length * - height * - width - * - options * - created_at * - updated_at * - deleted_at @@ -107,7 +107,7 @@ * type: array * description: The variant's option values. * items: - * $ref: "#/components/schemas/BaseProductOptionValue" + * $ref: "#/components/schemas/AdminProductOptionValue" * product: * $ref: "#/components/schemas/AdminProduct" * product_id: diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts index 5aa38f61b0..d672dc2fe3 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantDeleteResponse.ts @@ -20,7 +20,7 @@ * type: boolean * title: deleted * description: Whether the product variant was deleted. - * default: "variant" + * default: variant * parent: * $ref: "#/components/schemas/AdminProduct" * diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts index a369bc5c1c..06f6814a41 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariantInventoryLinkDeleteResponse.ts @@ -15,7 +15,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "variant-inventory-item-link" + * default: variant-inventory-item-link * deleted: * type: boolean * title: deleted diff --git a/www/utils/generated/oas-output/schemas/AdminPromotion.ts b/www/utils/generated/oas-output/schemas/AdminPromotion.ts index 479ea6f4ef..d7da27d827 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotion.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotion.ts @@ -6,6 +6,13 @@ * required: * - id * properties: + * application_method: + * $ref: "#/components/schemas/AdminApplicationMethod" + * rules: + * type: array + * description: The promotion's rules. + * items: + * $ref: "#/components/schemas/AdminPromotionRule" * id: * type: string * title: id @@ -25,13 +32,6 @@ * type: boolean * title: is_automatic * description: Whether the promotion is applied on a cart automatically if it matches the promotion's rules. - * 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 diff --git a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts index 06d02086b4..ef796e6cb7 100644 --- a/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts +++ b/www/utils/generated/oas-output/schemas/AdminPromotionRule.ts @@ -22,7 +22,7 @@ * example: customer_group_id * operator: * type: string - * description: The updated's operator. + * description: The rule's operator. * enum: * - gt * - lt @@ -33,7 +33,7 @@ * - gte * values: * type: array - * description: The updated's values. + * description: The rule's values. * example: * - "cusgroup_123" * items: diff --git a/www/utils/generated/oas-output/schemas/AdminRegion.ts b/www/utils/generated/oas-output/schemas/AdminRegion.ts index 4e7ae86411..d009c0536c 100644 --- a/www/utils/generated/oas-output/schemas/AdminRegion.ts +++ b/www/utils/generated/oas-output/schemas/AdminRegion.ts @@ -4,9 +4,9 @@ * description: The region's details. * x-schemaName: AdminRegion * required: - * - id * - name * - currency_code + * - id * properties: * id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminReservation.ts b/www/utils/generated/oas-output/schemas/AdminReservation.ts index d61fa20e2f..99da085fc2 100644 --- a/www/utils/generated/oas-output/schemas/AdminReservation.ts +++ b/www/utils/generated/oas-output/schemas/AdminReservation.ts @@ -11,7 +11,6 @@ * - external_id * - description * - inventory_item_id - * - inventory_item * properties: * id: * type: string @@ -42,8 +41,7 @@ * title: inventory_item_id * description: The ID of the inventory item this reservation is associated with. * inventory_item: - * type: object - * description: The associated inventory item. + * $ref: "#/components/schemas/AdminInventoryItem" * metadata: * type: object * description: The reservation's metadata, can hold custom key-value pairs. diff --git a/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts b/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts index e9a4820713..77b61ae66b 100644 --- a/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminRuleAttributeOption.ts @@ -7,25 +7,23 @@ * - id * - value * - label - * - field_type - * - required * - operators * properties: * id: * type: string * title: id * description: The rule attribute's ID, which is a rule's `attribute` it refers to. - * example: "customer_group" + * example: customer_group * value: * type: string * title: value * description: The rule attribute's value. - * example: "customer.groups.id" + * example: customer.groups.id * label: * type: string * title: label * description: The rule attribute option's label. - * example: "Customer Group" + * example: Customer Group * operators: * type: array * description: The attribute's operators. diff --git a/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts b/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts index f53655235c..cf5f1f0c33 100644 --- a/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminRuleValueOption.ts @@ -11,12 +11,12 @@ * type: string * title: value * description: The rule value's value. - * example: "reg_123" + * example: reg_123 * label: * type: string * title: label * description: The rule value's label. - * example: "Europe Region" + * example: Europe Region * */ diff --git a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts b/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts index 87c44fe313..8c8952f4f9 100644 --- a/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminServiceZoneDeleteResponse.ts @@ -16,7 +16,7 @@ * type: string * title: object * description: The name of the deleted object. - * default: "service_zone" + * default: service_zone * deleted: * type: boolean * title: deleted diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminShippingOption.ts index 89f600fe5d..3bac24907f 100644 --- a/www/utils/generated/oas-output/schemas/AdminShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminShippingOption.ts @@ -33,7 +33,8 @@ * description: The shipping option's name. * price_type: * type: string - * description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider. + * description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated + * fulfillment provider. * enum: * - calculated * - flat @@ -54,7 +55,7 @@ * title: shipping_option_type_id * description: The ID of the associated shipping option type. * type: - * $ref: "#/components/schemas/AdminShippingOption" + * $ref: "#/components/schemas/AdminShippingOptionType" * shipping_profile_id: * type: string * title: shipping_profile_id diff --git a/www/utils/generated/oas-output/schemas/AdminShippingOptionType.ts b/www/utils/generated/oas-output/schemas/AdminShippingOptionType.ts new file mode 100644 index 0000000000..d095e7e3a1 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminShippingOptionType.ts @@ -0,0 +1,53 @@ +/** + * @schema AdminShippingOptionType + * type: object + * description: The shipping option's details. + * x-schemaName: AdminShippingOptionType + * required: + * - id + * - label + * - description + * - code + * - shipping_option_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The shipping option's ID. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the shipping option was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the shipping option was updated. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the shipping option was deleted. + * label: + * type: string + * title: label + * description: The type's label. + * description: + * type: string + * title: description + * description: The type's description. + * code: + * type: string + * title: code + * description: The type's code. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The type's shipping option id. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts index 181682c03f..17f06e1cf7 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts @@ -37,6 +37,7 @@ * description: The price list's rules. * example: * customer_group_id: - * - "cusgrp_123" + * - cusgrp_123 + * */ diff --git a/www/utils/generated/oas-output/schemas/AdminUpdatePromotionRule.ts b/www/utils/generated/oas-output/schemas/AdminUpdatePromotionRule.ts new file mode 100644 index 0000000000..afb930f8bc --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdatePromotionRule.ts @@ -0,0 +1,49 @@ +/** + * @schema AdminUpdatePromotionRule + * type: object + * description: The properties to update in a buy rule. + * required: + * - id + * - values + * properties: + * id: + * type: string + * title: id + * description: The buy rule's ID. + * operator: + * type: string + * description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. + * enum: + * - gte + * - lte + * - gt + * - lt + * - eq + * - ne + * - in + * description: + * type: string + * title: description + * description: The buy rule's description. + * attribute: + * type: string + * title: attribute + * description: The attribute to compare against when checking whether a promotion can be applied on a cart. + * example: items.product.id + * values: + * oneOf: + * - type: string + * title: values + * description: The attribute's value. + * example: prod_123 + * - type: array + * description: The allowed attribute values. + * items: + * type: string + * title: values + * description: An attribute value. + * example: prod_123 + * x-schemaName: AdminUpdatePromotionRule + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateShippingOptionRule.ts b/www/utils/generated/oas-output/schemas/AdminUpdateShippingOptionRule.ts new file mode 100644 index 0000000000..326225e8aa --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateShippingOptionRule.ts @@ -0,0 +1,48 @@ +/** + * @schema AdminUpdateShippingOptionRule + * type: object + * description: The properties to update in the shipping option rule. + * required: + * - id + * - operator + * - attribute + * - value + * properties: + * id: + * type: string + * title: id + * description: The rule's ID. + * operator: + * type: string + * description: The operator used to check whether a rule applies. + * enum: + * - in + * - eq + * - ne + * - gt + * - gte + * - lt + * - lte + * - nin + * attribute: + * type: string + * title: attribute + * description: The name of a property or table that the rule applies to. + * example: customer_group + * value: + * oneOf: + * - type: string + * title: value + * description: A value of the attribute that enables this rule. + * example: cusgroup_123 + * - type: array + * description: Values of the attribute that enable this rule. + * items: + * type: string + * title: value + * description: A value of the attribute that enables this rule. + * example: cusgroup_123 + * x-schemaName: AdminUpdateShippingOptionRule + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts b/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts index 49bc83bd04..c8d8864619 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateVariantInventoryItem.ts @@ -9,7 +9,8 @@ * required_quantity: * type: number * title: required_quantity - * description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. + * description: The number of units a single quantity is equivalent to. For example, if a customer orders one quantity of the variant, Medusa checks the availability of the quantity multiplied by the + * value set for `required_quantity`. When the customer orders the quantity, Medusa reserves the ordered quantity multiplied by the value set for `required_quantity`. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts b/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts deleted file mode 100644 index 97fb5e99ee..0000000000 --- a/www/utils/generated/oas-output/schemas/BaseApplicationMethod.ts +++ /dev/null @@ -1,67 +0,0 @@ -/** - * @schema BaseApplicationMethod - * type: object - * description: The application method's details. - * x-schemaName: BaseApplicationMethod - * required: - * - id - * properties: - * id: - * type: string - * title: id - * description: The application method's ID. - * type: - * type: string - * description: How the associated promotion is applied. `fixed` means a fixed amount is discounted; `percentage` means a percentage of the original amount is discounted. - * enum: - * - fixed - * - percentage - * target_type: - * type: string - * description: Which item does the promotion apply to. `items` mean the promotion applies to the cart's items; `shipping_methods` means the promotion applies to the cart's shipping methods; `order` means the promotion applies on the entire order. - * enum: - * - items - * - shipping_methods - * - order - * allocation: - * type: string - * description: How is the promotion amount discounted. `each` means the discounted amount is applied on each applicable item; `across` means the discounted amount is split accross the applicable items. - * enum: - * - each - * - across - * value: - * type: number - * title: value - * description: The amount to be discounted. - * currency_code: - * type: string - * title: currency_code - * description: The application method's currency code. - * example: usd - * max_quantity: - * type: number - * title: max_quantity - * description: The max quantity allowed in the cart for the associated promotion to be applied. - * buy_rules_min_quantity: - * type: number - * title: buy_rules_min_quantity - * description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. - * apply_to_quantity: - * type: number - * title: apply_to_quantity - * description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `1`. - * promotion: - * $ref: "#/components/schemas/BasePromotion" - * target_rules: - * type: array - * description: The application method's target rules. These rules indicate which items / shipping methods the promotion applies to. - * items: - * $ref: "#/components/schemas/BasePromotionRule" - * buy_rules: - * type: array - * description: The application method's buy rules. These rules indicate which items are part of the "Buy X" rule. - * 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 875cb6e5c8..f4b13a229d 100644 --- a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts +++ b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts @@ -20,7 +20,7 @@ * is_calculated_price_tax_inclusive: * type: boolean * title: is_calculated_price_tax_inclusive - * description: Whether the calculated price is tax inclusive. + * description: Whether the calculated price is tax inclusive. * calculated_amount: * type: number * title: calculated_amount diff --git a/www/utils/generated/oas-output/schemas/BaseClaim.ts b/www/utils/generated/oas-output/schemas/BaseClaim.ts deleted file mode 100644 index 243d9d56b5..0000000000 --- a/www/utils/generated/oas-output/schemas/BaseClaim.ts +++ /dev/null @@ -1,103 +0,0 @@ -/** - * @schema BaseClaim - * type: object - * description: The claim's details. - * x-schemaName: BaseClaim - * required: - * - id - * - type - * - order_id - * - display_id - * - order_version - * - created_at - * - updated_at - * - canceled_at - * - additional_items - * - claim_items - * properties: - * id: - * type: string - * title: id - * description: The claim's ID. - * type: - * type: string - * description: The claim's type. If `refund`, the customer is refunded for the damaged item. If `replace`, new items are sent to the customer. - * enum: - * - refund - * - replace - * order_id: - * type: string - * title: order_id - * description: The ID of the order the claim is created for. - * return_id: - * type: string - * title: return_id - * description: The ID of the returned used to return the items from the customer. - * display_id: - * type: string - * title: display_id - * description: The claim's display ID. - * order_version: - * type: string - * title: order_version - * description: The version of the order when the claim is applied. - * refund_amount: - * type: number - * title: refund_amount - * description: The amount to be refunded. - * created_by: - * type: string - * title: created_by - * description: The ID of the user that created the claim. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The date the claim was created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the claim was updated. - * canceled_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the claim was canceled. - * deleted_at: - * type: string - * format: date-time - * title: deleted_at - * description: The date the claim was deleted. - * additional_items: - * type: array - * description: The items sent to the customer if the claim's type is `replace`. - * items: - * $ref: "#/components/schemas/BaseClaimItem" - * claim_items: - * type: array - * description: The claim items from the original order. - * items: - * $ref: "#/components/schemas/BaseClaimItem" - * no_notification: - * type: boolean - * title: no_notification - * description: Whether to send the customer notifications on the claim's updates. - * order: - * $ref: "#/components/schemas/BaseOrder" - * shipping_methods: - * type: array - * description: The claim's shipping methods, used to send the new items. - * items: - * $ref: "#/components/schemas/BaseOrderShippingMethod" - * transactions: - * type: array - * description: The claim's transactions, such as the refunds made. - * items: - * $ref: "#/components/schemas/BaseOrderTransaction" - * metadata: - * type: object - * description: The claim's metadata, can hold custom key-value pairs. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts index 468a4e9075..60bf42e179 100644 --- a/www/utils/generated/oas-output/schemas/BaseClaimItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseClaimItem.ts @@ -43,6 +43,17 @@ * raw_quantity: * type: object * description: The quantity claimed. + * properties: + * value: + * oneOf: + * - type: string + * title: value + * description: The raw quantity's value. + * - type: number + * title: value + * description: The raw quantity's value. + * required: + * - value * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. diff --git a/www/utils/generated/oas-output/schemas/BaseCollection.ts b/www/utils/generated/oas-output/schemas/BaseCollection.ts index 55999b772b..1d074d9ba9 100644 --- a/www/utils/generated/oas-output/schemas/BaseCollection.ts +++ b/www/utils/generated/oas-output/schemas/BaseCollection.ts @@ -3,50 +3,6 @@ * type: object * description: The collection's details. * x-schemaName: BaseCollection - * 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 date the collection is created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the collection is updated. - * deleted_at: - * type: string - * format: date-time - * title: deleted_at - * description: The date the collection is deleted. - * products: - * type: array - * description: The collection's products. - * items: - * $ref: "#/components/schemas/AdminProduct" - * metadata: - * type: object - * description: The collection's metadata, can hold custom key-value pairs. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseCustomer.ts b/www/utils/generated/oas-output/schemas/BaseCustomer.ts deleted file mode 100644 index 70f759194b..0000000000 --- a/www/utils/generated/oas-output/schemas/BaseCustomer.ts +++ /dev/null @@ -1,78 +0,0 @@ -/** - * @schema BaseCustomer - * type: object - * description: The customer's details. - * x-schemaName: BaseCustomer - * 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 ID of the address used as the default billing address. - * default_shipping_address_id: - * type: string - * title: default_shipping_address_id - * description: The ID of the address used as the default shipping address. - * 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, used to store custom key-value pairs. - * created_by: - * type: string - * title: created_by - * description: The ID of the user that created this customer, if available. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The customer's creation date. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The customer's update date. - * deleted_at: - * type: string - * format: date-time - * title: deleted_at - * description: The customer's deletion date. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BaseOrderChange.ts b/www/utils/generated/oas-output/schemas/BaseOrderChange.ts deleted file mode 100644 index 5453a675b1..0000000000 --- a/www/utils/generated/oas-output/schemas/BaseOrderChange.ts +++ /dev/null @@ -1,154 +0,0 @@ -/** - * @schema BaseOrderChange - * type: object - * description: The order preview's order change. - * x-schemaName: BaseOrderChange - * required: - * - order - * - claim - * - return - * - exchange - * - id - * - version - * - order_id - * - return_id - * - exchange_id - * - claim_id - * - return_order - * - 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. - * 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 - * description: The order change's change type. - * enum: - * - return - * - exchange - * - claim - * - edit - * - return_request - * 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/AdminOrder" - * return_order: - * $ref: "#/components/schemas/AdminReturn" - * exchange: - * $ref: "#/components/schemas/AdminExchange" - * claim: - * $ref: "#/components/schemas/AdminClaim" - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts b/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts index b9eb897f52..da43f1307d 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderItemDetail.ts @@ -6,6 +6,7 @@ * required: * - id * - item_id + * - item * - quantity * - fulfilled_quantity * - delivered_quantity @@ -27,7 +28,7 @@ * title: id * description: the ID of the associated line item. * item: - * $ref: "#/components/schemas/AdminOrderLineItem" + * $ref: "#/components/schemas/BaseOrderLineItem" * quantity: * type: number * title: quantity @@ -74,5 +75,6 @@ * format: date-time * title: updated_at * description: The date the detail was updated. + * */ diff --git a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts index 34b103c121..c7461bb28b 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderLineItem.ts @@ -60,7 +60,7 @@ * title: thumbnail * description: The URL of the item's thumbnail. * variant: - * $ref: "#/components/schemas/AdminProductVariant" + * $ref: "#/components/schemas/BaseProductVariant" * variant_id: * type: string * title: variant_id @@ -215,3 +215,4 @@ * description: The total refundable amount of the item's total for a single quantity. * */ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderShippingDetail.ts b/www/utils/generated/oas-output/schemas/BaseOrderShippingDetail.ts index 1f1c779e72..2df8d26ba8 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderShippingDetail.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderShippingDetail.ts @@ -7,9 +7,6 @@ * - id * - shipping_method_id * - shipping_method - * - claim_id - * - exchange_id - * - return_id * - created_at * - updated_at * properties: diff --git a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts index 0993279f6c..3a1bf9dde7 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderShippingMethod.ts @@ -111,6 +111,8 @@ * format: date-time * title: updated_at * description: The date the shipping method was updated. + * detail: + * $ref: "#/components/schemas/BaseOrderShippingDetail" * */ diff --git a/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts b/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts index 0055fdc59c..9460124a33 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderSummary.ts @@ -12,11 +12,6 @@ * - returned_total * - return_request_total * - write_off_total - * - projected_total - * - net_total - * - net_subtotal - * - net_total_tax - * - balance * - paid_total * - refunded_total * properties: @@ -52,26 +47,6 @@ * type: number * title: write_off_total * description: The total of the items removed from the order. - * 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 diff --git a/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts b/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts index eb5794eb81..043b869198 100644 --- a/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts +++ b/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts @@ -4,17 +4,12 @@ * description: The payment provider's payment providers. * x-schemaName: BasePaymentProvider * required: - * - is_enabled * - id * properties: * id: * type: string * title: id * description: The payment provider's ID. - * is_enabled: - * type: boolean - * title: is_enabled - * description: Whether the payment provider is enabled. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseRefund.ts b/www/utils/generated/oas-output/schemas/BaseRefund.ts index 3e259a6f33..9a03e337d4 100644 --- a/www/utils/generated/oas-output/schemas/BaseRefund.ts +++ b/www/utils/generated/oas-output/schemas/BaseRefund.ts @@ -36,6 +36,8 @@ * description: The ID of the user that created the refund. * payment: * $ref: "#/components/schemas/BasePayment" + * refund_reason: + * $ref: "#/components/schemas/RefundReason" * */ diff --git a/www/utils/generated/oas-output/schemas/BaseReturnItem.ts b/www/utils/generated/oas-output/schemas/BaseReturnItem.ts deleted file mode 100644 index 9e0b07e3fd..0000000000 --- a/www/utils/generated/oas-output/schemas/BaseReturnItem.ts +++ /dev/null @@ -1,8 +0,0 @@ -/** - * @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 index bb039e1c7a..2a1a56a9eb 100644 --- a/www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts +++ b/www/utils/generated/oas-output/schemas/BaseRuleOperatorOptions.ts @@ -12,17 +12,17 @@ * type: string * title: id * description: The operator's ID. - * example: "in" + * example: in * value: * type: string * title: value * description: The operator's value. - * example: "in" + * example: in * label: * type: string * title: label * description: The operator's label. - * example: "In" + * example: In * */ diff --git a/www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts b/www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts deleted file mode 100644 index 478f672b70..0000000000 --- a/www/utils/generated/oas-output/schemas/CreateOrderReturnReason.ts +++ /dev/null @@ -1,31 +0,0 @@ -/** - * @schema CreateOrderReturnReason - * type: object - * description: The details of the return reason to create. - * x-schemaName: CreateOrderReturnReason - * required: - * - value - * - label - * properties: - * 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. - * parent_return_reason_id: - * type: string - * title: parent_return_reason_id - * description: The return reason's parent return reason id. - * metadata: - * type: object - * description: The return reason's metadata. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/OrderPreview.ts b/www/utils/generated/oas-output/schemas/OrderPreview.ts deleted file mode 100644 index 688e53ab92..0000000000 --- a/www/utils/generated/oas-output/schemas/OrderPreview.ts +++ /dev/null @@ -1,1555 +0,0 @@ -/** - * @schema OrderPreview - * type: object - * description: The order edit's order preview. - * x-schemaName: OrderPreview - * required: - * - order_change - * - status - * - currency_code - * - version - * - id - * - 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: - * order_change: - * $ref: "#/components/schemas/OrderChange" - * items: - * type: array - * description: The order preview's items. - * items: - * allOf: - * - type: object - * description: The item's items. - * x-schemaName: OrderLineItem - * required: - * - id - * - title - * - requires_shipping - * - is_discountable - * - is_tax_inclusive - * - unit_price - * - raw_unit_price - * - quantity - * - raw_quantity - * - detail - * - created_at - * - updated_at - * - original_total - * - original_subtotal - * - original_tax_total - * - item_total - * - item_subtotal - * - item_tax_total - * - total - * - subtotal - * - tax_total - * - discount_total - * - discount_tax_total - * - refundable_total - * - refundable_total_per_unit - * - raw_original_total - * - raw_original_subtotal - * - raw_original_tax_total - * - raw_item_total - * - raw_item_subtotal - * - raw_item_tax_total - * - raw_total - * - raw_subtotal - * - raw_tax_total - * - raw_discount_total - * - raw_discount_tax_total - * - raw_refundable_total - * - raw_refundable_total_per_unit - * properties: - * id: - * type: string - * title: id - * description: The item's ID. - * title: - * type: string - * title: title - * description: The item's title. - * subtitle: - * type: string - * title: subtitle - * description: The item's subtitle. - * thumbnail: - * type: string - * title: thumbnail - * description: The item's thumbnail. - * variant_id: - * type: string - * title: variant_id - * description: The item's variant id. - * product_id: - * type: string - * title: product_id - * description: The item's product id. - * product_title: - * type: string - * title: product_title - * description: The item's product title. - * product_description: - * type: string - * title: product_description - * description: The item's product description. - * product_subtitle: - * type: string - * title: product_subtitle - * description: The item's product subtitle. - * product_type: - * type: string - * title: product_type - * description: The item's product type. - * product_collection: - * type: string - * title: product_collection - * description: The item's product collection. - * product_handle: - * type: string - * title: product_handle - * description: The item's product handle. - * variant_sku: - * type: string - * title: variant_sku - * description: The item's variant sku. - * variant_barcode: - * type: string - * title: variant_barcode - * description: The item's variant barcode. - * variant_title: - * type: string - * title: variant_title - * description: The item's variant title. - * variant_option_values: - * type: object - * description: The item's variant option values. - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: The item's requires shipping. - * is_discountable: - * type: boolean - * title: is_discountable - * description: The item's is discountable. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: The item's is tax inclusive. - * compare_at_unit_price: - * type: number - * title: compare_at_unit_price - * description: The item's compare at unit price. - * raw_compare_at_unit_price: - * type: object - * description: The item's raw compare at unit price. - * unit_price: - * type: number - * title: unit_price - * description: The item's unit price. - * raw_unit_price: - * type: object - * description: The item's raw unit price. - * quantity: - * type: number - * title: quantity - * description: The item's quantity. - * raw_quantity: - * type: object - * description: The item's raw quantity. - * tax_lines: - * type: array - * description: The item's tax lines. - * items: - * $ref: "#/components/schemas/OrderLineItemTaxLine" - * adjustments: - * type: array - * description: The item's adjustments. - * items: - * $ref: "#/components/schemas/OrderLineItemAdjustment" - * detail: - * $ref: "#/components/schemas/OrderItem" - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The item's created at. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The item's updated at. - * metadata: - * type: object - * description: The item's metadata. - * original_total: - * oneOf: - * - type: string - * title: original_total - * description: The item's original total. - * - type: number - * title: original_total - * description: The item's original total. - * - type: string - * title: original_total - * description: The item's original total. - * - $ref: "#/components/schemas/IBigNumber" - * original_subtotal: - * oneOf: - * - type: string - * title: original_subtotal - * description: The item's original subtotal. - * - type: number - * title: original_subtotal - * description: The item's original subtotal. - * - type: string - * title: original_subtotal - * description: The item's original subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * original_tax_total: - * oneOf: - * - type: string - * title: original_tax_total - * description: The item's original tax total. - * - type: number - * title: original_tax_total - * description: The item's original tax total. - * - type: string - * title: original_tax_total - * description: The item's original tax total. - * - $ref: "#/components/schemas/IBigNumber" - * item_total: - * oneOf: - * - type: string - * title: item_total - * description: The item's item total. - * - type: number - * title: item_total - * description: The item's item total. - * - type: string - * title: item_total - * description: The item's item total. - * - $ref: "#/components/schemas/IBigNumber" - * item_subtotal: - * oneOf: - * - type: string - * title: item_subtotal - * description: The item's item subtotal. - * - type: number - * title: item_subtotal - * description: The item's item subtotal. - * - type: string - * title: item_subtotal - * description: The item's item subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * item_tax_total: - * oneOf: - * - type: string - * title: item_tax_total - * description: The item's item tax total. - * - type: number - * title: item_tax_total - * description: The item's item tax total. - * - type: string - * title: item_tax_total - * description: The item's item tax total. - * - $ref: "#/components/schemas/IBigNumber" - * total: - * oneOf: - * - type: string - * title: total - * description: The item's total. - * - type: number - * title: total - * description: The item's total. - * - type: string - * title: total - * description: The item's total. - * - $ref: "#/components/schemas/IBigNumber" - * subtotal: - * oneOf: - * - type: string - * title: subtotal - * description: The item's subtotal. - * - type: number - * title: subtotal - * description: The item's subtotal. - * - type: string - * title: subtotal - * description: The item's subtotal. - * - $ref: "#/components/schemas/IBigNumber" - * tax_total: - * oneOf: - * - type: string - * title: tax_total - * description: The item's tax total. - * - type: number - * title: tax_total - * description: The item's tax total. - * - type: string - * title: tax_total - * description: The item's tax total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_total: - * oneOf: - * - type: string - * title: discount_total - * description: The item's discount total. - * - type: number - * title: discount_total - * description: The item's discount total. - * - type: string - * title: discount_total - * description: The item's discount total. - * - $ref: "#/components/schemas/IBigNumber" - * discount_tax_total: - * oneOf: - * - type: string - * title: discount_tax_total - * description: The item's discount tax total. - * - type: number - * title: discount_tax_total - * description: The item's discount tax total. - * - type: string - * title: discount_tax_total - * description: The item's discount tax total. - * - $ref: "#/components/schemas/IBigNumber" - * refundable_total: - * oneOf: - * - type: string - * title: refundable_total - * description: The item's refundable total. - * - type: number - * title: refundable_total - * description: The item's refundable total. - * - type: string - * title: refundable_total - * description: The item's refundable total. - * - $ref: "#/components/schemas/IBigNumber" - * refundable_total_per_unit: - * oneOf: - * - type: string - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - type: number - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - type: string - * title: refundable_total_per_unit - * description: The item's refundable total per unit. - * - $ref: "#/components/schemas/IBigNumber" - * raw_original_total: - * type: object - * description: The item's raw original total. - * raw_original_subtotal: - * type: object - * description: The item's raw original subtotal. - * raw_original_tax_total: - * type: object - * description: The item's raw original tax total. - * raw_item_total: - * type: object - * description: The item's raw item total. - * raw_item_subtotal: - * type: object - * description: The item's raw item subtotal. - * raw_item_tax_total: - * type: object - * description: The item's raw item tax total. - * raw_total: - * type: object - * description: The item's raw total. - * raw_subtotal: - * type: object - * description: The item's raw subtotal. - * raw_tax_total: - * type: object - * description: The item's raw tax total. - * raw_discount_total: - * type: object - * description: The item's raw discount total. - * raw_discount_tax_total: - * type: object - * description: The item's raw discount tax total. - * raw_refundable_total: - * type: object - * description: The item's raw refundable total. - * raw_refundable_total_per_unit: - * type: object - * description: The item's raw refundable total per unit. - * - 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: OrderChangeAction - * shipping_methods: - * type: array - * description: The order preview's shipping methods. - * items: - * allOf: - * - 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. - * - 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: OrderChangeAction - * status: - * type: string - * description: The order preview's status. - * enum: - * - canceled - * - requires_action - * - pending - * - completed - * - draft - * - archived - * currency_code: - * type: string - * title: currency_code - * description: The order preview's currency code. - * version: - * type: number - * title: version - * description: The order preview's version. - * id: - * type: string - * title: id - * description: The order preview's ID. - * 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 - * shipping_address: - * $ref: "#/components/schemas/OrderAddress" - * billing_address: - * $ref: "#/components/schemas/OrderAddress" - * 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 - * - pending_difference - * - raw_pending_difference - * 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 - * pending_difference: - * oneOf: - * - type: string - * title: pending_difference - * description: The summary's pending difference. - * - type: number - * title: pending_difference - * description: The summary's pending difference. - * - type: string - * title: pending_difference - * description: The summary's pending difference. - * - type: object - * description: The summary's pending difference. - * x-schemaName: IBigNumber - * raw_pending_difference: - * type: object - * description: The summary's raw pending difference. - * 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: - * 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" - * 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 - * 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/ReservationResponse.ts b/www/utils/generated/oas-output/schemas/ReservationResponse.ts deleted file mode 100644 index 1702fe4ee7..0000000000 --- a/www/utils/generated/oas-output/schemas/ReservationResponse.ts +++ /dev/null @@ -1,71 +0,0 @@ -/** - * @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/StoreCalculateCartTaxes.ts b/www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts deleted file mode 100644 index 13e68b23cf..0000000000 --- a/www/utils/generated/oas-output/schemas/StoreCalculateCartTaxes.ts +++ /dev/null @@ -1,13 +0,0 @@ -/** - * @schema StoreCalculateCartTaxes - * type: object - * description: SUMMARY - * x-schemaName: StoreCalculateCartTaxes - * properties: - * fields: - * type: string - * title: fields - * description: The cart's fields. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreCart.ts b/www/utils/generated/oas-output/schemas/StoreCart.ts index 8aac82e9fd..61aae0b093 100644 --- a/www/utils/generated/oas-output/schemas/StoreCart.ts +++ b/www/utils/generated/oas-output/schemas/StoreCart.ts @@ -4,8 +4,8 @@ * description: The cart's details. * x-schemaName: StoreCart * required: - * - id * - currency_code + * - id * - original_item_total * - original_item_subtotal * - original_item_tax_total @@ -34,7 +34,7 @@ * title: id * description: The cart's ID. * region: - * $ref: "#/components/schemas/BaseRegion" + * $ref: "#/components/schemas/StoreRegion" * region_id: * type: string * title: region_id @@ -70,9 +70,9 @@ * type: array * description: The cart's shipping methods. * items: - * $ref: "#/components/schemas/BaseCartShippingMethod" + * $ref: "#/components/schemas/StoreCartShippingMethod" * payment_collection: - * $ref: "#/components/schemas/BasePaymentCollection" + * $ref: "#/components/schemas/StorePaymentCollection" * metadata: * type: object * description: The cart's metadata, can hold custom key-value pairs. diff --git a/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts index c28f33d6fc..39300e3182 100644 --- a/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreCartLineItem.ts @@ -4,26 +4,26 @@ * description: The item's details. * x-schemaName: StoreCartLineItem * required: - * - id - * - title - * - quantity - * - requires_shipping - * - is_discountable - * - is_tax_inclusive - * - unit_price * - cart - * - cart_id - * - original_total - * - original_subtotal - * - original_tax_total + * - title + * - id * - item_total * - item_subtotal * - item_tax_total + * - original_total + * - original_subtotal + * - original_tax_total * - total * - subtotal * - tax_total * - discount_total * - discount_tax_total + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - quantity + * - cart_id * properties: * id: * type: string @@ -76,7 +76,7 @@ * title: product_handle * description: The item's product handle. * variant: - * $ref: "#/components/schemas/BaseProductVariant" + * $ref: "#/components/schemas/StoreProductVariant" * variant_id: * type: string * title: variant_id @@ -122,12 +122,154 @@ * type: array * description: The item's tax lines. * items: - * $ref: "#/components/schemas/BaseLineItemTaxLine" + * allOf: + * - type: object + * description: The tax line's details. + * x-schemaName: BaseLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * title: item + * description: The details of the item that the tax line belongs to. + * item_id: + * type: string + * title: item_id + * description: The ID of the line item this tax line belongs to. + * total: + * type: number + * title: total + * description: The item's total including taxes and promotions. + * subtotal: + * type: number + * title: subtotal + * description: The item's total excluding taxes, including promotions. + * id: + * type: string + * title: id + * description: The tax line's ID. + * description: + * type: string + * title: description + * description: The tax line's description. + * tax_rate_id: + * type: string + * title: tax_rate_id + * description: The ID of the applied tax rate. + * code: + * type: string + * title: code + * description: The code that the tax rate is identified by. + * rate: + * type: number + * title: rate + * description: The charged rate. + * provider_id: + * type: string + * title: provider_id + * description: The ID of the tax provider used to calculate the tax line. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the tax line was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the tax line was updated. + * - type: object + * description: The tax line's details. + * required: + * - item + * properties: + * item: + * type: object + * title: item + * description: The details of the item that the tax line belongs to. + * description: The tax line's details * adjustments: * type: array * description: The item's adjustments. * items: - * $ref: "#/components/schemas/BaseLineItemAdjustment" + * allOf: + * - type: object + * description: The adjustment's details. + * x-schemaName: BaseLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - cart_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * title: item + * description: The details of the item that the adjustment belongs to. + * item_id: + * type: string + * title: item_id + * description: The ID of the item that the adjustment belongs to. + * id: + * type: string + * title: id + * description: The adjustment's ID. + * code: + * type: string + * title: code + * description: The adjustment's code. + * amount: + * type: number + * title: amount + * description: The adjustment's amount. + * cart_id: + * type: string + * title: cart_id + * description: The ID of the associated cart. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The ID of the applied promotion. + * provider_id: + * type: string + * title: provider_id + * description: The adjustment's provider ID. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the adjustment was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the adjustment was updated. + * - type: object + * description: The adjustment's details. + * required: + * - item + * properties: + * item: + * type: object + * title: item + * description: The details of the item that the adjustment belongs to. + * description: The adjustment's details. * cart: * $ref: "#/components/schemas/StoreCart" * cart_id: diff --git a/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts b/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts index 7dcb01b665..107cd07752 100644 --- a/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/StoreCartShippingMethod.ts @@ -60,12 +60,150 @@ * type: array * description: The shipping method's tax lines. * items: - * $ref: "#/components/schemas/BaseShippingMethodTaxLine" + * allOf: + * - type: object + * description: The tax line's details + * x-schemaName: BaseShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * title: shipping_method + * description: The details of the method that the tax line belongs to. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The ID of the shipping method this tax line belongs to. + * total: + * type: number + * title: total + * description: The method's total including taxes and promotions. + * subtotal: + * type: number + * title: subtotal + * description: The method's total excluding taxes, including promotions. + * id: + * type: string + * title: id + * description: The tax line's ID. + * description: + * type: string + * title: description + * description: The tax line's description. + * tax_rate_id: + * type: string + * title: tax_rate_id + * description: The ID of the applied tax rate. + * code: + * type: string + * title: code + * description: The code that the tax rate is identified by. + * rate: + * type: number + * title: rate + * description: The charged rate. + * provider_id: + * type: string + * title: provider_id + * description: The ID of the tax provider used to calculate the tax line. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the tax line was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the tax line was updated. + * - type: object + * description: The tax line's details. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * title: shipping_method + * description: The details of the method that the tax line belongs to. + * description: The tax line's details. * adjustments: * type: array * description: The shipping method's adjustments, such as applied promotions. * items: - * $ref: "#/components/schemas/BaseShippingMethodAdjustment" + * allOf: + * - type: object + * description: The adjustment's details. + * x-schemaName: BaseShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - cart_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * title: shipping_method + * description: The details of the method that the adjustment belongs to. + * id: + * type: string + * title: id + * description: The adjustment's ID. + * code: + * type: string + * title: code + * description: The adjustment's code. + * amount: + * type: number + * title: amount + * description: The adjustment's amount. + * cart_id: + * type: string + * title: cart_id + * description: The ID of the associated cart. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The ID of the applied promotion. + * provider_id: + * type: string + * title: provider_id + * description: The adjustment's provider ID. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the adjustment was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the adjustment was updated. + * - type: object + * description: The adjustment's details. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * title: shipping_method + * description: The details of the method that the adjustment belongs to. + * description: The adjustment's details. * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreCollection.ts b/www/utils/generated/oas-output/schemas/StoreCollection.ts index b2a10aa055..7f29948769 100644 --- a/www/utils/generated/oas-output/schemas/StoreCollection.ts +++ b/www/utils/generated/oas-output/schemas/StoreCollection.ts @@ -4,13 +4,13 @@ * description: The collection's details. * x-schemaName: StoreCollection * required: - * - id * - title + * - metadata + * - id * - handle * - created_at * - updated_at * - deleted_at - * - metadata * properties: * id: * type: string diff --git a/www/utils/generated/oas-output/schemas/StoreCurrency.ts b/www/utils/generated/oas-output/schemas/StoreCurrency.ts index b962160490..fecf22e57f 100644 --- a/www/utils/generated/oas-output/schemas/StoreCurrency.ts +++ b/www/utils/generated/oas-output/schemas/StoreCurrency.ts @@ -10,7 +10,6 @@ * - name * - decimal_digits * - rounding - * - raw_rounding * - created_at * - updated_at * - deleted_at diff --git a/www/utils/generated/oas-output/schemas/StoreCustomer.ts b/www/utils/generated/oas-output/schemas/StoreCustomer.ts index 8f563c411e..cc2b5e4246 100644 --- a/www/utils/generated/oas-output/schemas/StoreCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreCustomer.ts @@ -4,14 +4,14 @@ * description: The customer's details. * x-schemaName: StoreCustomer * required: + * - addresses * - id * - email - * - default_billing_address_id - * - default_shipping_address_id * - company_name * - first_name * - last_name - * - addresses + * - default_billing_address_id + * - default_shipping_address_id * properties: * id: * type: string diff --git a/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts b/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts index cb10bb5228..efdf6120d7 100644 --- a/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts +++ b/www/utils/generated/oas-output/schemas/StoreCustomerAddress.ts @@ -86,7 +86,7 @@ * description: The address's phone. * metadata: * type: object - * description: The address's metadata, can hold custom key-value pairs. + * description: The address's metadata, can hold custom key-value pairs. * created_at: * type: string * format: date-time diff --git a/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts b/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts deleted file mode 100644 index df464d2708..0000000000 --- a/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts +++ /dev/null @@ -1,78 +0,0 @@ -/** - * @schema StoreOrderAddress - * type: object - * description: The address's details. - * x-schemaName: StoreOrderAddress - * required: - * - id - * - metadata - * - created_at - * - updated_at - * properties: - * country: - * $ref: "#/components/schemas/StoreRegionCountry" - * id: - * type: string - * title: id - * description: The address's ID. - * customer_id: - * type: string - * title: customer_id - * description: The ID of the customer this address belongs to. - * 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. - * phone: - * type: string - * title: phone - * description: The address's phone. - * company: - * type: string - * title: company - * description: The address's company. - * address_1: - * type: string - * title: address_1 - * description: The address's first line. - * address_2: - * type: string - * title: address_2 - * description: The address's second line. - * city: - * type: string - * title: city - * description: The address's city. - * country_code: - * type: string - * title: country_code - * description: The address's country code. - * example: us - * province: - * type: string - * title: province - * description: The address's province. - * postal_code: - * type: string - * title: postal_code - * description: The address's postal code. - * metadata: - * type: object - * description: The address's metadata, can hold custom key-value pairs. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The date the address was created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the address was updated. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts deleted file mode 100644 index 39ca36d9e7..0000000000 --- a/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts +++ /dev/null @@ -1,81 +0,0 @@ -/** - * @schema StoreOrderFulfillment - * type: object - * description: The fulfillment's details. - * x-schemaName: StoreOrderFulfillment - * required: - * - id - * - location_id - * - packed_at - * - shipped_at - * - delivered_at - * - canceled_at - * - requires_shipping - * - 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 ID of the location the items are fulfilled from. - * packed_at: - * type: string - * title: packed_at - * description: The date the fulfillment was packed. - * format: date-time - * shipped_at: - * type: string - * title: shipped_at - * description: The date the fulfillment was shipped. - * format: date-time - * delivered_at: - * type: string - * title: delivered_at - * description: The date the fulfillment was delivered. - * format: date-time - * canceled_at: - * type: string - * title: canceled_at - * description: The date the fulfillment was canceled. - * format: date-time - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: Whether the fulfillment requires shipping. - * data: - * type: object - * description: The fulfillment's data, useful for the fulfillment providering handling it. - * externalDocs: - * url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/item-fulfillment#data-property - * provider_id: - * type: string - * title: provider_id - * description: The ID of the provider handling this fulfillment. - * shipping_option_id: - * type: string - * title: shipping_option_id - * description: The ID of the associated shipping option. - * metadata: - * type: object - * description: The fulfillment's metadata, can hold custom key-value pairs. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The date the fulfillment was created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the fulfillment was updated. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts deleted file mode 100644 index f757d70e49..0000000000 --- a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts +++ /dev/null @@ -1,218 +0,0 @@ -/** - * @schema StoreOrderLineItem - * type: object - * description: The item's details. - * x-schemaName: StoreOrderLineItem - * required: - * - title - * - id - * - metadata - * - created_at - * - updated_at - * - item_total - * - item_subtotal - * - item_tax_total - * - original_total - * - original_subtotal - * - original_tax_total - * - total - * - subtotal - * - tax_total - * - discount_total - * - discount_tax_total - * - 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 - * - refundable_total - * - refundable_total_per_unit - * properties: - * variant: - * $ref: "#/components/schemas/StoreProductVariant" - * product: - * $ref: "#/components/schemas/StoreProduct" - * title: - * type: string - * title: title - * description: The item's title. - * id: - * type: string - * title: id - * description: The item's ID. - * metadata: - * type: object - * description: The item's metadata, can hold custom key-value pairs. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The date the item was created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the item was updated. - * item_total: - * type: number - * title: item_total - * description: The total of a single quantity including taxes and promotions. - * item_subtotal: - * type: number - * title: item_subtotal - * description: The total of a single quantity excluding taxes, including promotions. - * item_tax_total: - * type: number - * title: item_tax_total - * description: The total taxes of a single quantity, including promotions. - * original_total: - * type: number - * title: original_total - * description: The item's total including taxes, excluding promotions. - * original_subtotal: - * type: number - * title: original_subtotal - * description: The item's total excluding taxes, including promotions. - * original_tax_total: - * type: number - * title: original_tax_total - * description: The total taxes of the item, excluding promotions. - * total: - * type: number - * title: total - * description: The item's total including taxes and promotions. - * subtotal: - * type: number - * title: subtotal - * description: The item's total excluding taxes, including promotions. - * tax_total: - * type: number - * title: tax_total - * description: The total taxes of the item, including promotions. - * discount_total: - * type: number - * title: discount_total - * description: The item's discount total. - * discount_tax_total: - * type: number - * title: discount_tax_total - * description: The total taxes applied on the discount amount. - * subtitle: - * type: string - * title: subtitle - * description: The item's subtitle. - * thumbnail: - * type: string - * title: thumbnail - * description: The item's thumbnail URL. - * variant_id: - * type: string - * title: variant_id - * description: The ID of the item's variant. - * product_id: - * type: string - * title: product_id - * description: The ID of the associated product. - * 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 ID of the associated product's type. - * product_collection: - * type: string - * title: product_collection - * description: The ID of the associated product's 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 associated variant's values of the associated product's options. - * example: - * Color: Red - * requires_shipping: - * type: boolean - * title: requires_shipping - * description: Whether the item requires shipping. - * is_discountable: - * type: boolean - * title: is_discountable - * description: Whether the item is discountable. - * is_tax_inclusive: - * type: boolean - * title: is_tax_inclusive - * description: Whether the item includes taxes. - * compare_at_unit_price: - * type: number - * title: compare_at_unit_price - * description: The original price of the item before a promotion or sale. - * 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" - * refundable_total: - * type: number - * title: refundable_total - * description: The refundable amount of the item. - * refundable_total_per_unit: - * type: number - * title: refundable_total_per_unit - * description: The refundable amount for a single quantity of the item. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts deleted file mode 100644 index ec1ec52e62..0000000000 --- a/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts +++ /dev/null @@ -1,118 +0,0 @@ -/** - * @schema StoreOrderShippingMethod - * type: object - * description: The shipping method's details. - * x-schemaName: StoreOrderShippingMethod - * 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 ID of the associated order. - * 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: Whether the shipping method's amount includes taxes. - * shipping_option_id: - * type: string - * title: shipping_option_id - * description: The ID of the associated shipping method. - * data: - * type: object - * description: The shipping method's data, useful for the provider handling its fulfillment. - * externalDocs: - * url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property - * metadata: - * type: object - * description: The shipping method's metadata, can hold custom key-value pairs. - * 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: - * type: number - * title: original_total - * description: The total of the shipping method including taxes, excluding promotions. - * original_subtotal: - * type: number - * title: original_subtotal - * description: The total of the shipping method excluding taxes, including promotions. - * original_tax_total: - * type: number - * title: original_tax_total - * description: The total taxes of the shipping method, excluding promotion. - * total: - * type: number - * title: total - * description: The total of the shipping method including taxes and promotions. - * detail: - * $ref: "#/components/schemas/BaseOrderShippingDetail" - * subtotal: - * type: number - * title: subtotal - * description: The shipping method's subtotal. - * tax_total: - * type: number - * title: tax_total - * description: The shipping method's tax total. - * discount_total: - * type: number - * title: discount_total - * description: The shipping method's discount total. - * discount_tax_total: - * type: number - * title: discount_tax_total - * description: The shipping method's discount tax total. - * created_at: - * type: string - * format: date-time - * title: created_at - * description: The date the shipping method was created. - * updated_at: - * type: string - * format: date-time - * title: updated_at - * description: The date the shipping method was updated. - * -*/ - diff --git a/www/utils/generated/oas-output/schemas/StoreReturn.ts b/www/utils/generated/oas-output/schemas/StoreReturn.ts index f023733d35..d892f6a398 100644 --- a/www/utils/generated/oas-output/schemas/StoreReturn.ts +++ b/www/utils/generated/oas-output/schemas/StoreReturn.ts @@ -4,14 +4,13 @@ * description: The return's details. * x-schemaName: StoreReturn * required: - * - id - * - order_id - * - order_version - * - display_id * - items - * - received_at + * - order_id + * - id * - created_at + * - display_id * - canceled_at + * - received_at * properties: * id: * type: string @@ -37,18 +36,10 @@ * type: string * title: claim_id * description: The ID of the associated claim. - * order_version: - * type: number - * title: order_version - * description: The version of the order when the return is applied. * display_id: * type: number * title: display_id * description: The return's display ID. - * no_notification: - * type: boolean - * title: no_notification - * description: Whether the customer should receive updates about changes in the return. * refund_amount: * type: number * title: refund_amount @@ -57,7 +48,7 @@ * type: array * description: The return's items. * items: - * $ref: "#/components/schemas/BaseReturnItem" + * $ref: "#/components/schemas/StoreReturnItem" * received_at: * type: string * title: received_at diff --git a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts index d1a177d67e..6e4477c5c9 100644 --- a/www/utils/generated/oas-output/schemas/StoreShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/StoreShippingOption.ts @@ -28,7 +28,8 @@ * description: The shipping option's name. * price_type: * type: string - * description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated fulfillment provider. + * description: The shipping option's price type. If it's `flat`, the price is fixed and is set in the `prices` property. If it's `calculated`, the price is calculated on checkout by the associated + * fulfillment provider. * enum: * - flat * - calculated @@ -47,7 +48,7 @@ * title: shipping_option_type_id * description: The ID of the shipping option's type. * type: - * $ref: "#/components/schemas/StoreShippingOption" + * $ref: "#/components/schemas/StoreShippingOptionType" * shipping_profile_id: * type: string * title: shipping_profile_id diff --git a/www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts b/www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts deleted file mode 100644 index 77d26eaea8..0000000000 --- a/www/utils/generated/oas-output/schemas/UpdateOrderReturnReason.ts +++ /dev/null @@ -1,28 +0,0 @@ -/** - * @schema UpdateOrderReturnReason - * type: object - * description: The details to update in a return reason. - * x-schemaName: UpdateOrderReturnReason - * properties: - * id: - * type: string - * title: id - * description: The return reason's ID. - * label: - * type: string - * title: label - * description: The return reason's label. - * value: - * type: string - * title: value - * description: The return reason's value. - * description: - * type: string - * title: description - * description: The return reason's description. - * metadata: - * type: object - * description: The return reason's metadata, can hold custom key-value pairs. - * -*/ -