From 8209d936a0b8a8043fcc0f8610dc2a8c57674c0e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 17:14:26 +0000 Subject: [PATCH] chore(docs): Updated API Reference (v2) (#9666) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com> Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- .../Shell/admin_orders_{id}_line-items/get.sh | 2 + .../code_samples/Shell/admin_products/post.sh | 8 +- .../Shell/admin_tax-regions_{id}/post.sh | 2 + .../schemas/AdminCreateFulfillment.yaml | 4 +- .../schemas/AdminCreateProduct.yaml | 1 + .../schemas/AdminCreateShippingOption.yaml | 92 +- .../AdminCreateShippingOptionType.yaml | 20 + .../components/schemas/AdminExchange.yaml | 2 +- .../schemas/AdminExchangeOrderResponse.yaml | 1 - .../admin/components/schemas/AdminOrder.yaml | 6 +- .../components/schemas/AdminOrderChange.yaml | 12 +- .../schemas/AdminOrderChangeAction.yaml | 10 +- .../components/schemas/AdminOrderItem.yaml | 45 + .../schemas/AdminOrderLineItem.yaml | 6 +- .../components/schemas/AdminOrderPreview.yaml | 6 +- .../AdminPostOrderEditsAddItemsReqSchema.yaml | 4 + ...minPostOrderEditsItemsActionReqSchema.yaml | 4 + ...OrderEditsUpdateItemQuantityReqSchema.yaml | 4 + .../components/schemas/AdminProduct.yaml | 8 +- .../schemas/AdminUpdateTaxRegion.yaml | 11 + .../schemas/BaseCalculatedPriceSet.yaml | 54 - .../components/schemas/BaseCollection.yaml | 46 +- .../admin/components/schemas/BaseOrder.yaml | 12 +- .../components/schemas/BaseOrderAddress.yaml | 4 +- .../schemas/BaseOrderFulfillment.yaml | 7 +- .../schemas/BasePaymentProvider.yaml | 2 +- .../schemas/BaseProductCategory.yaml | 83 +- .../components/schemas/BaseProductOption.yaml | 22 +- .../components/schemas/BaseProductTag.yaml | 34 +- .../specs/admin/components/schemas/Order.yaml | 88 - .../admin/components/schemas/OrderClaim.yaml | 246 +- .../components/schemas/OrderExchange.yaml | 244 +- .../admin/components/schemas/OrderItem.yaml | 32 - .../components/schemas/OrderLineItem.yaml | 239 - .../schemas/OrderLineItemTaxLine.yaml | 8 - .../components/schemas/OrderReturnItem.yaml | 31 +- .../schemas/OrderShippingMethod.yaml | 135 - .../schemas/OrderShippingMethodTaxLine.yaml | 8 - .../components/schemas/OrderTransaction.yaml | 3 + .../admin/components/schemas/Return.yaml | 296 +- .../components/schemas/StoreCollection.yaml | 4 +- .../admin/components/schemas/StoreOrder.yaml | 31 +- .../components/schemas/StoreOrderAddress.yaml | 73 + .../schemas/StoreOrderFulfillment.yaml | 79 + .../schemas/StoreOrderLineItem.yaml | 4011 +++++++ .../schemas/StoreOrderShippingMethod.yaml | 1714 +++ .../components/schemas/StoreProduct.yaml | 8 +- .../schemas/StoreProductVariant.yaml | 4 +- .../schemas/StoreRegionCountry.yaml | 33 + .../admin/components/schemas/StoreReturn.yaml | 4 +- .../specs/admin/openapi.full.yaml | 9841 +++++++++++------ .../api-reference/specs/admin/openapi.yaml | 2 + .../specs/admin/paths/admin_api-keys.yaml | 10 - .../admin/paths/admin_api-keys_{id}.yaml | 20 - .../paths/admin_api-keys_{id}_revoke.yaml | 10 - .../admin_api-keys_{id}_sales-channels.yaml | 10 - .../specs/admin/paths/admin_campaigns.yaml | 20 - .../admin/paths/admin_campaigns_{id}.yaml | 20 - .../admin_campaigns_{id}_promotions.yaml | 10 - .../specs/admin/paths/admin_claims.yaml | 20 - .../specs/admin/paths/admin_claims_{id}.yaml | 10 - .../paths/admin_claims_{id}_claim-items.yaml | 10 - ...n_claims_{id}_claim-items_{action_id}.yaml | 20 - ...}_inbound_shipping-method_{action_id}.yaml | 10 - .../admin_claims_{id}_outbound_items.yaml | 10 - ...laims_{id}_outbound_items_{action_id}.yaml | 20 - ..._claims_{id}_outbound_shipping-method.yaml | 10 - ..._outbound_shipping-method_{action_id}.yaml | 20 - .../paths/admin_claims_{id}_request.yaml | 10 - .../specs/admin/paths/admin_collections.yaml | 20 - .../admin/paths/admin_collections_{id}.yaml | 20 - .../admin_collections_{id}_products.yaml | 10 - .../specs/admin/paths/admin_currencies.yaml | 10 - .../admin/paths/admin_currencies_{code}.yaml | 10 - .../admin/paths/admin_customer-groups.yaml | 20 - .../paths/admin_customer-groups_{id}.yaml | 20 - .../admin_customer-groups_{id}_customers.yaml | 10 - .../specs/admin/paths/admin_customers.yaml | 20 - .../admin/paths/admin_customers_{id}.yaml | 20 - .../paths/admin_customers_{id}_addresses.yaml | 20 - ...customers_{id}_addresses_{address_id}.yaml | 30 - .../specs/admin/paths/admin_draft-orders.yaml | 20 - .../specs/admin/paths/admin_exchanges.yaml | 20 - .../admin/paths/admin_exchanges_{id}.yaml | 10 - ...}_inbound_shipping-method_{action_id}.yaml | 10 - .../admin_exchanges_{id}_outbound_items.yaml | 10 - ...anges_{id}_outbound_items_{action_id}.yaml | 20 - ...changes_{id}_outbound_shipping-method.yaml | 10 - ..._outbound_shipping-method_{action_id}.yaml | 20 - .../paths/admin_exchanges_{id}_request.yaml | 10 - .../paths/admin_fulfillment-providers.yaml | 10 - ...n_fulfillment-sets_{id}_service-zones.yaml | 10 - ...ent-sets_{id}_service-zones_{zone_id}.yaml | 20 - .../specs/admin/paths/admin_fulfillments.yaml | 10 - .../paths/admin_fulfillments_{id}_cancel.yaml | 10 - .../admin_fulfillments_{id}_shipment.yaml | 10 - .../admin/paths/admin_inventory-items.yaml | 20 - .../paths/admin_inventory-items_{id}.yaml | 20 - ..._inventory-items_{id}_location-levels.yaml | 20 - ...ms_{id}_location-levels_{location_id}.yaml | 20 - .../specs/admin/paths/admin_invites.yaml | 20 - .../specs/admin/paths/admin_invites_{id}.yaml | 10 - .../paths/admin_invites_{id}_resend.yaml | 10 - .../admin/paths/admin_notifications.yaml | 10 - .../admin/paths/admin_notifications_{id}.yaml | 10 - .../specs/admin/paths/admin_orders.yaml | 10 - .../specs/admin/paths/admin_orders_{id}.yaml | 68 +- .../paths/admin_orders_{id}_archive.yaml | 10 - .../admin/paths/admin_orders_{id}_cancel.yaml | 10 - .../paths/admin_orders_{id}_changes.yaml | 10 - .../paths/admin_orders_{id}_complete.yaml | 10 - .../paths/admin_orders_{id}_fulfillments.yaml | 10 - ..._fulfillments_{fulfillment_id}_cancel.yaml | 10 - ...ts_{fulfillment_id}_mark-as-delivered.yaml | 10 - ...lfillments_{fulfillment_id}_shipments.yaml | 10 - .../paths/admin_orders_{id}_line-items.yaml | 161 + .../paths/admin_payment-collections.yaml | 10 - ...payment-collections_{id}_mark-as-paid.yaml | 10 - .../specs/admin/paths/admin_payments.yaml | 10 - .../admin_payments_payment-providers.yaml | 10 - .../admin/paths/admin_payments_{id}.yaml | 10 - .../paths/admin_payments_{id}_capture.yaml | 10 - .../paths/admin_payments_{id}_refund.yaml | 10 - .../specs/admin/paths/admin_price-lists.yaml | 20 - .../admin/paths/admin_price-lists_{id}.yaml | 20 - .../admin_price-lists_{id}_products.yaml | 10 - .../admin/paths/admin_price-preferences.yaml | 20 - .../paths/admin_price-preferences_{id}.yaml | 20 - .../admin/paths/admin_product-categories.yaml | 20 - .../paths/admin_product-categories_{id}.yaml | 20 - ...dmin_product-categories_{id}_products.yaml | 10 - .../specs/admin/paths/admin_product-tags.yaml | 20 - .../admin/paths/admin_product-tags_{id}.yaml | 20 - .../admin/paths/admin_product-types.yaml | 20 - .../admin/paths/admin_product-types_{id}.yaml | 20 - .../admin/paths/admin_product-variants.yaml | 10 - .../specs/admin/paths/admin_products.yaml | 20 - .../admin/paths/admin_products_batch.yaml | 10 - .../admin/paths/admin_products_export.yaml | 10 - .../admin/paths/admin_products_{id}.yaml | 20 - .../paths/admin_products_{id}_options.yaml | 20 - ...min_products_{id}_options_{option_id}.yaml | 30 - .../paths/admin_products_{id}_variants.yaml | 20 - .../admin_products_{id}_variants_batch.yaml | 10 - ...n_products_{id}_variants_{variant_id}.yaml | 30 - ...variants_{variant_id}_inventory-items.yaml | 10 - ...}_inventory-items_{inventory_item_id}.yaml | 20 - .../specs/admin/paths/admin_promotions.yaml | 20 - .../admin/paths/admin_promotions_{id}.yaml | 20 - ...admin_promotions_{id}_buy-rules_batch.yaml | 10 - .../admin_promotions_{id}_rules_batch.yaml | 10 - ...in_promotions_{id}_target-rules_batch.yaml | 10 - .../admin_promotions_{id}_{rule_type}.yaml | 10 - .../admin/paths/admin_refund-reasons.yaml | 20 - .../paths/admin_refund-reasons_{id}.yaml | 20 - .../specs/admin/paths/admin_regions.yaml | 20 - .../specs/admin/paths/admin_regions_{id}.yaml | 20 - .../specs/admin/paths/admin_reservations.yaml | 20 - .../admin/paths/admin_reservations_{id}.yaml | 20 - .../admin/paths/admin_return-reasons.yaml | 20 - .../paths/admin_return-reasons_{id}.yaml | 20 - .../specs/admin/paths/admin_returns.yaml | 20 - .../specs/admin/paths/admin_returns_{id}.yaml | 20 - .../admin_returns_{id}_dismiss-items.yaml | 10 - ...eturns_{id}_dismiss-items_{action_id}.yaml | 20 - .../admin_returns_{id}_receive-items.yaml | 10 - ...eturns_{id}_receive-items_{action_id}.yaml | 20 - .../paths/admin_returns_{id}_receive.yaml | 10 - .../admin_returns_{id}_receive_confirm.yaml | 10 - .../admin_returns_{id}_request-items.yaml | 10 - ...eturns_{id}_request-items_{action_id}.yaml | 20 - .../paths/admin_returns_{id}_request.yaml | 10 - .../admin_returns_{id}_shipping-method.yaml | 10 - ...urns_{id}_shipping-method_{action_id}.yaml | 20 - .../admin/paths/admin_sales-channels.yaml | 20 - .../paths/admin_sales-channels_{id}.yaml | 20 - .../admin_sales-channels_{id}_products.yaml | 10 - .../admin/paths/admin_shipping-options.yaml | 20 - .../paths/admin_shipping-options_{id}.yaml | 20 - ...min_shipping-options_{id}_rules_batch.yaml | 10 - .../admin/paths/admin_shipping-profiles.yaml | 20 - .../paths/admin_shipping-profiles_{id}.yaml | 20 - .../admin/paths/admin_stock-locations.yaml | 20 - .../paths/admin_stock-locations_{id}.yaml | 20 - ...-locations_{id}_fulfillment-providers.yaml | 10 - ...stock-locations_{id}_fulfillment-sets.yaml | 10 - ...n_stock-locations_{id}_sales-channels.yaml | 10 - .../specs/admin/paths/admin_stores.yaml | 10 - .../specs/admin/paths/admin_stores_{id}.yaml | 20 - .../specs/admin/paths/admin_tax-rates.yaml | 20 - .../admin/paths/admin_tax-rates_{id}.yaml | 20 - .../paths/admin_tax-rates_{id}_rules.yaml | 10 - .../admin_tax-rates_{id}_rules_{rule_id}.yaml | 10 - .../specs/admin/paths/admin_tax-regions.yaml | 20 - .../admin/paths/admin_tax-regions_{id}.yaml | 75 +- .../specs/admin/paths/admin_uploads_{id}.yaml | 10 - .../specs/admin/paths/admin_users.yaml | 10 - .../specs/admin/paths/admin_users_me.yaml | 10 - .../specs/admin/paths/admin_users_{id}.yaml | 20 - .../paths/admin_workflows-executions.yaml | 10 - .../admin_workflows-executions_{id}.yaml | 10 - ...utions_{workflow_id}_{transaction_id}.yaml | 10 - .../schemas/AdminCreateFulfillment.yaml | 4 +- .../schemas/AdminCreateProduct.yaml | 1 + .../schemas/AdminCreateShippingOption.yaml | 92 +- .../AdminCreateShippingOptionType.yaml | 20 + .../components/schemas/AdminExchange.yaml | 2 +- .../schemas/AdminExchangeOrderResponse.yaml | 1 - .../store/components/schemas/AdminOrder.yaml | 6 +- .../components/schemas/AdminOrderChange.yaml | 12 +- .../schemas/AdminOrderChangeAction.yaml | 10 +- .../components/schemas/AdminOrderItem.yaml | 45 + .../schemas/AdminOrderLineItem.yaml | 6 +- .../components/schemas/AdminOrderPreview.yaml | 6 +- .../AdminPostOrderEditsAddItemsReqSchema.yaml | 4 + ...minPostOrderEditsItemsActionReqSchema.yaml | 4 + ...OrderEditsUpdateItemQuantityReqSchema.yaml | 4 + .../components/schemas/AdminProduct.yaml | 8 +- .../schemas/AdminUpdateTaxRegion.yaml | 11 + .../schemas/BaseCalculatedPriceSet.yaml | 54 - .../components/schemas/BaseCollection.yaml | 46 +- .../store/components/schemas/BaseOrder.yaml | 12 +- .../components/schemas/BaseOrderAddress.yaml | 4 +- .../schemas/BaseOrderFulfillment.yaml | 7 +- .../schemas/BasePaymentProvider.yaml | 2 +- .../schemas/BaseProductCategory.yaml | 83 +- .../components/schemas/BaseProductOption.yaml | 22 +- .../components/schemas/BaseProductTag.yaml | 34 +- .../specs/store/components/schemas/Order.yaml | 88 - .../store/components/schemas/OrderClaim.yaml | 246 +- .../components/schemas/OrderExchange.yaml | 244 +- .../store/components/schemas/OrderItem.yaml | 32 - .../components/schemas/OrderLineItem.yaml | 239 - .../schemas/OrderLineItemTaxLine.yaml | 8 - .../components/schemas/OrderReturnItem.yaml | 31 +- .../schemas/OrderShippingMethod.yaml | 135 - .../schemas/OrderShippingMethodTaxLine.yaml | 8 - .../components/schemas/OrderTransaction.yaml | 3 + .../store/components/schemas/Return.yaml | 296 +- .../components/schemas/StoreCollection.yaml | 4 +- .../store/components/schemas/StoreOrder.yaml | 31 +- .../components/schemas/StoreOrderAddress.yaml | 73 + .../schemas/StoreOrderFulfillment.yaml | 79 + .../schemas/StoreOrderLineItem.yaml | 4011 +++++++ .../schemas/StoreOrderShippingMethod.yaml | 1714 +++ .../components/schemas/StoreProduct.yaml | 8 +- .../schemas/StoreProductVariant.yaml | 4 +- .../schemas/StoreRegionCountry.yaml | 33 + .../store/components/schemas/StoreReturn.yaml | 4 +- .../specs/store/openapi.full.yaml | 8069 +++++++++++--- .../specs/store/paths/store_carts.yaml | 10 - .../specs/store/paths/store_carts_{id}.yaml | 20 - .../paths/store_carts_{id}_complete.yaml | 10 - .../paths/store_carts_{id}_line-items.yaml | 10 - ...store_carts_{id}_line-items_{line_id}.yaml | 20 - .../paths/store_carts_{id}_promotions.yaml | 20 - .../store_carts_{id}_shipping-methods.yaml | 12 +- .../store/paths/store_carts_{id}_taxes.yaml | 10 - .../specs/store/paths/store_collections.yaml | 10 - .../store/paths/store_collections_{id}.yaml | 10 - .../specs/store/paths/store_currencies.yaml | 10 - .../store/paths/store_currencies_{code}.yaml | 10 - .../specs/store/paths/store_customers.yaml | 10 - .../specs/store/paths/store_customers_me.yaml | 20 - .../paths/store_customers_me_addresses.yaml | 20 - ...e_customers_me_addresses_{address_id}.yaml | 30 - .../specs/store/paths/store_orders.yaml | 10 - .../specs/store/paths/store_orders_{id}.yaml | 10 - .../paths/store_payment-collections.yaml | 10 - ...ent-collections_{id}_payment-sessions.yaml | 10 - .../store/paths/store_payment-providers.yaml | 10 - .../store/paths/store_product-categories.yaml | 10 - .../paths/store_product-categories_{id}.yaml | 10 - .../specs/store/paths/store_products.yaml | 10 - .../store/paths/store_products_{id}.yaml | 10 - .../specs/store/paths/store_regions.yaml | 10 - .../specs/store/paths/store_regions_{id}.yaml | 10 - .../store/paths/store_return-reasons.yaml | 10 - .../paths/store_return-reasons_{id}.yaml | 10 - .../page.mdx | 53 +- .../file.AbstractFileProviderService/page.mdx | 37 +- .../page.mdx | 10 +- .../medusa_config.ConfigModule/page.mdx | 66 +- .../page.mdx | 2 +- .../medusa_config.PluginDetails/page.mdx | 2 - .../page.mdx | 36 +- .../page.mdx | 37 +- ...min_claims_[id]_claim-items_[action_id].ts | 8 - ..._claims_[id]_outbound_items_[action_id].ts | 8 - ...d]_outbound_shipping-method_[action_id].ts | 8 - ...n_customers_[id]_addresses_[address_id].ts | 8 - ...changes_[id]_outbound_items_[action_id].ts | 8 - ...d]_outbound_shipping-method_[action_id].ts | 8 - ...tems_[id]_location-levels_[location_id].ts | 8 - ...admin_products_[id]_options_[option_id].ts | 8 - ...min_products_[id]_variants_[variant_id].ts | 8 - ...id]_inventory-items_[inventory_item_id].ts | 8 - ..._returns_[id]_dismiss-items_[action_id].ts | 8 - ..._returns_[id]_receive-items_[action_id].ts | 8 - ..._returns_[id]_request-items_[action_id].ts | 8 - ...eturns_[id]_shipping-method_[action_id].ts | 8 - ...te_admin_tax-rates_[id]_rules_[rule_id].ts | 8 - .../operations/admin/get_admin_api-keys.ts | 8 - .../admin/get_admin_api-keys_[id].ts | 8 - .../operations/admin/get_admin_campaigns.ts | 8 - .../admin/get_admin_campaigns_[id].ts | 8 - .../operations/admin/get_admin_claims.ts | 8 - .../operations/admin/get_admin_claims_[id].ts | 8 - .../operations/admin/get_admin_collections.ts | 8 - .../admin/get_admin_collections_[id].ts | 8 - .../operations/admin/get_admin_currencies.ts | 8 - .../admin/get_admin_currencies_[code].ts | 8 - .../admin/get_admin_customer-groups.ts | 8 - .../admin/get_admin_customer-groups_[id].ts | 8 - .../operations/admin/get_admin_customers.ts | 8 - .../admin/get_admin_customers_[id].ts | 8 - .../get_admin_customers_[id]_addresses.ts | 8 - ...n_customers_[id]_addresses_[address_id].ts | 8 - .../admin/get_admin_draft-orders.ts | 8 - .../operations/admin/get_admin_exchanges.ts | 8 - .../admin/get_admin_exchanges_[id].ts | 8 - .../admin/get_admin_fulfillment-providers.ts | 8 - ...lment-sets_[id]_service-zones_[zone_id].ts | 8 - .../admin/get_admin_inventory-items.ts | 8 - .../admin/get_admin_inventory-items_[id].ts | 8 - ...in_inventory-items_[id]_location-levels.ts | 8 - .../operations/admin/get_admin_invites.ts | 8 - .../admin/get_admin_invites_[id].ts | 8 - .../admin/get_admin_notifications.ts | 8 - .../admin/get_admin_notifications_[id].ts | 8 - .../operations/admin/get_admin_orders.ts | 8 - .../operations/admin/get_admin_orders_[id].ts | 56 +- .../admin/get_admin_orders_[id]_changes.ts | 8 - .../admin/get_admin_orders_[id]_line-items.ts | 156 + .../operations/admin/get_admin_payments.ts | 8 - .../admin/get_admin_payments_[id].ts | 8 - .../get_admin_payments_payment-providers.ts | 8 - .../operations/admin/get_admin_price-lists.ts | 8 - .../admin/get_admin_price-lists_[id].ts | 8 - .../admin/get_admin_price-preferences.ts | 8 - .../admin/get_admin_price-preferences_[id].ts | 8 - .../admin/get_admin_product-categories.ts | 8 - .../get_admin_product-categories_[id].ts | 8 - .../admin/get_admin_product-tags.ts | 8 - .../admin/get_admin_product-tags_[id].ts | 8 - .../admin/get_admin_product-types.ts | 8 - .../admin/get_admin_product-types_[id].ts | 8 - .../admin/get_admin_product-variants.ts | 8 - .../operations/admin/get_admin_products.ts | 8 - .../admin/get_admin_products_[id].ts | 8 - .../admin/get_admin_products_[id]_options.ts | 8 - ...admin_products_[id]_options_[option_id].ts | 8 - .../admin/get_admin_products_[id]_variants.ts | 8 - ...min_products_[id]_variants_[variant_id].ts | 8 - .../operations/admin/get_admin_promotions.ts | 8 - .../admin/get_admin_promotions_[id].ts | 8 - .../get_admin_promotions_[id]_[rule_type].ts | 8 - .../admin/get_admin_refund-reasons.ts | 8 - .../admin/get_admin_refund-reasons_[id].ts | 8 - .../operations/admin/get_admin_regions.ts | 8 - .../admin/get_admin_regions_[id].ts | 8 - .../admin/get_admin_reservations.ts | 8 - .../admin/get_admin_reservations_[id].ts | 8 - .../admin/get_admin_return-reasons.ts | 8 - .../admin/get_admin_return-reasons_[id].ts | 8 - .../operations/admin/get_admin_returns.ts | 8 - .../admin/get_admin_returns_[id].ts | 8 - .../admin/get_admin_sales-channels.ts | 8 - .../admin/get_admin_sales-channels_[id].ts | 8 - .../admin/get_admin_shipping-options.ts | 8 - .../admin/get_admin_shipping-options_[id].ts | 8 - .../admin/get_admin_shipping-profiles.ts | 8 - .../admin/get_admin_shipping-profiles_[id].ts | 8 - .../admin/get_admin_stock-locations.ts | 8 - .../admin/get_admin_stock-locations_[id].ts | 8 - .../operations/admin/get_admin_stores.ts | 8 - .../operations/admin/get_admin_stores_[id].ts | 8 - .../operations/admin/get_admin_tax-rates.ts | 8 - .../admin/get_admin_tax-rates_[id].ts | 8 - .../operations/admin/get_admin_tax-regions.ts | 8 - .../admin/get_admin_tax-regions_[id].ts | 8 - .../admin/get_admin_uploads_[id].ts | 8 - .../operations/admin/get_admin_users.ts | 8 - .../operations/admin/get_admin_users_[id].ts | 8 - .../operations/admin/get_admin_users_me.ts | 8 - .../admin/get_admin_workflows-executions.ts | 8 - .../get_admin_workflows-executions_[id].ts | 8 - ...ecutions_[workflow_id]_[transaction_id].ts | 8 - .../admin/post_admin_api-keys_[id].ts | 8 - .../admin/post_admin_api-keys_[id]_revoke.ts | 8 - ...post_admin_api-keys_[id]_sales-channels.ts | 8 - .../operations/admin/post_admin_campaigns.ts | 8 - .../admin/post_admin_campaigns_[id].ts | 8 - .../post_admin_campaigns_[id]_promotions.ts | 8 - .../operations/admin/post_admin_claims.ts | 8 - .../post_admin_claims_[id]_claim-items.ts | 8 - ...min_claims_[id]_claim-items_[action_id].ts | 8 - ...id]_inbound_shipping-method_[action_id].ts | 8 - .../post_admin_claims_[id]_outbound_items.ts | 8 - ..._claims_[id]_outbound_items_[action_id].ts | 8 - ...in_claims_[id]_outbound_shipping-method.ts | 8 - ...d]_outbound_shipping-method_[action_id].ts | 8 - .../admin/post_admin_claims_[id]_request.ts | 8 - .../admin/post_admin_collections.ts | 8 - .../admin/post_admin_collections_[id].ts | 8 - .../post_admin_collections_[id]_products.ts | 8 - .../admin/post_admin_customer-groups.ts | 8 - .../admin/post_admin_customer-groups_[id].ts | 8 - ...st_admin_customer-groups_[id]_customers.ts | 8 - .../operations/admin/post_admin_customers.ts | 8 - .../admin/post_admin_customers_[id].ts | 8 - .../post_admin_customers_[id]_addresses.ts | 8 - ...n_customers_[id]_addresses_[address_id].ts | 8 - .../admin/post_admin_draft-orders.ts | 8 - .../operations/admin/post_admin_exchanges.ts | 8 - ...id]_inbound_shipping-method_[action_id].ts | 8 - ...ost_admin_exchanges_[id]_outbound_items.ts | 8 - ...changes_[id]_outbound_items_[action_id].ts | 8 - ...exchanges_[id]_outbound_shipping-method.ts | 8 - ...d]_outbound_shipping-method_[action_id].ts | 8 - .../post_admin_exchanges_[id]_request.ts | 8 - ...min_fulfillment-sets_[id]_service-zones.ts | 8 - ...lment-sets_[id]_service-zones_[zone_id].ts | 8 - .../admin/post_admin_fulfillments.ts | 8 - .../post_admin_fulfillments_[id]_cancel.ts | 8 - .../post_admin_fulfillments_[id]_shipment.ts | 8 - .../admin/post_admin_inventory-items.ts | 8 - .../admin/post_admin_inventory-items_[id].ts | 8 - ...in_inventory-items_[id]_location-levels.ts | 8 - ...tems_[id]_location-levels_[location_id].ts | 8 - .../operations/admin/post_admin_invites.ts | 8 - .../admin/post_admin_invites_[id]_resend.ts | 8 - .../admin/post_admin_orders_[id].ts | 8 - .../admin/post_admin_orders_[id]_archive.ts | 8 - .../admin/post_admin_orders_[id]_cancel.ts | 8 - .../admin/post_admin_orders_[id]_complete.ts | 8 - .../post_admin_orders_[id]_fulfillments.ts | 8 - ...d]_fulfillments_[fulfillment_id]_cancel.ts | 8 - ...ents_[fulfillment_id]_mark-as-delivered.ts | 8 - ...fulfillments_[fulfillment_id]_shipments.ts | 8 - .../admin/post_admin_payment-collections.ts | 8 - ...n_payment-collections_[id]_mark-as-paid.ts | 8 - .../admin/post_admin_payments_[id]_capture.ts | 8 - .../admin/post_admin_payments_[id]_refund.ts | 8 - .../admin/post_admin_price-lists.ts | 8 - .../admin/post_admin_price-lists_[id].ts | 8 - .../post_admin_price-lists_[id]_products.ts | 8 - .../admin/post_admin_price-preferences.ts | 8 - .../post_admin_price-preferences_[id].ts | 8 - .../admin/post_admin_product-categories.ts | 8 - .../post_admin_product-categories_[id].ts | 8 - ..._admin_product-categories_[id]_products.ts | 8 - .../admin/post_admin_product-tags.ts | 8 - .../admin/post_admin_product-tags_[id].ts | 8 - .../admin/post_admin_product-types.ts | 8 - .../admin/post_admin_product-types_[id].ts | 8 - .../operations/admin/post_admin_products.ts | 8 - .../admin/post_admin_products_[id].ts | 8 - .../admin/post_admin_products_[id]_options.ts | 8 - ...admin_products_[id]_options_[option_id].ts | 8 - .../post_admin_products_[id]_variants.ts | 8 - ...min_products_[id]_variants_[variant_id].ts | 8 - ...]_variants_[variant_id]_inventory-items.ts | 8 - ...id]_inventory-items_[inventory_item_id].ts | 8 - ...post_admin_products_[id]_variants_batch.ts | 8 - .../admin/post_admin_products_batch.ts | 8 - .../admin/post_admin_products_export.ts | 8 - .../operations/admin/post_admin_promotions.ts | 8 - .../admin/post_admin_promotions_[id].ts | 8 - ...t_admin_promotions_[id]_buy-rules_batch.ts | 8 - .../post_admin_promotions_[id]_rules_batch.ts | 8 - ...dmin_promotions_[id]_target-rules_batch.ts | 8 - .../admin/post_admin_refund-reasons.ts | 8 - .../admin/post_admin_refund-reasons_[id].ts | 8 - .../operations/admin/post_admin_regions.ts | 8 - .../admin/post_admin_regions_[id].ts | 8 - .../admin/post_admin_reservations.ts | 8 - .../admin/post_admin_reservations_[id].ts | 8 - .../admin/post_admin_return-reasons.ts | 8 - .../admin/post_admin_return-reasons_[id].ts | 8 - .../operations/admin/post_admin_returns.ts | 8 - .../admin/post_admin_returns_[id].ts | 8 - .../post_admin_returns_[id]_dismiss-items.ts | 8 - ..._returns_[id]_dismiss-items_[action_id].ts | 8 - .../post_admin_returns_[id]_receive-items.ts | 8 - ..._returns_[id]_receive-items_[action_id].ts | 8 - .../admin/post_admin_returns_[id]_receive.ts | 8 - ...post_admin_returns_[id]_receive_confirm.ts | 8 - .../post_admin_returns_[id]_request-items.ts | 8 - ..._returns_[id]_request-items_[action_id].ts | 8 - .../admin/post_admin_returns_[id]_request.ts | 8 - ...post_admin_returns_[id]_shipping-method.ts | 8 - ...eturns_[id]_shipping-method_[action_id].ts | 8 - .../admin/post_admin_sales-channels.ts | 8 - .../admin/post_admin_sales-channels_[id].ts | 8 - ...post_admin_sales-channels_[id]_products.ts | 8 - .../admin/post_admin_shipping-options.ts | 8 - .../admin/post_admin_shipping-options_[id].ts | 8 - ...admin_shipping-options_[id]_rules_batch.ts | 8 - .../admin/post_admin_shipping-profiles.ts | 8 - .../post_admin_shipping-profiles_[id].ts | 8 - .../admin/post_admin_stock-locations.ts | 8 - .../admin/post_admin_stock-locations_[id].ts | 8 - ...ck-locations_[id]_fulfillment-providers.ts | 8 - ...n_stock-locations_[id]_fulfillment-sets.ts | 8 - ...min_stock-locations_[id]_sales-channels.ts | 8 - .../admin/post_admin_stores_[id].ts | 8 - .../operations/admin/post_admin_tax-rates.ts | 8 - .../admin/post_admin_tax-rates_[id].ts | 8 - .../admin/post_admin_tax-rates_[id]_rules.ts | 8 - .../admin/post_admin_tax-regions.ts | 8 - .../admin/post_admin_tax-regions_[id].ts | 67 + .../operations/admin/post_admin_users_[id].ts | 8 - ...e_store_carts_[id]_line-items_[line_id].ts | 8 - .../delete_store_carts_[id]_promotions.ts | 8 - ...ore_customers_me_addresses_[address_id].ts | 8 - .../operations/store/get_store_carts_[id].ts | 8 - .../operations/store/get_store_collections.ts | 8 - .../store/get_store_collections_[id].ts | 8 - .../operations/store/get_store_currencies.ts | 8 - .../store/get_store_currencies_[code].ts | 8 - .../store/get_store_customers_me.ts | 8 - .../store/get_store_customers_me_addresses.ts | 8 - ...ore_customers_me_addresses_[address_id].ts | 8 - .../operations/store/get_store_orders.ts | 8 - .../operations/store/get_store_orders_[id].ts | 8 - .../store/get_store_payment-providers.ts | 8 - .../store/get_store_product-categories.ts | 8 - .../get_store_product-categories_[id].ts | 8 - .../operations/store/get_store_products.ts | 8 - .../store/get_store_products_[id].ts | 8 - .../operations/store/get_store_regions.ts | 8 - .../store/get_store_regions_[id].ts | 8 - .../store/get_store_return-reasons.ts | 8 - .../store/get_store_return-reasons_[id].ts | 8 - .../operations/store/post_store_carts.ts | 8 - .../operations/store/post_store_carts_[id].ts | 8 - .../store/post_store_carts_[id]_complete.ts | 8 - .../store/post_store_carts_[id]_line-items.ts | 8 - ...t_store_carts_[id]_line-items_[line_id].ts | 8 - .../store/post_store_carts_[id]_promotions.ts | 8 - .../post_store_carts_[id]_shipping-methods.ts | 10 +- .../store/post_store_carts_[id]_taxes.ts | 8 - .../operations/store/post_store_customers.ts | 8 - .../store/post_store_customers_me.ts | 8 - .../post_store_customers_me_addresses.ts | 8 - ...ore_customers_me_addresses_[address_id].ts | 8 - .../store/post_store_payment-collections.ts | 8 - ...yment-collections_[id]_payment-sessions.ts | 8 - .../schemas/AdminCreateFulfillment.ts | 4 +- .../schemas/AdminCreateShippingOption.ts | 86 +- .../schemas/AdminCreateShippingOptionType.ts | 25 + .../oas-output/schemas/AdminExchange.ts | 2 +- .../schemas/AdminExchangeOrderResponse.ts | 1 - .../oas-output/schemas/AdminOrder.ts | 6 +- .../oas-output/schemas/AdminOrderChange.ts | 12 +- .../schemas/AdminOrderChangeAction.ts | 10 +- .../oas-output/schemas/AdminOrderItem.ts | 50 + .../oas-output/schemas/AdminOrderLineItem.ts | 6 +- .../oas-output/schemas/AdminOrderPreview.ts | 6 +- .../AdminPostOrderEditsAddItemsReqSchema.ts | 4 + ...AdminPostOrderEditsItemsActionReqSchema.ts | 4 + ...stOrderEditsUpdateItemQuantityReqSchema.ts | 4 + .../oas-output/schemas/AdminProduct.ts | 8 +- .../schemas/AdminUpdateTaxRegion.ts | 16 + .../schemas/BaseCalculatedPriceSet.ts | 54 - .../oas-output/schemas/BaseCollection.ts | 46 +- .../generated/oas-output/schemas/BaseOrder.ts | 15 +- .../oas-output/schemas/BaseOrderAddress.ts | 4 +- .../schemas/BaseOrderFulfillment.ts | 8 +- .../oas-output/schemas/BasePaymentProvider.ts | 2 +- .../oas-output/schemas/BaseProductCategory.ts | 79 +- .../oas-output/schemas/BaseProductOption.ts | 22 +- .../oas-output/schemas/BaseProductTag.ts | 34 +- .../generated/oas-output/schemas/Order.ts | 88 - .../oas-output/schemas/OrderClaim.ts | 246 +- .../oas-output/schemas/OrderExchange.ts | 242 +- .../generated/oas-output/schemas/OrderItem.ts | 32 - .../oas-output/schemas/OrderLineItem.ts | 239 - .../schemas/OrderLineItemTaxLine.ts | 8 - .../oas-output/schemas/OrderReturnItem.ts | 29 +- .../oas-output/schemas/OrderShippingMethod.ts | 135 - .../schemas/OrderShippingMethodTaxLine.ts | 8 - .../oas-output/schemas/OrderTransaction.ts | 6 +- .../generated/oas-output/schemas/Return.ts | 296 +- .../oas-output/schemas/StoreCollection.ts | 4 +- .../oas-output/schemas/StoreOrder.ts | 31 +- .../oas-output/schemas/StoreOrderAddress.ts | 78 + .../schemas/StoreOrderFulfillment.ts | 81 + .../oas-output/schemas/StoreOrderLineItem.ts | 4016 +++++++ .../schemas/StoreOrderShippingMethod.ts | 1716 +++ .../oas-output/schemas/StoreProduct.ts | 8 +- .../oas-output/schemas/StoreProductVariant.ts | 4 +- .../oas-output/schemas/StoreRegionCountry.ts | 38 + .../oas-output/schemas/StoreReturn.ts | 4 +- 595 files changed, 33468 insertions(+), 13327 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_line-items/get.sh create mode 100644 www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/post.sh create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionType.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminOrderItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml create mode 100644 www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionType.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminOrderItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml create mode 100644 www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts create mode 100644 www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts create mode 100644 www/utils/generated/oas-output/schemas/AdminCreateShippingOptionType.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminOrderItem.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreOrderAddress.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts create mode 100644 www/utils/generated/oas-output/schemas/StoreRegionCountry.ts diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_line-items/get.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_line-items/get.sh new file mode 100644 index 0000000000..b83f9d91ec --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_orders_{id}_line-items/get.sh @@ -0,0 +1,2 @@ +curl '{backend_url}/admin/orders/{id}/line-items' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh index f1779653af..7dac66f30a 100644 --- a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_products/post.sh @@ -2,5 +2,11 @@ curl -X POST '{backend_url}/admin/products' \ -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "title": "{value}" + "title": "{value}", + "options": [ + { + "title": "Default option", + "values": ["Default option value"] + } + ] }' \ No newline at end of file diff --git a/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/post.sh b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/post.sh new file mode 100644 index 0000000000..b7093b4e2f --- /dev/null +++ b/www/apps/api-reference/specs/admin/code_samples/Shell/admin_tax-regions_{id}/post.sh @@ -0,0 +1,2 @@ +curl -X POST '{backend_url}/admin/tax-regions/{id}' \ +-H 'Authorization: Bearer {access_token}' \ No newline at end of file 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 79e31f7d86..1a0af19c8f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -3,9 +3,9 @@ description: The filfillment's details. x-schemaName: AdminCreateFulfillment required: - data - - order_id - - metadata - items + - metadata + - order_id - location_id - provider_id - delivery_address diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml index d4cece0e33..a16b8cb40c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateProduct.yaml @@ -3,6 +3,7 @@ description: The product's details. x-schemaName: AdminCreateProduct required: - title + - options properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml index 2477095764..69a57280bd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOption.yaml @@ -2,19 +2,87 @@ type: object description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - label - - description - - code + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices properties: - label: + name: type: string - title: label - description: The type's label. - description: + title: name + description: The shipping option's name. + service_zone_id: type: string - title: description - description: The type's description. - code: + title: service_zone_id + description: The ID of the associated service zone. + shipping_profile_id: type: string - title: code - description: The type's code. + title: shipping_profile_id + description: The ID of the associated shipping profile. + data: + type: object + description: >- + The shipping option's data, useful for the fulfillment provider handling + its processing. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + price_type: + type: string + description: >- + The shipping option's price type. If `flat`, the shipping option has a + fixed price set in `prices`. Otherwise, the shipping option's price is + calculated by the fulfillment provider. + enum: + - flat + - calculated + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider handling this shipping option. + type: + $ref: ./AdminCreateShippingOptionType.yaml + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's details. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency + required: + - currency_code + - amount + properties: + 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. + - type: object + description: The price's details. + 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionType.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionType.yaml new file mode 100644 index 0000000000..a4cee2ce64 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingOptionType.yaml @@ -0,0 +1,20 @@ +type: object +description: The shipping option type's details. +x-schemaName: AdminCreateShippingOptionType +required: + - label + - description + - code +properties: + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. 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 31e20a4158..0123920e3f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchange.yaml @@ -95,7 +95,7 @@ properties: title: deleted_at description: The date the exchange was deleted. order: - $ref: ./AdminOrder.yaml + $ref: ./BaseOrder.yaml allow_backorder: type: boolean title: allow_backorder diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml index 03bc03d999..740cc7b536 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminExchangeOrderResponse.yaml @@ -6,7 +6,6 @@ required: - exchange properties: order: - description: The details of the associated order. $ref: ./Order.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml index e90b9b2d8f..fd28a5a6b1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrder.yaml @@ -7,16 +7,16 @@ required: - shipping_methods - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml index 3297e8bcca..195bd76d5e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChange.yaml @@ -8,12 +8,12 @@ required: - exchange - actions - status - - order_id - - metadata - id + - version + - metadata - created_at - updated_at - - version + - order_id - canceled_at - return_id - exchange_id @@ -62,11 +62,7 @@ properties: title: claim_id description: The ID of the associated claim. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml return_order: $ref: ./AdminReturn.yaml exchange: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml index 3f93eb71ce..ebcaf79e3f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderChangeAction.yaml @@ -4,11 +4,11 @@ x-schemaName: AdminOrderChangeAction required: - order_change - order - - order_id - - internal_note - id - created_at - updated_at + - order_id + - internal_note - return_id - exchange_id - claim_id @@ -45,11 +45,7 @@ properties: title: exchange_id description: The ID of the associated exchange. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml reference: type: string title: reference diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderItem.yaml new file mode 100644 index 0000000000..7f762a3fc9 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderItem.yaml @@ -0,0 +1,45 @@ +type: object +description: The order item's details. +x-schemaName: AdminOrderItem +required: + - order_id + - item_id + - version + - history + - item +properties: + order_id: + type: string + title: order_id + description: The ID of the order this item belongs to. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + version: + type: number + title: version + description: The order item's version. + history: + type: object + description: The order item's history. + required: + - version + properties: + version: + type: object + description: The version changes of the item. + required: + - from + - to + properties: + from: + type: number + title: from + description: The original version. + to: + type: number + title: to + description: The new version. + item: + $ref: ./AdminOrderLineItem.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml index 41d7121777..7fef9541dd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderLineItem.yaml @@ -3,10 +3,8 @@ description: The item's details. x-schemaName: AdminOrderLineItem required: - title - - metadata - id - - subtitle - - thumbnail + - metadata - created_at - updated_at - item_total @@ -20,6 +18,8 @@ required: - tax_total - discount_total - discount_tax_total + - subtitle + - thumbnail - variant_id - product_id - product_title 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 fef57add5b..ea3aa5ac25 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -8,17 +8,17 @@ required: - order_change - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_collections - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml index 5e4fcec7be..d477bfb838 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -37,3 +37,7 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index 0d80349175..ababf23ed1 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -14,3 +14,7 @@ properties: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index bf3acfba0e..3d172e017c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -16,3 +16,7 @@ properties: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. 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 e197602dfa..58fdf04753 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProduct.yaml @@ -11,10 +11,12 @@ required: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -26,8 +28,6 @@ required: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: collection: diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml new file mode 100644 index 0000000000..d599385b83 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRegion.yaml @@ -0,0 +1,11 @@ +type: object +description: The details to update in a tax region. +x-schemaName: AdminUpdateTaxRegion +properties: + province_code: + type: string + title: province_code + description: The tax region's province code. + metadata: + type: object + description: The tax region's metadata, can hold custom key-value pairs. 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 f8db134ea0..ac22d66e39 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseCalculatedPriceSet.yaml @@ -56,60 +56,6 @@ properties: 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 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/BaseCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseCollection.yaml index 6b7390021c..898e69ae05 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,47 @@ type: object -description: The collection's details. +description: The product 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 collection's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's update date. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deletion date. + products: + type: array + description: The collection's products. + items: + $ref: ./AdminProduct.yaml + metadata: + type: object + description: The collection's metadata, used to store custom key-value pairs. 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 2b2d4962a6..80d2a024bc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrder.yaml @@ -2,7 +2,6 @@ type: object description: The order's details. x-schemaName: BaseOrder required: - - payment_collections - id - version - region_id @@ -15,7 +14,6 @@ required: - payment_status - fulfillment_status - summary - - metadata - created_at - updated_at - original_item_total @@ -45,20 +43,16 @@ properties: type: array description: The order's payment collections. items: - $ref: ./AdminPaymentCollection.yaml + $ref: ./BasePaymentCollection.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 + $ref: ./BaseOrderAddress.yaml billing_address: - $ref: ./AdminOrderAddress.yaml + $ref: ./BaseOrderAddress.yaml id: type: string title: id 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 ffdb335848..e3d3b54635 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: An order address +description: An order address. x-schemaName: BaseOrderAddress required: - id @@ -48,8 +48,6 @@ properties: title: country_code description: The address's country code. example: us - country: - $ref: ./AdminRegionCountry.yaml province: type: string title: province 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 12970b6fe2..eba0b4539b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseOrderFulfillment.yaml @@ -1,5 +1,5 @@ type: object -description: The fulfillment's fulfillments. +description: The fulfillment's details. x-schemaName: BaseOrderFulfillment required: - id @@ -8,6 +8,7 @@ required: - shipped_at - delivered_at - canceled_at + - requires_shipping - data - provider_id - shipping_option_id @@ -72,3 +73,7 @@ properties: 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/BasePaymentProvider.yaml b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml index 2b73a963fb..e58d96408f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BasePaymentProvider.yaml @@ -1,5 +1,5 @@ type: object -description: The payment provider's payment providers. +description: The payment provider's details. x-schemaName: BasePaymentProvider required: - id diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml index 8bb7bdbaca..e8b62d10e8 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductCategory.yaml @@ -1,3 +1,84 @@ type: object -description: The category's categories. +description: The product category's details. x-schemaName: BaseProductCategory +required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at +properties: + category_children: + type: array + description: The category's children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + metadata: + type: object + description: The category's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the category was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the category was updated. + handle: + type: string + title: handle + description: The category's unique handle. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the category was deleted. + is_active: + type: boolean + title: is_active + description: >- + Whether the category is active. If disabled, the category isn't shown in + the storefront. + is_internal: + type: boolean + title: is_internal + description: >- + Whether the category is internal. If enabled, the category is only seen by + admin users. + rank: + type: number + title: rank + description: The category's rank among sibling categories. + parent_category_id: + type: string + title: parent_category_id + description: The ID of the category's parent. 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 152999bb1c..7964d121fe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductOption.yaml @@ -1,44 +1,44 @@ type: object description: The product option's details. x-schemaName: BaseProductOption +required: + - id + - title properties: id: type: string title: id - description: The option's ID. + description: The product option's ID. title: type: string title: title - description: The option's title. + description: The product option's title. product: type: object product_id: type: string title: product_id - description: The option's product id. + description: The ID of the product this option belongs to. values: type: array - description: The option's values. + description: The product option's values. items: $ref: ./BaseProductOptionValue.yaml metadata: type: object - description: The 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 option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The option's deleted at. -required: - - id - - title + description: The date the product option was deleted. diff --git a/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml b/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml index eeff43fa01..2f9a58b017 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/BaseProductTag.yaml @@ -1,3 +1,35 @@ type: object -description: The tag's tags. +description: The product tag's details. x-schemaName: BaseProductTag +required: + - id + - value + - created_at + - updated_at +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. 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 47214c6a82..6b9aca9fd7 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Order.yaml @@ -31,28 +31,6 @@ required: - 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 @@ -228,69 +206,3 @@ properties: 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/OrderClaim.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml index 41bb209451..4739eb812c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderClaim.yaml @@ -2,44 +2,14 @@ type: object description: The order change's claim. x-schemaName: OrderClaim required: + - id + - type - order_id + - order_version + - display_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 @@ -70,79 +40,29 @@ properties: title: no_notification description: Whether the customer should be notified about changes in the claim. refund_amount: - type: number - title: refund_amount + oneOf: + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's refund amount. + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's 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: ./OrderShippingMethod.yaml transactions: type: array description: The claim's transactions. @@ -151,9 +71,7 @@ properties: 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 + $ref: ./OrderTransaction.yaml metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -167,91 +85,43 @@ properties: format: date-time title: updated_at description: The claim's update date. - original_item_total: + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order: + $ref: ./Order.yaml + order_version: 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. + title: order_version + description: The claim's order version. + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time 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 c0ba54357b..857b9ed634 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderExchange.yaml @@ -2,54 +2,17 @@ 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 + - order_id + - order_version + - display_id + - additional_items - 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. @@ -67,88 +30,24 @@ properties: be refunded. If positive, additional payment is required from the customer. return: - description: the return associated with the exchange. - $ref: ./AdminReturn.yaml + $ref: ./Return.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 + $ref: ./OrderShippingMethod.yaml transactions: type: array description: The exchange's transactions. @@ -156,10 +55,7 @@ properties: 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 + $ref: ./OrderTransaction.yaml metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -173,91 +69,43 @@ properties: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: + order: + $ref: ./Order.yaml + order_version: 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. + title: order_version + description: The version of the order when the exchange is applied. + raw_difference_due: + oneOf: + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + allow_backorder: + type: boolean + title: allow_backorder + description: >- + Whether variants that are out of stock can be added to the exchange as + outbound items. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time 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 ccd2567ac5..ab12ebb4d2 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderItem.yaml @@ -6,21 +6,13 @@ required: - 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 @@ -39,58 +31,34 @@ properties: 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. diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml index 7872ecc8f1..be86e71967 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItem.yaml @@ -8,9 +8,7 @@ required: - is_discountable - is_tax_inclusive - unit_price - - raw_unit_price - quantity - - raw_quantity - detail - created_at - updated_at @@ -27,19 +25,6 @@ required: - 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 @@ -122,56 +107,14 @@ properties: 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. @@ -251,185 +194,3 @@ properties: 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/OrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml index 90d590d62b..9e7f1613bb 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderLineItemTaxLine.yaml @@ -6,8 +6,6 @@ required: - item_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -28,12 +26,6 @@ properties: 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 diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml index 2b2fa31a38..e6fc76e22f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderReturnItem.yaml @@ -3,11 +3,10 @@ description: The item's items. x-schemaName: OrderReturnItem required: - id - - quantity - - received_quantity - - damaged_quantity - - item_id - return_id + - order_id + - item_id + - quantity properties: id: type: string @@ -23,20 +22,10 @@ properties: 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 @@ -48,3 +37,17 @@ properties: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + order_id: + type: string + title: order_id + description: The ID of the order the return belongs to. + 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/OrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml index 892005eea0..3aa794be00 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethod.yaml @@ -6,7 +6,6 @@ required: - order_id - name - amount - - raw_amount - is_tax_inclusive - created_at - updated_at @@ -18,14 +17,6 @@ required: - 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 @@ -47,20 +38,6 @@ properties: 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 @@ -132,115 +109,3 @@ properties: 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/OrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml index d49d3e1414..e2a987241e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderShippingMethodTaxLine.yaml @@ -6,8 +6,6 @@ required: - shipping_method_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -28,12 +26,6 @@ properties: 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 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 100e873e64..39323d6113 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderTransaction.yaml @@ -4,6 +4,7 @@ x-schemaName: OrderTransaction required: - id - order_id + - order - amount - currency_code - reference @@ -56,3 +57,5 @@ properties: format: date-time title: updated_at description: The date that the transaction was updated. + order: + type: object 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 b16dbae793..cfefdef18c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/Return.yaml @@ -6,54 +6,8 @@ required: - 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 + - display_id + - metadata properties: id: type: string @@ -80,32 +34,6 @@ properties: 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. @@ -116,9 +44,6 @@ properties: 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. @@ -132,168 +57,67 @@ properties: 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: + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + order: + $ref: ./Order.yaml + exchange_id: + type: string + title: exchange_id + description: The ID of the exchange this return belongs to, if any. + exchange: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the claim this return belongs to, if any. + claim: + $ref: ./OrderClaim.yaml + display_id: 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. + title: display_id + description: The return order's display ID. + location_id: + type: string + title: location_id + description: The ID of the stock location the items are returned to. + no_notification: + type: boolean + title: no_notification + description: Whether to notify the customer about changes in the return. + created_by: + type: string + title: created_by + description: The ID of the user that created the return. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the return was deleted. + requested_at: + type: string + title: requested_at + description: The date the return was requested. + format: date-time + received_at: + type: string + title: received_at + description: The date the return was received. + format: date-time 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 ad9bc1b4ea..121ef729ec 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreCollection.yaml @@ -3,11 +3,11 @@ description: The collection's details. x-schemaName: StoreCollection required: - title - - metadata - id - - handle + - metadata - created_at - updated_at + - handle - deleted_at properties: id: 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 58ff75075f..5050fb4835 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrder.yaml @@ -2,19 +2,17 @@ type: object description: The order's details. x-schemaName: StoreOrder required: + - items + - shipping_methods + - currency_code - 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 @@ -44,10 +42,6 @@ properties: 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 @@ -75,24 +69,24 @@ properties: title: display_id description: The order's display ID. shipping_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./StoreOrderAddress.yaml billing_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./StoreOrderAddress.yaml items: type: array description: The order's items. items: - $ref: ./BaseOrderLineItem.yaml + $ref: ./StoreOrderLineItem.yaml shipping_methods: type: array description: The order's shipping methods. items: - $ref: ./BaseOrderShippingMethod.yaml + $ref: ./StoreOrderShippingMethod.yaml payment_collections: type: array description: The order's payment collections. items: - $ref: ./BasePaymentCollection.yaml + $ref: ./StorePaymentCollection.yaml payment_status: type: string description: The order's payment status. @@ -111,7 +105,7 @@ properties: type: array description: The order's fulfillments. items: - $ref: ./BaseOrderFulfillment.yaml + $ref: ./StoreOrderFulfillment.yaml fulfillment_status: type: string description: The order's fulfillment status. @@ -227,3 +221,10 @@ properties: type: number title: original_shipping_tax_total description: The total taxes of the order's shipping excluding promotions. + customer: + $ref: ./StoreCustomer.yaml + transactions: + type: array + description: The order's transactions. + items: + $ref: ./BaseOrderTransaction.yaml diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml new file mode 100644 index 0000000000..54ec49cf34 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderAddress.yaml @@ -0,0 +1,73 @@ +type: object +description: An order address +x-schemaName: StoreOrderAddress +required: + - id + - metadata + - created_at + - updated_at +properties: + 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 + country: + $ref: ./StoreRegionCountry.yaml + 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/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml new file mode 100644 index 0000000000..4c9e22c359 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderFulfillment.yaml @@ -0,0 +1,79 @@ +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 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: The fulfillment's requires shipping. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml new file mode 100644 index 0000000000..e8659e7a8e --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderLineItem.yaml @@ -0,0 +1,4011 @@ +type: object +description: The item's details. +x-schemaName: StoreOrderLineItem +required: + - detail + - 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 + - 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: ./StoreProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: ./StoreProduct.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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The tax line's tax lines. + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The adjustment's details. + detail: + allOf: + - $ref: ./BaseOrderItemDetail.yaml + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The item's detail. + 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/StoreOrderShippingMethod.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml new file mode 100644 index 0000000000..513ce23b45 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreOrderShippingMethod.yaml @@ -0,0 +1,1714 @@ +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 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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The adjustment's adjustments. + 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: + allOf: + - $ref: ./BaseOrderShippingDetail.yaml + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: Details of changes to a shipping method. 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 044867e21f..da21ace142 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProduct.yaml @@ -10,10 +10,12 @@ required: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -25,8 +27,6 @@ required: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: categories: diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml index 4d7558620a..a71c20070e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreProductVariant.yaml @@ -122,6 +122,8 @@ required: - length - title - id + - created_at + - updated_at - width - weight - height @@ -129,8 +131,6 @@ required: - hs_code - mid_code - material - - created_at - - updated_at - deleted_at - sku - barcode 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..b0e6213abb --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreRegionCountry.yaml @@ -0,0 +1,33 @@ +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. + 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/StoreReturn.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml index 2b3ca272bf..346a9d0a1b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreReturn.yaml @@ -3,10 +3,10 @@ description: The return's details. x-schemaName: StoreReturn required: - items - - order_id - id - - created_at - display_id + - created_at + - order_id - canceled_at - received_at properties: diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index f04edd2667..4cd276b64c 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -478,14 +478,6 @@ paths: description: Retrieve a list of API keys. The API keys can be filtered by fields such as `id`. The API keys can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - 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. @@ -1651,14 +1643,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. @@ -1712,14 +1696,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. @@ -1849,14 +1825,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. @@ -1918,14 +1886,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. @@ -1996,14 +1956,6 @@ paths: description: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2108,14 +2060,6 @@ paths: description: Create a campaign. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2260,14 +2204,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. @@ -2321,14 +2257,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. @@ -2519,14 +2447,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. @@ -2597,14 +2517,6 @@ paths: description: Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -3443,14 +3355,6 @@ paths: description: Create a claim. The claim is still in the request state, and the changes are only applied on the order once the claim is confirmed. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -3517,14 +3421,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. @@ -3630,14 +3526,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. @@ -3707,14 +3595,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. @@ -3784,14 +3664,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. @@ -4077,14 +3949,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. @@ -4199,14 +4063,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. @@ -4277,14 +4133,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. @@ -4354,14 +4202,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. @@ -4417,14 +4257,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. @@ -4499,14 +4331,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. @@ -4576,14 +4400,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. @@ -4638,14 +4454,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. @@ -4739,14 +4547,6 @@ paths: description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -5585,14 +5385,6 @@ paths: description: Create a collection. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -5658,14 +5450,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. @@ -5719,14 +5503,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. @@ -5836,14 +5612,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. @@ -5914,14 +5682,6 @@ paths: description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -6046,14 +5806,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. @@ -6102,14 +5854,6 @@ paths: description: Retrieve a list of customer groups. The customer groups can be filtered by fields such as `id`. The customer groups can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -6992,14 +6736,6 @@ paths: description: Create a customer group. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -7065,14 +6801,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. @@ -7126,14 +6854,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. @@ -7263,14 +6983,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. @@ -7341,14 +7053,6 @@ paths: description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -10734,14 +10438,6 @@ paths: description: Create a customer. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -10852,14 +10548,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. @@ -10913,14 +10601,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. @@ -11093,14 +10773,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. @@ -11310,14 +10982,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. @@ -11477,14 +11141,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. @@ -11545,14 +11201,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. @@ -11711,14 +11359,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. @@ -11791,14 +11431,6 @@ paths: description: Retrieve a list of draft orders. The draft orders can be filtered by fields such as `id`. The draft orders can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -13300,14 +12932,6 @@ paths: description: Create a draft order. This creates an order with the `is_draft_order` property enabled. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -13710,14 +13334,6 @@ paths: description: Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -14585,14 +14201,6 @@ paths: description: Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -14658,14 +14266,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. @@ -14998,14 +14598,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. @@ -15118,14 +14710,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. @@ -15196,14 +14780,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. @@ -15273,14 +14849,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. @@ -15335,14 +14903,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. @@ -15417,14 +14977,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. @@ -15494,14 +15046,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. @@ -15555,14 +15099,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. @@ -15656,14 +15192,6 @@ paths: description: Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as `id`. The fulfillment providers can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -15836,14 +15364,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. @@ -16033,14 +15553,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. @@ -16101,14 +15613,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. @@ -16348,14 +15852,6 @@ paths: description: Create a fulfillment for an order, return, exchange, and more. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -16463,14 +15959,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. @@ -16527,14 +16015,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. @@ -16599,14 +16079,6 @@ paths: description: Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -17046,14 +16518,6 @@ paths: description: Create an inventory item. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -17130,14 +16594,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. @@ -17191,14 +16647,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. @@ -17395,14 +16843,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. @@ -17546,14 +16986,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. @@ -17744,14 +17176,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. @@ -17831,14 +17255,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. @@ -17911,14 +17327,6 @@ paths: description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -18430,14 +17838,6 @@ paths: description: Create a invite. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -18586,14 +17986,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. @@ -18699,14 +18091,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. @@ -18750,14 +18134,6 @@ paths: description: Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -18896,14 +18272,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. @@ -19549,14 +18917,6 @@ paths: description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -20249,14 +19609,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. @@ -20267,6 +19619,54 @@ paths: description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default 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: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The order's ID. + - type: array + description: The order's ID. + items: + type: string + title: id + description: The id's ID. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The order's status. + - type: array + description: The order's status. + items: + type: string + title: status + description: The status's details. + - name: version + in: query + description: The order's version. + required: false + schema: + type: number + title: version + description: The order's version. + - name: created_at + in: query + required: false + schema: {} + - name: updated_at + in: query + required: false + schema: {} + - name: deleted_at + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -20311,14 +19711,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. @@ -20373,14 +19765,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. @@ -20448,14 +19832,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. @@ -20515,14 +19891,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: |- @@ -20581,14 +19949,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. @@ -20659,14 +20019,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. @@ -20787,14 +20139,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. @@ -20876,14 +20220,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: |- @@ -20947,14 +20283,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. @@ -21073,6 +20401,158 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: createOrderShipmentWorkflow + /admin/orders/{id}/line-items: + get: + operationId: GetOrdersIdLineItems + summary: List Line Items + description: Retrieve a list of line items in a order. The line items can be filtered by fields like FILTER FIELDS. The line items can also be paginated. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - 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' + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The order's ID. + - type: array + description: The order's ID. + items: + type: string + title: id + description: The id's ID. + - name: item_id + in: query + required: false + schema: + oneOf: + - type: string + title: item_id + description: The order's item id. + - type: array + description: The order's item id. + items: + type: string + title: item_id + description: The item id's details. + - name: order_id + in: query + required: false + schema: + oneOf: + - type: string + title: order_id + description: The order's order id. + - type: array + description: The order's order id. + items: + type: string + title: order_id + description: The order id's details. + - name: version + in: query + required: false + schema: + oneOf: + - type: number + title: version + description: The order's version. + - type: array + description: The order's version. + items: + type: number + title: version + description: The version's details. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + 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 `-`. + required: false + schema: + type: string + title: order + description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + externalDocs: + url: '#pagination' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl '{backend_url}/admin/orders/{id}/line-items' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - order_items + properties: + order_items: + type: array + description: The order's order items. + items: + $ref: '#/components/schemas/AdminOrderItem' + '400': + $ref: '#/components/responses/400_error' + '401': + $ref: '#/components/responses/unauthorized' + '404': + $ref: '#/components/responses/not_found_error' + '409': + $ref: '#/components/responses/invalid_state_error' + '422': + $ref: '#/components/responses/invalid_request_error' + '500': + $ref: '#/components/responses/500_error' /admin/orders/{id}/preview: get: operationId: GetOrdersIdPreview @@ -21124,14 +20604,6 @@ paths: description: Create a payment collection. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -21255,14 +20727,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. @@ -21329,14 +20793,6 @@ paths: description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -21853,14 +21309,6 @@ paths: description: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - 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. @@ -22012,14 +21460,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. @@ -22074,14 +21514,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. @@ -22148,14 +21580,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. @@ -22224,14 +21648,6 @@ paths: description: Retrieve a list of price lists. The price lists can be filtered by fields such as `id`. The price lists can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -22611,14 +22027,6 @@ paths: description: Create a price list. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -22686,14 +22094,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. @@ -22747,14 +22147,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. @@ -23000,14 +22392,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. @@ -23062,14 +22446,6 @@ paths: description: Retrieve a list of price preferences. The price preferences can be filtered by fields such as `id`. The price preferences can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -23215,14 +22591,6 @@ paths: description: Create a price preference. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -23283,14 +22651,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. @@ -23344,14 +22704,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. @@ -23450,14 +22802,6 @@ paths: description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -24018,14 +23362,6 @@ paths: description: Create a product category. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -24092,14 +23428,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. @@ -24169,14 +23497,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. @@ -24320,14 +23640,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. @@ -24398,14 +23710,6 @@ paths: description: Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -24892,14 +24196,6 @@ paths: description: Create a product tag. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -24965,14 +24261,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. @@ -25026,14 +24314,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. @@ -25145,14 +24425,6 @@ paths: description: Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -25639,14 +24911,6 @@ paths: description: Create a product type. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -25712,14 +24976,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. @@ -25773,14 +25029,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. @@ -25892,14 +25140,6 @@ paths: description: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -26420,14 +25660,6 @@ paths: description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -27471,14 +26703,6 @@ paths: description: Create a product. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -27514,7 +26738,13 @@ paths: -H 'Authorization: Bearer {access_token}' \ -H 'Content-Type: application/json' \ --data-raw '{ - "title": "{value}" + "title": "{value}", + "options": [ + { + "title": "Default option", + "values": ["Default option value"] + } + ] }' tags: - Products @@ -27545,14 +26775,6 @@ paths: description: Manage products to create, update, or delete them. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -27611,14 +26833,6 @@ paths: Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -27756,14 +26970,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. @@ -27817,14 +27023,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. @@ -27938,14 +27136,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. @@ -28113,14 +27303,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. @@ -28203,14 +27385,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. @@ -28271,14 +27445,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. @@ -28356,14 +27522,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. @@ -28420,14 +27578,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. @@ -28954,14 +28104,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. @@ -29036,14 +28178,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. @@ -29228,14 +28362,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. @@ -29296,14 +28422,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. @@ -29378,14 +28496,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. @@ -29448,14 +28558,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. @@ -29534,14 +28636,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. @@ -29618,14 +28712,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. @@ -29675,14 +28761,6 @@ paths: description: Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -30217,14 +29295,6 @@ paths: description: Create a promotion. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -30789,14 +29859,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. @@ -30850,14 +29912,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. @@ -31076,14 +30130,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. @@ -31204,14 +30250,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. @@ -31332,14 +30370,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. @@ -31474,14 +30504,6 @@ paths: - rules - target-rules - buy-rules - - 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. @@ -31539,14 +30561,6 @@ paths: description: Retrieve a list of refund reasons. The refund reasons can be filtered by fields such as `id`. The refund reasons can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -31693,14 +30707,6 @@ paths: description: Create a refund reason. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -31766,14 +30772,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. @@ -31827,14 +30825,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. @@ -31966,14 +30956,6 @@ paths: description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -32503,14 +31485,6 @@ paths: description: Create a region. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -32577,14 +31551,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. @@ -32638,14 +31604,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. @@ -32802,14 +31760,6 @@ paths: description: Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -33380,14 +32330,6 @@ paths: description: Create a reservation. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -33457,14 +32399,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. @@ -33518,14 +32452,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. @@ -33665,14 +32591,6 @@ paths: description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -34203,14 +33121,6 @@ paths: description: Create a return reason. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -34276,14 +33186,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. @@ -34337,14 +33239,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. @@ -34443,14 +33337,6 @@ paths: description: Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -35135,14 +34021,6 @@ paths: description: Create a return. The return can later be requested or confirmed. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -35221,14 +34099,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. @@ -35282,14 +34152,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. @@ -35405,14 +34267,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. @@ -35483,14 +34337,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. @@ -35560,14 +34406,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. @@ -35623,14 +34461,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. @@ -35768,14 +34598,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. @@ -35846,14 +34668,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. @@ -35923,14 +34737,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. @@ -35987,14 +34793,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. @@ -36056,14 +34854,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. @@ -36188,14 +34978,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. @@ -36266,14 +35048,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. @@ -36343,14 +35117,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. @@ -36407,14 +35173,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. @@ -36489,14 +35247,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. @@ -36566,14 +35316,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. @@ -36623,14 +35365,6 @@ paths: description: Retrieve a list of sales channels. The sales channels can be filtered by fields such as `id`. The sales channels can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -37190,14 +35924,6 @@ paths: description: Create a sales channel. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -37264,14 +35990,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. @@ -37325,14 +36043,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. @@ -37443,14 +36153,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. @@ -37521,14 +36223,6 @@ paths: description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -38098,14 +36792,6 @@ paths: description: Create a shipping option. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -38180,14 +36866,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: |- @@ -38244,14 +36922,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. @@ -38522,14 +37192,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. @@ -38643,14 +37305,6 @@ paths: description: Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as `id`. The shipping profiles can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -39168,14 +37822,6 @@ paths: description: Create a shipping profile. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -39242,14 +37888,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. @@ -39303,14 +37941,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. @@ -39426,14 +38056,6 @@ paths: description: Retrieve a list of stock locations. The stock locations can be filtered by fields such as `id`. The stock locations can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -39948,14 +38570,6 @@ paths: description: Create a stock location. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -40022,14 +38636,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. @@ -40083,14 +38689,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. @@ -40201,14 +38799,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. @@ -40286,14 +38876,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. @@ -40373,14 +38955,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. @@ -40451,14 +39025,6 @@ paths: description: Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -40595,14 +39161,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. @@ -40656,14 +39214,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. @@ -40726,14 +39276,6 @@ paths: description: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -41321,14 +39863,6 @@ paths: description: Create a tax rate. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -41395,14 +39929,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. @@ -41456,14 +39982,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. @@ -41573,14 +40091,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. @@ -41653,14 +40163,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. @@ -41735,14 +40237,6 @@ paths: description: Retrieve a list of tax regions. The tax regions can be filtered by fields such as `id`. The tax regions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -42783,14 +41277,6 @@ paths: description: Create a tax region. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -42858,14 +41344,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. @@ -42907,6 +41385,68 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + post: + operationId: PostTaxRegionsId + summary: Update a Tax Region + description: Update a tax region's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The tax region's ID. + required: true + schema: + type: string + - 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: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AdminUpdateTaxRegion' + x-codeSamples: + - lang: Shell + label: cURL + source: |- + curl -X POST '{backend_url}/admin/tax-regions/{id}' \ + -H 'Authorization: Bearer {access_token}' + tags: + - Tax Regions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AdminTaxRegionResponse' + '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: updateTaxRegionsWorkflow delete: operationId: DeleteTaxRegionsId summary: Delete a Tax Region @@ -43047,14 +41587,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. @@ -43166,14 +41698,6 @@ paths: description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -43648,14 +42172,6 @@ paths: description: Retrieve the logged-in user's details. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -43704,14 +42220,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. @@ -43759,14 +42267,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. @@ -43860,14 +42360,6 @@ paths: description: Retrieve a list of workflows executions. The workflows executions can be filtered by fields such as `id`. The workflows executions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -44007,14 +42499,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. @@ -44335,14 +42819,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. @@ -45585,9 +44061,9 @@ components: x-schemaName: AdminCreateFulfillment required: - data - - order_id - - metadata - items + - metadata + - order_id - location_id - provider_id - delivery_address @@ -45908,6 +44384,7 @@ components: x-schemaName: AdminCreateProduct required: - title + - options properties: title: type: string @@ -46493,22 +44970,84 @@ components: description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - label - - description - - code + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices properties: - label: + name: type: string - title: label - description: The type's label. - description: + title: name + description: The shipping option's name. + service_zone_id: type: string - title: description - description: The type's description. - code: + title: service_zone_id + description: The ID of the associated service zone. + shipping_profile_id: type: string - title: code - description: The type's code. + title: shipping_profile_id + description: The ID of the associated shipping profile. + data: + type: object + description: The shipping option's data, useful for the fulfillment provider handling its processing. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + price_type: + type: string + description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider. + enum: + - flat + - calculated + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider handling this shipping option. + type: + $ref: '#/components/schemas/AdminCreateShippingOptionType' + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's details. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency + required: + - currency_code + - amount + properties: + 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. + - type: object + description: The price's details. + 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' AdminCreateShippingOptionRule: type: object description: The details of the shipping option rule. @@ -46548,6 +45087,27 @@ components: title: value description: A value of the attribute that enables this rule. example: cusgroup_123 + AdminCreateShippingOptionType: + type: object + description: The shipping option type's details. + x-schemaName: AdminCreateShippingOptionType + required: + - label + - description + - code + properties: + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. AdminCreateShippingProfile: type: object description: The shipping profile's details. @@ -47774,7 +46334,7 @@ components: title: deleted_at description: The date the exchange was deleted. order: - $ref: '#/components/schemas/AdminOrder' + $ref: '#/components/schemas/BaseOrder' allow_backorder: type: boolean title: allow_backorder @@ -47810,7 +46370,6 @@ components: - exchange properties: order: - description: The details of the associated order. $ref: '#/components/schemas/Order' exchange: $ref: '#/components/schemas/AdminExchange' @@ -48757,16 +47316,16 @@ components: - shipping_methods - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total @@ -49070,12 +47629,12 @@ components: - exchange - actions - status - - order_id - - metadata - id + - version + - metadata - created_at - updated_at - - version + - order_id - canceled_at - return_id - exchange_id @@ -49122,11 +47681,7 @@ components: title: claim_id description: The ID of the associated claim. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' return_order: $ref: '#/components/schemas/AdminReturn' exchange: @@ -49207,11 +47762,11 @@ components: required: - order_change - order - - order_id - - internal_note - id - created_at - updated_at + - order_id + - internal_note - return_id - exchange_id - claim_id @@ -49248,11 +47803,7 @@ components: title: exchange_id description: The ID of the associated exchange. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' reference: type: string title: reference @@ -49412,16 +47963,60 @@ components: type: boolean title: requires_shipping description: Whether the fulfillment requires shipping. + AdminOrderItem: + type: object + description: The order item's details. + x-schemaName: AdminOrderItem + required: + - order_id + - item_id + - version + - history + - item + properties: + order_id: + type: string + title: order_id + description: The ID of the order this item belongs to. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + version: + type: number + title: version + description: The order item's version. + history: + type: object + description: The order item's history. + required: + - version + properties: + version: + type: object + description: The version changes of the item. + required: + - from + - to + properties: + from: + type: number + title: from + description: The original version. + to: + type: number + title: to + description: The new version. + item: + $ref: '#/components/schemas/AdminOrderLineItem' AdminOrderLineItem: type: object description: The item's details. x-schemaName: AdminOrderLineItem required: - title - - metadata - id - - subtitle - - thumbnail + - metadata - created_at - updated_at - item_total @@ -49435,6 +48030,8 @@ components: - tax_total - discount_total - discount_tax_total + - subtitle + - thumbnail - variant_id - product_id - product_title @@ -49635,17 +48232,17 @@ components: - order_change - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_collections - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total @@ -51037,6 +49634,10 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. AdminPostOrderEditsItemsActionReqSchema: type: object description: The details to update in the item. @@ -51054,6 +49655,10 @@ components: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. AdminPostOrderEditsReqSchema: type: object description: The order edit's details. @@ -51137,6 +49742,10 @@ components: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. AdminPostOrderExchangesReqSchema: type: object description: The exchange's details. @@ -51816,10 +50425,12 @@ components: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -51831,8 +50442,6 @@ components: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: collection: @@ -55141,6 +53750,18 @@ components: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + AdminUpdateTaxRegion: + type: object + description: The details to update in a tax region. + x-schemaName: AdminUpdateTaxRegion + properties: + province_code: + type: string + title: province_code + description: The tax region's province code. + metadata: + type: object + description: The tax region's metadata, can hold custom key-value pairs. AdminUpdateUser: type: object description: The properties to update in a user. @@ -55689,63 +54310,9 @@ components: 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 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 details of a captured payment. @@ -56327,8 +54894,52 @@ components: description: The date the claim was updated. BaseCollection: type: object - description: The collection's details. + description: The product 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 collection's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's update date. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deletion date. + products: + type: array + description: The collection's products. + items: + $ref: '#/components/schemas/AdminProduct' + metadata: + type: object + description: The collection's metadata, used to store custom key-value pairs. BaseExchangeItem: type: object description: The item's details. @@ -56516,7 +55127,6 @@ components: description: The order's details. x-schemaName: BaseOrder required: - - payment_collections - id - version - region_id @@ -56529,7 +55139,6 @@ components: - payment_status - fulfillment_status - summary - - metadata - created_at - updated_at - original_item_total @@ -56559,20 +55168,16 @@ components: type: array description: The order's payment collections. items: - $ref: '#/components/schemas/AdminPaymentCollection' + $ref: '#/components/schemas/BasePaymentCollection' 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' + $ref: '#/components/schemas/BaseOrderAddress' billing_address: - $ref: '#/components/schemas/AdminOrderAddress' + $ref: '#/components/schemas/BaseOrderAddress' id: type: string title: id @@ -56752,7 +55357,7 @@ components: description: The tax total of the order's shipping excluding promotions. BaseOrderAddress: type: object - description: An order address + description: An order address. x-schemaName: BaseOrderAddress required: - id @@ -56801,8 +55406,6 @@ components: title: country_code description: The address's country code. example: us - country: - $ref: '#/components/schemas/AdminRegionCountry' province: type: string title: province @@ -56826,7 +55429,7 @@ components: description: The date the address was updated. BaseOrderFulfillment: type: object - description: The fulfillment's fulfillments. + description: The fulfillment's details. x-schemaName: BaseOrderFulfillment required: - id @@ -56835,6 +55438,7 @@ components: - shipped_at - delivered_at - canceled_at + - requires_shipping - data - provider_id - shipping_option_id @@ -56896,6 +55500,10 @@ components: 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. BaseOrderItemDetail: type: object description: The item's detail. @@ -57872,7 +56480,7 @@ components: $ref: '#/components/schemas/BasePayment' BasePaymentProvider: type: object - description: The payment provider's payment providers. + description: The payment provider's details. x-schemaName: BasePaymentProvider required: - id @@ -58105,8 +56713,85 @@ components: description: The product's metadata. BaseProductCategory: type: object - description: The category's categories. + description: The product category's details. x-schemaName: BaseProductCategory + required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at + properties: + category_children: + type: array + description: The category's children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + metadata: + type: object + description: The category's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the category was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the category was updated. + handle: + type: string + title: handle + description: The category's unique handle. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the category was deleted. + is_active: + type: boolean + title: is_active + description: Whether the category is active. If disabled, the category isn't shown in the storefront. + is_internal: + type: boolean + title: is_internal + description: Whether the category is internal. If enabled, the category is only seen by admin users. + rank: + type: number + title: rank + description: The category's rank among sibling categories. + parent_category_id: + type: string + title: parent_category_id + description: The ID of the category's parent. BaseProductImage: type: object description: The image's details. @@ -58145,47 +56830,47 @@ components: type: object description: The product option's details. x-schemaName: BaseProductOption + required: + - id + - title properties: id: type: string title: id - description: The option's ID. + description: The product option's ID. title: type: string title: title - description: The option's title. + description: The product option's title. product: type: object product_id: type: string title: product_id - description: The option's product id. + description: The ID of the product this option belongs to. values: type: array - description: The option's values. + description: The product option's values. items: $ref: '#/components/schemas/BaseProductOptionValue' metadata: type: object - description: The 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 option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The option's deleted at. - required: - - id - - title + description: The date the product option was deleted. BaseProductOptionValue: type: object description: The product option value's details. @@ -58228,8 +56913,40 @@ components: description: The date the value was deleted. BaseProductTag: type: object - description: The tag's tags. + description: The product tag's details. x-schemaName: BaseProductTag + required: + - id + - value + - created_at + - updated_at + 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. BaseProductVariant: type: object description: The product variant's details. @@ -59255,28 +57972,6 @@ components: - 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 @@ -59452,72 +58147,6 @@ components: 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 address's details. @@ -59832,44 +58461,14 @@ components: description: The order change's claim. x-schemaName: OrderClaim required: + - id + - type - order_id + - order_version + - display_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 @@ -59900,79 +58499,29 @@ components: title: no_notification description: Whether the customer should be notified about changes in the claim. refund_amount: - type: number - title: refund_amount + oneOf: + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's refund amount. + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's 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/OrderShippingMethod' transactions: type: array description: The claim's transactions. @@ -59980,9 +58529,7 @@ components: 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' + $ref: '#/components/schemas/OrderTransaction' metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -59996,147 +58543,62 @@ components: format: date-time title: updated_at description: The claim's update date. - original_item_total: + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order: + $ref: '#/components/schemas/Order' + order_version: 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. + title: order_version + description: The claim's order version. + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time 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 + - order_id + - order_version + - display_id + - additional_items - 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. @@ -60151,98 +58613,31 @@ 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' + $ref: '#/components/schemas/Return' 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 + $ref: '#/components/schemas/OrderShippingMethod' 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' + $ref: '#/components/schemas/OrderTransaction' metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -60256,94 +58651,44 @@ components: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: + order: + $ref: '#/components/schemas/Order' + order_version: 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. + title: order_version + description: The version of the order when the exchange is applied. + raw_difference_due: + oneOf: + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether variants that are out of stock can be added to the exchange as outbound items. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time OrderItem: type: object description: The order item's detail. @@ -60353,21 +58698,13 @@ components: - 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 @@ -60386,58 +58723,34 @@ components: 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. @@ -60462,9 +58775,7 @@ components: - is_discountable - is_tax_inclusive - unit_price - - raw_unit_price - quantity - - raw_quantity - detail - created_at - updated_at @@ -60481,19 +58792,6 @@ components: - 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 @@ -60576,56 +58874,14 @@ components: 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. @@ -60703,188 +58959,6 @@ components: 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. @@ -60951,8 +59025,6 @@ components: - item_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -60973,12 +59045,6 @@ components: 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 @@ -61019,11 +59085,10 @@ components: x-schemaName: OrderReturnItem required: - id - - quantity - - received_quantity - - damaged_quantity - - item_id - return_id + - order_id + - item_id + - quantity properties: id: type: string @@ -61037,18 +59102,10 @@ components: 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 @@ -61060,6 +59117,20 @@ components: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + order_id: + type: string + title: order_id + description: The ID of the order the return belongs to. + 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. OrderShippingMethod: type: object description: The shipping method's details. @@ -61069,7 +59140,6 @@ components: - order_id - name - amount - - raw_amount - is_tax_inclusive - created_at - updated_at @@ -61081,14 +59151,6 @@ components: - 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 @@ -61110,20 +59172,6 @@ components: 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 @@ -61192,118 +59240,6 @@ components: 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. @@ -61370,8 +59306,6 @@ components: - shipping_method_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -61392,12 +59326,6 @@ components: 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 @@ -61439,6 +59367,7 @@ components: required: - id - order_id + - order - amount - currency_code - reference @@ -61488,6 +59417,8 @@ components: format: date-time title: updated_at description: The date that the transaction was updated. + order: + type: object RefundReason: type: object description: The refund reason's details. @@ -61542,54 +59473,8 @@ components: - 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 + - display_id + - metadata properties: id: type: string @@ -61616,32 +59501,6 @@ components: description: The return's items. items: $ref: '#/components/schemas/OrderReturnItem' - 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: '#/components/schemas/OrderAddress' - billing_address: - $ref: '#/components/schemas/OrderAddress' shipping_methods: type: array description: The return's shipping methods. @@ -61652,9 +59511,6 @@ components: description: The return's transactions. items: $ref: '#/components/schemas/OrderTransaction' - summary: - type: object - description: The return's summary. metadata: type: object description: The return's metadata, can hold custom key-value pairs. @@ -61668,171 +59524,70 @@ components: 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: '#/components/schemas/OrderChange' canceled_at: type: string title: canceled_at description: The date the return was canceled. format: date-time - discount_subtotal: + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + order: + $ref: '#/components/schemas/Order' + exchange_id: + type: string + title: exchange_id + description: The ID of the exchange this return belongs to, if any. + exchange: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the claim this return belongs to, if any. + claim: + $ref: '#/components/schemas/OrderClaim' + display_id: 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. + title: display_id + description: The return order's display ID. + location_id: + type: string + title: location_id + description: The ID of the stock location the items are returned to. + no_notification: + type: boolean + title: no_notification + description: Whether to notify the customer about changes in the return. + created_by: + type: string + title: created_by + description: The ID of the user that created the return. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the return was deleted. + requested_at: + type: string + title: requested_at + description: The date the return was requested. + format: date-time + received_at: + type: string + title: received_at + description: The date the return was received. + format: date-time StoreAddCartLineItem: type: object description: The details of the line item to add. @@ -62699,11 +60454,11 @@ components: x-schemaName: StoreCollection required: - title - - metadata - id - - handle + - metadata - created_at - updated_at + - handle - deleted_at properties: id: @@ -63207,19 +60962,17 @@ components: description: The order's details. x-schemaName: StoreOrder required: + - items + - shipping_methods + - currency_code - 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 @@ -63249,10 +61002,6 @@ components: 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 @@ -63280,24 +61029,24 @@ components: title: display_id description: The order's display ID. shipping_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/StoreOrderAddress' billing_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/StoreOrderAddress' items: type: array description: The order's items. items: - $ref: '#/components/schemas/BaseOrderLineItem' + $ref: '#/components/schemas/StoreOrderLineItem' shipping_methods: type: array description: The order's shipping methods. items: - $ref: '#/components/schemas/BaseOrderShippingMethod' + $ref: '#/components/schemas/StoreOrderShippingMethod' payment_collections: type: array description: The order's payment collections. items: - $ref: '#/components/schemas/BasePaymentCollection' + $ref: '#/components/schemas/StorePaymentCollection' payment_status: type: string description: The order's payment status. @@ -63316,7 +61065,7 @@ components: type: array description: The order's fulfillments. items: - $ref: '#/components/schemas/BaseOrderFulfillment' + $ref: '#/components/schemas/StoreOrderFulfillment' fulfillment_status: type: string description: The order's fulfillment status. @@ -63432,6 +61181,4176 @@ components: type: number title: original_shipping_tax_total description: The total taxes of the order's shipping excluding promotions. + customer: + $ref: '#/components/schemas/StoreCustomer' + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + StoreOrderAddress: + type: object + description: An order address + x-schemaName: StoreOrderAddress + required: + - id + - metadata + - created_at + - updated_at + properties: + 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 + country: + $ref: '#/components/schemas/StoreRegionCountry' + 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. + 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 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: The fulfillment's requires shipping. + StoreOrderLineItem: + type: object + description: The item's details. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - 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/StoreProductVariant' + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: '#/components/schemas/StoreProduct' + 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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The tax line's tax lines. + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The adjustment's details. + detail: + allOf: + - $ref: '#/components/schemas/BaseOrderItemDetail' + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The item's detail. + 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. StoreOrderResponse: type: object description: The order's details. @@ -63441,6 +65360,1718 @@ components: properties: order: $ref: '#/components/schemas/StoreOrder' + 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 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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The adjustment's adjustments. + 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: + allOf: + - $ref: '#/components/schemas/BaseOrderShippingDetail' + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: Details of changes to a shipping method. StorePaymentCollection: type: object description: The payment collection's details. @@ -63615,10 +67246,12 @@ components: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -63630,8 +67263,6 @@ components: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: categories: @@ -64155,6 +67786,8 @@ components: - length - title - id + - created_at + - updated_at - width - weight - height @@ -64162,8 +67795,6 @@ components: - hs_code - mid_code - material - - created_at - - updated_at - deleted_at - sku - barcode @@ -64220,16 +67851,50 @@ components: format: date-time title: 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. + 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. StoreReturn: type: object description: The return's details. x-schemaName: StoreReturn required: - items - - order_id - id - - created_at - display_id + - created_at + - order_id - canceled_at - received_at properties: diff --git a/www/apps/api-reference/specs/admin/openapi.yaml b/www/apps/api-reference/specs/admin/openapi.yaml index e0026be771..a9f8c93ee4 100644 --- a/www/apps/api-reference/specs/admin/openapi.yaml +++ b/www/apps/api-reference/specs/admin/openapi.yaml @@ -796,6 +796,8 @@ paths: 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}/line-items: + $ref: paths/admin_orders_{id}_line-items.yaml /admin/orders/{id}/preview: $ref: paths/admin_orders_{id}_preview.yaml /admin/payment-collections: 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 568e6a9ca4..66384165e8 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 @@ -6,16 +6,6 @@ get: `id`. The API keys can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 62af33d9c8..86ad80a615 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 039390fbed..62390dcd82 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 @@ -13,16 +13,6 @@ post: 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: >- 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 eec86ab182..ba865399e5 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 @@ -13,16 +13,6 @@ post: 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: >- 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 c8fd7e5b19..2b0f47fab2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -6,16 +6,6 @@ get: as `id`. The campaigns can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -132,16 +122,6 @@ post: description: Create a campaign. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 3bdda8009b..4650841fac 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 e954d0a13b..00463258a3 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 @@ -13,16 +13,6 @@ post: 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: >- 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 9cd68bbd30..9e10d8e292 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -6,16 +6,6 @@ get: `id`. The claims can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -1032,16 +1022,6 @@ post: only applied on the order once the claim is confirmed. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 d21e89c4bf..346e6d2b60 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 @@ -12,16 +12,6 @@ get: 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: >- 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 26b84a35c1..c459dab766 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 @@ -13,16 +13,6 @@ post: 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: >- 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 114a4d338d..d2fdaca5eb 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 @@ -23,16 +23,6 @@ post: 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: >- @@ -114,16 +104,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: >- 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 9beca3cfda..1f00289c71 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 @@ -24,16 +24,6 @@ post: 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: >- 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 dd5afb6b94..fb75b34968 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 @@ -13,16 +13,6 @@ post: 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: >- 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 19a476f498..0b42eeaf6f 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -115,16 +105,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: >- 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 2e7b61df2c..c991c9dde9 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 @@ -13,16 +13,6 @@ post: 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: >- 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 fcb218598a..162470080c 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -115,16 +105,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: >- 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 83bb3918ea..146313ac84 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 @@ -11,16 +11,6 @@ post: 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: >- 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 067e0a76cd..cfd1208445 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -6,16 +6,6 @@ get: such as `id`. The collections can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -988,16 +978,6 @@ post: description: Create a collection. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 3ab169011c..b9175e8b78 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 379f8f4296..cbc0e59334 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 @@ -13,16 +13,6 @@ post: 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: >- 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 59bcf94d82..33b8c0c102 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies.yaml @@ -6,16 +6,6 @@ get: as `id`. The currencies can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 6e8ceb89c7..50737b4f4e 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 @@ -12,16 +12,6 @@ get: 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: >- 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 6d7bd5e4c0..6986da8aa1 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The customer groups can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -1038,16 +1028,6 @@ post: description: Create a customer group. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 ac44c21cda..8e9df8e2e8 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 2e0b29c201..159bba6143 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 @@ -11,16 +11,6 @@ post: 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: >- 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 3257225bba..56b843709e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -6,16 +6,6 @@ get: as `id`. The customers can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -4225,16 +4215,6 @@ post: description: Create a customer. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 55c4c2746e..ec15ac6487 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 25d0afad19..435cbf4822 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -253,16 +243,6 @@ post: 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: >- 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 2f68bf067b..39ce8fc8b9 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 @@ -18,16 +18,6 @@ get: 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: >- @@ -96,16 +86,6 @@ post: 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: >- @@ -264,16 +244,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: >- 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 6905726051..36603570fb 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 @@ -6,16 +6,6 @@ get: such as `id`. The draft orders can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -1845,16 +1835,6 @@ post: property enabled. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 60c99496b7..8c9f81443b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -6,16 +6,6 @@ get: as `id`. The exchanges can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -1021,16 +1011,6 @@ post: the exchange is confirmed. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 add4963043..7c03af30fb 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 @@ -12,16 +12,6 @@ get: 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: >- 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 8b648e2618..2ce1a484bf 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 @@ -24,16 +24,6 @@ post: 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: >- 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 c58dc9f9b5..875adf14a9 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 @@ -12,16 +12,6 @@ post: 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: >- 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 ad303775b3..f739fb19dc 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -115,16 +105,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: >- 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 56c7620b20..93eaa2fda2 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 @@ -13,16 +13,6 @@ post: 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: >- 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 a2c8b97688..c04b888f19 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -115,16 +105,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: >- 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 cf53fe9f42..ad3f25c30e 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 @@ -10,16 +10,6 @@ post: 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: >- 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 7202110f41..d0a273e9f0 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 @@ -7,16 +7,6 @@ get: sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 bc2c4a19cd..09eb248a9a 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 @@ -11,16 +11,6 @@ post: 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: >- 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 8f0d5c6e15..ad35287b5f 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 @@ -17,16 +17,6 @@ get: 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: >- @@ -95,16 +85,6 @@ post: 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: >- 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 b9ebf98d02..2f21d28cff 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml @@ -4,16 +4,6 @@ post: description: Create a fulfillment for an order, return, exchange, and more. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 38244f3f3d..21f4c984ee 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 @@ -15,16 +15,6 @@ post: 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: >- 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 0d36b5187d..cadea3bc61 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 @@ -13,16 +13,6 @@ post: 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: >- 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 7a7f0db043..38ad66561d 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The inventory items can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -507,16 +497,6 @@ post: description: Create an inventory item. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 e8eb37307f..da0f1fdb39 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 d1a1c18666..93ae3939bc 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 @@ -13,16 +13,6 @@ get: 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: >- @@ -185,16 +175,6 @@ post: 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: >- 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 3b0a543601..45aae2bc29 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 @@ -19,16 +19,6 @@ post: 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: >- @@ -118,16 +108,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: >- 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 62f2552bea..08be7736e6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -6,16 +6,6 @@ get: `id`. The invites can also be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -605,16 +595,6 @@ post: description: Create a invite. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 64cea246bc..dd0631c2eb 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 @@ -12,16 +12,6 @@ get: 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: >- 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 4ad9ac0517..15cacdc41d 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 @@ -10,16 +10,6 @@ post: 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: >- 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 f07d42df6f..26281c69ad 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications.yaml @@ -6,16 +6,6 @@ get: fields such as `id`. The notifications can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 5efed48a92..85628227f5 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 @@ -12,16 +12,6 @@ get: 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: >- 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 6cf7ae83c0..356f783919 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -6,16 +6,6 @@ get: `id`. The orders can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 0e37c2481e..68a89c114d 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -40,6 +30,54 @@ get: prefix it will replace the entire default fields. externalDocs: url: '#select-fields-and-relations' + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The order's ID. + - type: array + description: The order's ID. + items: + type: string + title: id + description: The id's ID. + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The order's status. + - type: array + description: The order's status. + items: + type: string + title: status + description: The status's details. + - name: version + in: query + description: The order's version. + required: false + schema: + type: number + title: version + description: The order's version. + - name: created_at + in: query + required: false + schema: {} + - name: updated_at + in: query + required: false + schema: {} + - name: deleted_at + in: query + required: false + schema: {} security: - api_token: [] - cookie_auth: [] @@ -83,16 +121,6 @@ post: 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: >- 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 a428b3e187..4f86e4fd21 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 @@ -10,16 +10,6 @@ post: 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: >- 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 b1674af161..f67171c4f4 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 @@ -18,16 +18,6 @@ post: 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: >- diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml index fccf4fad63..83af4bddde 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_changes.yaml @@ -17,16 +17,6 @@ get: 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: >- 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 bf1d14b98e..6231ae54ae 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 @@ -10,16 +10,6 @@ post: 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: >- 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 4151b488b9..5f72f092b4 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 @@ -13,16 +13,6 @@ post: 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: >- 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 df44b78163..be337068fc 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 @@ -18,16 +18,6 @@ post: 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: >- 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 index b79b30aedf..d6151b97c4 100644 --- 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 @@ -17,16 +17,6 @@ post: 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: >- 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 7cbf9eabf1..6c21e1c2ef 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 @@ -17,16 +17,6 @@ post: 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: >- diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml new file mode 100644 index 0000000000..03ac0feac1 --- /dev/null +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}_line-items.yaml @@ -0,0 +1,161 @@ +get: + operationId: GetOrdersIdLineItems + summary: List Line Items + description: >- + Retrieve a list of line items in a order. The line items can be filtered by + fields like FILTER FIELDS. The line items can also be paginated. + x-authenticated: true + parameters: + - name: id + in: path + description: The order's ID. + required: true + schema: + type: string + - 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' + - name: id + in: query + required: false + schema: + oneOf: + - type: string + title: id + description: The order's ID. + - type: array + description: The order's ID. + items: + type: string + title: id + description: The id's ID. + - name: item_id + in: query + required: false + schema: + oneOf: + - type: string + title: item_id + description: The order's item id. + - type: array + description: The order's item id. + items: + type: string + title: item_id + description: The item id's details. + - name: order_id + in: query + required: false + schema: + oneOf: + - type: string + title: order_id + description: The order's order id. + - type: array + description: The order's order id. + items: + type: string + title: order_id + description: The order id's details. + - name: version + in: query + required: false + schema: + oneOf: + - type: number + title: version + description: The order's version. + - type: array + description: The order's version. + items: + type: number + title: version + description: The version's details. + - name: limit + in: query + description: Limit the number of items returned in the list. + required: false + schema: + type: number + title: limit + description: Limit the number of items returned in the list. + externalDocs: + url: '#pagination' + - name: offset + in: query + description: The number of items to skip when retrieving a list. + required: false + schema: + type: number + title: offset + description: The number of items to skip when retrieving a list. + 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 `-`. + required: false + schema: + type: string + title: order + description: >- + The field to sort the data by. By default, the sort order is + ascending. To change the order to descending, prefix the field name + with `-`. + externalDocs: + url: '#pagination' + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_orders_{id}_line-items/get.sh + tags: + - Orders + responses: + '200': + description: OK + content: + application/json: + schema: + type: object + description: SUMMARY + required: + - order_items + properties: + order_items: + type: array + description: The order's order items. + items: + $ref: ../components/schemas/AdminOrderItem.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml diff --git a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml index c6e59cd860..a7e5acd535 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 @@ -4,16 +4,6 @@ post: description: Create a payment collection. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 d63a70115a..44f572f0b2 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 @@ -13,16 +13,6 @@ post: 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: >- 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 41ce909fcb..796fcf9fd4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments.yaml @@ -6,16 +6,6 @@ get: `id`. The payments can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 101129f669..c2e9e68680 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 @@ -7,16 +7,6 @@ get: paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 f02f4cd6b0..122a7c3232 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 @@ -12,16 +12,6 @@ get: 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: >- 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 0a5173fac3..7424603aaf 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 @@ -12,16 +12,6 @@ post: 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: >- 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 24babdfee5..203d5e0c12 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 @@ -12,16 +12,6 @@ post: 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: >- 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 3b35970d71..717ec6d072 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 @@ -6,16 +6,6 @@ get: such as `id`. The price lists can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -455,16 +445,6 @@ post: description: Create a price list. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 ff2994956f..5431d989a5 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 0b4eab62f0..92b6d0876b 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 @@ -10,16 +10,6 @@ post: 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: >- 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 e127c8d1db..4b3f37dcb4 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 @@ -7,16 +7,6 @@ get: paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -182,16 +172,6 @@ post: description: Create a price preference. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 2d8228d946..fcc9aa640b 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 eb519ae0dd..f3b353a77a 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 @@ -7,16 +7,6 @@ get: or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -669,16 +659,6 @@ post: description: Create a product category. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 d437b79bf8..dafd3fe56b 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -106,16 +96,6 @@ post: 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: >- 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 f5e3c3a03b..2a964233e0 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 @@ -11,16 +11,6 @@ post: 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: >- 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 6594acf9f0..6c9c318571 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 @@ -6,16 +6,6 @@ get: such as `id`. The product tags can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -578,16 +568,6 @@ post: description: Create a product tag. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 92d7dff185..7ff072a091 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 d3ca9089e5..474a0093b7 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The product types can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -578,16 +568,6 @@ post: description: Create a product type. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 ea56fefcae..04e36a912e 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 e6cf2db0c5..e8617ec73f 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The product variants can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 41ee94d129..34ee3feee4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -6,16 +6,6 @@ get: `id`. The products can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -1260,16 +1250,6 @@ post: description: Create a product. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 cee0aff78b..c53cbb9771 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 @@ -4,16 +4,6 @@ post: description: Manage products to create, update, or delete them. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 0e648decf1..73c83b8fd2 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 @@ -14,16 +14,6 @@ post: API route to retrieve the file's download URL. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 8e6c98aca3..b52ef25637 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 0ccd5a09f3..5cc494b487 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 @@ -13,16 +13,6 @@ get: 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: >- @@ -210,16 +200,6 @@ post: 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: >- 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 ccd7d7fbb7..9947bc4521 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 @@ -17,16 +17,6 @@ get: 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: >- @@ -94,16 +84,6 @@ post: 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: >- @@ -191,16 +171,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: >- 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 82c7ae4d56..675daf0ab9 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 @@ -13,16 +13,6 @@ get: 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: >- @@ -629,16 +619,6 @@ post: 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: >- 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 7581b8cc47..e83a1f83a3 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 @@ -11,16 +11,6 @@ post: 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: >- 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 36f10db280..ad7e6a31c5 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 @@ -17,16 +17,6 @@ get: 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: >- @@ -94,16 +84,6 @@ post: 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: >- @@ -189,16 +169,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: >- 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 b6a7614f2d..dc1ba67e5e 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 @@ -19,16 +19,6 @@ post: 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: >- 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 96cd064bc8..aafdc64d1c 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 @@ -25,16 +25,6 @@ post: 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: >- @@ -115,16 +105,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: >- 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 645a150e4e..b800968128 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -6,16 +6,6 @@ get: as `id`. The promotions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -632,16 +622,6 @@ post: description: Create a promotion. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 bcddaa0eec..bcb1ae5d7b 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 293cc98958..f630629910 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 @@ -13,16 +13,6 @@ post: 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: >- 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 dc3fc4b608..156fcb548a 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 @@ -11,16 +11,6 @@ post: 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: >- 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 e7ca92bc4e..274dcdf2a2 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 @@ -11,16 +11,6 @@ post: 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: >- 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 2edfdcb24a..f423ecb2af 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 @@ -31,16 +31,6 @@ get: - rules - target-rules - buy-rules - - 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: >- 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 879a2b51dc..be2fe97f71 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The refund reasons can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -184,16 +174,6 @@ post: description: Create a refund reason. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 cf3994ce94..efa8808bcb 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 35f0c8b621..b26d028d09 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -6,16 +6,6 @@ get: `id`. The regions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -623,16 +613,6 @@ post: description: Create a region. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 847a9cc879..d4c5ea365d 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 1f36008aad..ae573bbe24 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -6,16 +6,6 @@ get: such as `id`. The reservations can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -683,16 +673,6 @@ post: description: Create a reservation. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 92606bf617..8d38c4d827 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 f1281300d7..3024301806 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The return reasons can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -636,16 +626,6 @@ post: description: Create a return reason. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 01ab5f31ed..54d1ad8286 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 7673deb7e3..3e0130d911 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -6,16 +6,6 @@ get: `id`. The returns can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -798,16 +788,6 @@ post: description: Create a return. The return can later be requested or confirmed. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 d438e1b432..dec04a57a5 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 062844b68c..b9d16ab226 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 @@ -13,16 +13,6 @@ post: 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: >- 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 bb04b51a19..76d04367fc 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -116,16 +106,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: >- 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 9e88dd5a7d..9bd33b5e12 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 @@ -13,16 +13,6 @@ post: 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: >- 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 8837236ebc..950901edeb 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -116,16 +106,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: >- 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 0d0ad2d170..e2d885f1dd 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 @@ -12,16 +12,6 @@ post: 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: >- 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 858b3b8612..96e621b46f 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 @@ -12,16 +12,6 @@ post: 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: >- 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 935f6e8042..6725a4704f 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 @@ -13,16 +13,6 @@ post: 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: >- 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 e17488a1ca..39ae26960d 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -116,16 +106,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: >- 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 d08b27696e..e9c4ad693c 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 @@ -13,16 +13,6 @@ post: 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: >- 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 02e60cb178..f3bd97db24 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 @@ -13,16 +13,6 @@ post: 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: >- 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 3af59f04dc..8916a6e3ba 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 @@ -24,16 +24,6 @@ post: 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: >- @@ -115,16 +105,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: >- 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 3249aac7f7..4ef279f97e 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The sales channels can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -661,16 +651,6 @@ post: description: Create a sales channel. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 378ab89945..8ecd255a99 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 2aab7320ba..7ab66212df 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 @@ -11,16 +11,6 @@ post: 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: >- 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 6f0ea7d91a..3c82fe115b 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The shipping options can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -679,16 +669,6 @@ post: description: Create a shipping option. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 649de15b19..3efc340cc4 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -84,16 +74,6 @@ post: 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: >- 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 25ab2c2135..a6c51c8006 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 @@ -11,16 +11,6 @@ post: 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: >- 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 89bb7a961d..c111ff647e 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 @@ -7,16 +7,6 @@ get: paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -612,16 +602,6 @@ post: description: Create a shipping profile. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 ffdfec9d5c..8774da5e46 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 f8c3bcb3e2..5a1af4cc41 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 @@ -6,16 +6,6 @@ get: fields such as `id`. The stock locations can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -608,16 +598,6 @@ post: description: Create a stock location. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 554aae548a..7a7263ba5e 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 1128042ca1..240249dff4 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 @@ -13,16 +13,6 @@ post: 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: >- 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 39380fbe8f..7e174c7c93 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 @@ -11,16 +11,6 @@ post: 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: >- 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 064a9130ec..68a8bee956 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 @@ -11,16 +11,6 @@ post: 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: >- 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 2c4393b857..0c4d024bf4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores.yaml @@ -6,16 +6,6 @@ get: `id`. The stores can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 c7f099324a..3fb4c9aa09 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 09bd34f1a2..43f58552d3 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 @@ -6,16 +6,6 @@ get: as `id`. The tax rates can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -705,16 +695,6 @@ post: description: Create a tax rate. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 f847a610ce..358ce6d59b 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -82,16 +72,6 @@ post: 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: >- 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 4eb96f5a02..2e8b3d5206 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 @@ -11,16 +11,6 @@ post: 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: >- 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 3599577007..4cb382a4d0 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 @@ -17,16 +17,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: >- 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 1fb3400525..96f0ef5825 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 @@ -6,16 +6,6 @@ get: such as `id`. The tax regions can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -1328,16 +1318,6 @@ post: description: Create a tax region. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 2fb88968af..3bafecfa84 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -70,6 +60,71 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml +post: + operationId: PostTaxRegionsId + summary: Update a Tax Region + description: Update a tax region's details. + x-authenticated: true + parameters: + - name: id + in: path + description: The tax region's ID. + required: true + schema: + type: string + - 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: [] + requestBody: + content: + application/json: + schema: + $ref: ../components/schemas/AdminUpdateTaxRegion.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: ../code_samples/Shell/admin_tax-regions_{id}/post.sh + tags: + - Tax Regions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminTaxRegionResponse.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: updateTaxRegionsWorkflow delete: operationId: DeleteTaxRegionsId summary: Delete a Tax Region 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 38e004bc37..1f4dc3827c 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 @@ -12,16 +12,6 @@ get: 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: >- 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 c8f628af72..da26ca3d5d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users.yaml @@ -6,16 +6,6 @@ get: The users can also be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 1b5353b617..5948c6961f 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 @@ -4,16 +4,6 @@ get: description: Retrieve the logged-in user's details. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 5a5c6b2cea..63046c022f 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -78,16 +68,6 @@ post: 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: >- 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 615ad701a0..e74e6a2c10 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 @@ -7,16 +7,6 @@ get: or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 c6810694c7..ac98902ff2 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 @@ -12,16 +12,6 @@ get: 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: >- 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 1025661871..3fd68c43f0 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 @@ -17,16 +17,6 @@ get: 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: >- 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 79e31f7d86..1a0af19c8f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -3,9 +3,9 @@ description: The filfillment's details. x-schemaName: AdminCreateFulfillment required: - data - - order_id - - metadata - items + - metadata + - order_id - location_id - provider_id - delivery_address diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml index d4cece0e33..a16b8cb40c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateProduct.yaml @@ -3,6 +3,7 @@ description: The product's details. x-schemaName: AdminCreateProduct required: - title + - options properties: title: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml index 2477095764..69a57280bd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOption.yaml @@ -2,19 +2,87 @@ type: object description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - label - - description - - code + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices properties: - label: + name: type: string - title: label - description: The type's label. - description: + title: name + description: The shipping option's name. + service_zone_id: type: string - title: description - description: The type's description. - code: + title: service_zone_id + description: The ID of the associated service zone. + shipping_profile_id: type: string - title: code - description: The type's code. + title: shipping_profile_id + description: The ID of the associated shipping profile. + data: + type: object + description: >- + The shipping option's data, useful for the fulfillment provider handling + its processing. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + price_type: + type: string + description: >- + The shipping option's price type. If `flat`, the shipping option has a + fixed price set in `prices`. Otherwise, the shipping option's price is + calculated by the fulfillment provider. + enum: + - flat + - calculated + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider handling this shipping option. + type: + $ref: ./AdminCreateShippingOptionType.yaml + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's details. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency + required: + - currency_code + - amount + properties: + 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. + - type: object + description: The price's details. + 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionType.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionType.yaml new file mode 100644 index 0000000000..a4cee2ce64 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingOptionType.yaml @@ -0,0 +1,20 @@ +type: object +description: The shipping option type's details. +x-schemaName: AdminCreateShippingOptionType +required: + - label + - description + - code +properties: + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. 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 31e20a4158..0123920e3f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchange.yaml @@ -95,7 +95,7 @@ properties: title: deleted_at description: The date the exchange was deleted. order: - $ref: ./AdminOrder.yaml + $ref: ./BaseOrder.yaml allow_backorder: type: boolean title: allow_backorder diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml index 03bc03d999..740cc7b536 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminExchangeOrderResponse.yaml @@ -6,7 +6,6 @@ required: - exchange properties: order: - description: The details of the associated order. $ref: ./Order.yaml exchange: $ref: ./AdminExchange.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml index e90b9b2d8f..fd28a5a6b1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrder.yaml @@ -7,16 +7,16 @@ required: - shipping_methods - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml index 3297e8bcca..195bd76d5e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChange.yaml @@ -8,12 +8,12 @@ required: - exchange - actions - status - - order_id - - metadata - id + - version + - metadata - created_at - updated_at - - version + - order_id - canceled_at - return_id - exchange_id @@ -62,11 +62,7 @@ properties: title: claim_id description: The ID of the associated claim. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml return_order: $ref: ./AdminReturn.yaml exchange: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml index 3f93eb71ce..ebcaf79e3f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderChangeAction.yaml @@ -4,11 +4,11 @@ x-schemaName: AdminOrderChangeAction required: - order_change - order - - order_id - - internal_note - id - created_at - updated_at + - order_id + - internal_note - return_id - exchange_id - claim_id @@ -45,11 +45,7 @@ properties: title: exchange_id description: The ID of the associated exchange. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: ./AdminOrder.yaml reference: type: string title: reference diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderItem.yaml new file mode 100644 index 0000000000..7f762a3fc9 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderItem.yaml @@ -0,0 +1,45 @@ +type: object +description: The order item's details. +x-schemaName: AdminOrderItem +required: + - order_id + - item_id + - version + - history + - item +properties: + order_id: + type: string + title: order_id + description: The ID of the order this item belongs to. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + version: + type: number + title: version + description: The order item's version. + history: + type: object + description: The order item's history. + required: + - version + properties: + version: + type: object + description: The version changes of the item. + required: + - from + - to + properties: + from: + type: number + title: from + description: The original version. + to: + type: number + title: to + description: The new version. + item: + $ref: ./AdminOrderLineItem.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml index 41d7121777..7fef9541dd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderLineItem.yaml @@ -3,10 +3,8 @@ description: The item's details. x-schemaName: AdminOrderLineItem required: - title - - metadata - id - - subtitle - - thumbnail + - metadata - created_at - updated_at - item_total @@ -20,6 +18,8 @@ required: - tax_total - discount_total - discount_tax_total + - subtitle + - thumbnail - variant_id - product_id - product_title 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 fef57add5b..ea3aa5ac25 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -8,17 +8,17 @@ required: - order_change - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_collections - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml index 5e4fcec7be..d477bfb838 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsAddItemsReqSchema.yaml @@ -37,3 +37,7 @@ properties: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml index 0d80349175..ababf23ed1 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsItemsActionReqSchema.yaml @@ -14,3 +14,7 @@ properties: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml index bf3acfba0e..3d172e017c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml @@ -16,3 +16,7 @@ properties: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. 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 e197602dfa..58fdf04753 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProduct.yaml @@ -11,10 +11,12 @@ required: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -26,8 +28,6 @@ required: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: collection: diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml new file mode 100644 index 0000000000..d599385b83 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRegion.yaml @@ -0,0 +1,11 @@ +type: object +description: The details to update in a tax region. +x-schemaName: AdminUpdateTaxRegion +properties: + province_code: + type: string + title: province_code + description: The tax region's province code. + metadata: + type: object + description: The tax region's metadata, can hold custom key-value pairs. 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 f8db134ea0..ac22d66e39 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseCalculatedPriceSet.yaml @@ -56,60 +56,6 @@ properties: 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 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/BaseCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseCollection.yaml index 6b7390021c..898e69ae05 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,47 @@ type: object -description: The collection's details. +description: The product 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 collection's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's update date. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deletion date. + products: + type: array + description: The collection's products. + items: + $ref: ./AdminProduct.yaml + metadata: + type: object + description: The collection's metadata, used to store custom key-value pairs. 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 2b2d4962a6..80d2a024bc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrder.yaml @@ -2,7 +2,6 @@ type: object description: The order's details. x-schemaName: BaseOrder required: - - payment_collections - id - version - region_id @@ -15,7 +14,6 @@ required: - payment_status - fulfillment_status - summary - - metadata - created_at - updated_at - original_item_total @@ -45,20 +43,16 @@ properties: type: array description: The order's payment collections. items: - $ref: ./AdminPaymentCollection.yaml + $ref: ./BasePaymentCollection.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 + $ref: ./BaseOrderAddress.yaml billing_address: - $ref: ./AdminOrderAddress.yaml + $ref: ./BaseOrderAddress.yaml id: type: string title: id 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 ffdb335848..e3d3b54635 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: An order address +description: An order address. x-schemaName: BaseOrderAddress required: - id @@ -48,8 +48,6 @@ properties: title: country_code description: The address's country code. example: us - country: - $ref: ./AdminRegionCountry.yaml province: type: string title: province 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 12970b6fe2..eba0b4539b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseOrderFulfillment.yaml @@ -1,5 +1,5 @@ type: object -description: The fulfillment's fulfillments. +description: The fulfillment's details. x-schemaName: BaseOrderFulfillment required: - id @@ -8,6 +8,7 @@ required: - shipped_at - delivered_at - canceled_at + - requires_shipping - data - provider_id - shipping_option_id @@ -72,3 +73,7 @@ properties: 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/BasePaymentProvider.yaml b/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml index 2b73a963fb..e58d96408f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BasePaymentProvider.yaml @@ -1,5 +1,5 @@ type: object -description: The payment provider's payment providers. +description: The payment provider's details. x-schemaName: BasePaymentProvider required: - id diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml index 8bb7bdbaca..e8b62d10e8 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductCategory.yaml @@ -1,3 +1,84 @@ type: object -description: The category's categories. +description: The product category's details. x-schemaName: BaseProductCategory +required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at +properties: + category_children: + type: array + description: The category's children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + metadata: + type: object + description: The category's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the category was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the category was updated. + handle: + type: string + title: handle + description: The category's unique handle. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the category was deleted. + is_active: + type: boolean + title: is_active + description: >- + Whether the category is active. If disabled, the category isn't shown in + the storefront. + is_internal: + type: boolean + title: is_internal + description: >- + Whether the category is internal. If enabled, the category is only seen by + admin users. + rank: + type: number + title: rank + description: The category's rank among sibling categories. + parent_category_id: + type: string + title: parent_category_id + description: The ID of the category's parent. 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 152999bb1c..7964d121fe 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductOption.yaml @@ -1,44 +1,44 @@ type: object description: The product option's details. x-schemaName: BaseProductOption +required: + - id + - title properties: id: type: string title: id - description: The option's ID. + description: The product option's ID. title: type: string title: title - description: The option's title. + description: The product option's title. product: type: object product_id: type: string title: product_id - description: The option's product id. + description: The ID of the product this option belongs to. values: type: array - description: The option's values. + description: The product option's values. items: $ref: ./BaseProductOptionValue.yaml metadata: type: object - description: The 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 option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The option's deleted at. -required: - - id - - title + description: The date the product option was deleted. diff --git a/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml b/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml index eeff43fa01..2f9a58b017 100644 --- a/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/BaseProductTag.yaml @@ -1,3 +1,35 @@ type: object -description: The tag's tags. +description: The product tag's details. x-schemaName: BaseProductTag +required: + - id + - value + - created_at + - updated_at +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. 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 47214c6a82..6b9aca9fd7 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Order.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Order.yaml @@ -31,28 +31,6 @@ required: - 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 @@ -228,69 +206,3 @@ properties: 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/OrderClaim.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml index 41bb209451..4739eb812c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderClaim.yaml @@ -2,44 +2,14 @@ type: object description: The order change's claim. x-schemaName: OrderClaim required: + - id + - type - order_id + - order_version + - display_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 @@ -70,79 +40,29 @@ properties: title: no_notification description: Whether the customer should be notified about changes in the claim. refund_amount: - type: number - title: refund_amount + oneOf: + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's refund amount. + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's 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: ./OrderShippingMethod.yaml transactions: type: array description: The claim's transactions. @@ -151,9 +71,7 @@ properties: 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 + $ref: ./OrderTransaction.yaml metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -167,91 +85,43 @@ properties: format: date-time title: updated_at description: The claim's update date. - original_item_total: + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order: + $ref: ./Order.yaml + order_version: 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. + title: order_version + description: The claim's order version. + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time 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 c0ba54357b..857b9ed634 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderExchange.yaml @@ -2,54 +2,17 @@ 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 + - order_id + - order_version + - display_id + - additional_items - 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. @@ -67,88 +30,24 @@ properties: be refunded. If positive, additional payment is required from the customer. return: - description: the return associated with the exchange. - $ref: ./AdminReturn.yaml + $ref: ./Return.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 + $ref: ./OrderShippingMethod.yaml transactions: type: array description: The exchange's transactions. @@ -156,10 +55,7 @@ properties: 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 + $ref: ./OrderTransaction.yaml metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -173,91 +69,43 @@ properties: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: + order: + $ref: ./Order.yaml + order_version: 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. + title: order_version + description: The version of the order when the exchange is applied. + raw_difference_due: + oneOf: + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + allow_backorder: + type: boolean + title: allow_backorder + description: >- + Whether variants that are out of stock can be added to the exchange as + outbound items. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time 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 ccd2567ac5..ab12ebb4d2 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderItem.yaml @@ -6,21 +6,13 @@ required: - 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 @@ -39,58 +31,34 @@ properties: 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. diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml index 7872ecc8f1..be86e71967 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItem.yaml @@ -8,9 +8,7 @@ required: - is_discountable - is_tax_inclusive - unit_price - - raw_unit_price - quantity - - raw_quantity - detail - created_at - updated_at @@ -27,19 +25,6 @@ required: - 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 @@ -122,56 +107,14 @@ properties: 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. @@ -251,185 +194,3 @@ properties: 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/OrderLineItemTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml index 90d590d62b..9e7f1613bb 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderLineItemTaxLine.yaml @@ -6,8 +6,6 @@ required: - item_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -28,12 +26,6 @@ properties: 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 diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml index 2b2fa31a38..e6fc76e22f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderReturnItem.yaml @@ -3,11 +3,10 @@ description: The item's items. x-schemaName: OrderReturnItem required: - id - - quantity - - received_quantity - - damaged_quantity - - item_id - return_id + - order_id + - item_id + - quantity properties: id: type: string @@ -23,20 +22,10 @@ properties: 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 @@ -48,3 +37,17 @@ properties: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + order_id: + type: string + title: order_id + description: The ID of the order the return belongs to. + 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/OrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml index 892005eea0..3aa794be00 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethod.yaml @@ -6,7 +6,6 @@ required: - order_id - name - amount - - raw_amount - is_tax_inclusive - created_at - updated_at @@ -18,14 +17,6 @@ required: - 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 @@ -47,20 +38,6 @@ properties: 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 @@ -132,115 +109,3 @@ properties: 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/OrderShippingMethodTaxLine.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml index d49d3e1414..e2a987241e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderShippingMethodTaxLine.yaml @@ -6,8 +6,6 @@ required: - shipping_method_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -28,12 +26,6 @@ properties: 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 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 100e873e64..39323d6113 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderTransaction.yaml @@ -4,6 +4,7 @@ x-schemaName: OrderTransaction required: - id - order_id + - order - amount - currency_code - reference @@ -56,3 +57,5 @@ properties: format: date-time title: updated_at description: The date that the transaction was updated. + order: + type: object 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 b16dbae793..cfefdef18c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/Return.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/Return.yaml @@ -6,54 +6,8 @@ required: - 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 + - display_id + - metadata properties: id: type: string @@ -80,32 +34,6 @@ properties: 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. @@ -116,9 +44,6 @@ properties: 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. @@ -132,168 +57,67 @@ properties: 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: + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + order: + $ref: ./Order.yaml + exchange_id: + type: string + title: exchange_id + description: The ID of the exchange this return belongs to, if any. + exchange: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the claim this return belongs to, if any. + claim: + $ref: ./OrderClaim.yaml + display_id: 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. + title: display_id + description: The return order's display ID. + location_id: + type: string + title: location_id + description: The ID of the stock location the items are returned to. + no_notification: + type: boolean + title: no_notification + description: Whether to notify the customer about changes in the return. + created_by: + type: string + title: created_by + description: The ID of the user that created the return. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the return was deleted. + requested_at: + type: string + title: requested_at + description: The date the return was requested. + format: date-time + received_at: + type: string + title: received_at + description: The date the return was received. + format: date-time 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 ad9bc1b4ea..121ef729ec 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreCollection.yaml @@ -3,11 +3,11 @@ description: The collection's details. x-schemaName: StoreCollection required: - title - - metadata - id - - handle + - metadata - created_at - updated_at + - handle - deleted_at properties: id: 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 58ff75075f..5050fb4835 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrder.yaml @@ -2,19 +2,17 @@ type: object description: The order's details. x-schemaName: StoreOrder required: + - items + - shipping_methods + - currency_code - 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 @@ -44,10 +42,6 @@ properties: 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 @@ -75,24 +69,24 @@ properties: title: display_id description: The order's display ID. shipping_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./StoreOrderAddress.yaml billing_address: - $ref: ./BaseOrderAddress.yaml + $ref: ./StoreOrderAddress.yaml items: type: array description: The order's items. items: - $ref: ./BaseOrderLineItem.yaml + $ref: ./StoreOrderLineItem.yaml shipping_methods: type: array description: The order's shipping methods. items: - $ref: ./BaseOrderShippingMethod.yaml + $ref: ./StoreOrderShippingMethod.yaml payment_collections: type: array description: The order's payment collections. items: - $ref: ./BasePaymentCollection.yaml + $ref: ./StorePaymentCollection.yaml payment_status: type: string description: The order's payment status. @@ -111,7 +105,7 @@ properties: type: array description: The order's fulfillments. items: - $ref: ./BaseOrderFulfillment.yaml + $ref: ./StoreOrderFulfillment.yaml fulfillment_status: type: string description: The order's fulfillment status. @@ -227,3 +221,10 @@ properties: type: number title: original_shipping_tax_total description: The total taxes of the order's shipping excluding promotions. + customer: + $ref: ./StoreCustomer.yaml + transactions: + type: array + description: The order's transactions. + items: + $ref: ./BaseOrderTransaction.yaml diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml new file mode 100644 index 0000000000..54ec49cf34 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderAddress.yaml @@ -0,0 +1,73 @@ +type: object +description: An order address +x-schemaName: StoreOrderAddress +required: + - id + - metadata + - created_at + - updated_at +properties: + 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 + country: + $ref: ./StoreRegionCountry.yaml + 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/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml new file mode 100644 index 0000000000..4c9e22c359 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderFulfillment.yaml @@ -0,0 +1,79 @@ +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 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: The fulfillment's requires shipping. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml new file mode 100644 index 0000000000..e8659e7a8e --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderLineItem.yaml @@ -0,0 +1,4011 @@ +type: object +description: The item's details. +x-schemaName: StoreOrderLineItem +required: + - detail + - 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 + - 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: ./StoreProductVariant.yaml + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: ./StoreProduct.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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The tax line's tax lines. + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The adjustment's details. + detail: + allOf: + - $ref: ./BaseOrderItemDetail.yaml + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The item's detail. + 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/StoreOrderShippingMethod.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml new file mode 100644 index 0000000000..513ce23b45 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreOrderShippingMethod.yaml @@ -0,0 +1,1714 @@ +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 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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The adjustment's adjustments. + 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: + allOf: + - $ref: ./BaseOrderShippingDetail.yaml + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: Details of changes to a shipping method. 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 044867e21f..da21ace142 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProduct.yaml @@ -10,10 +10,12 @@ required: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -25,8 +27,6 @@ required: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: categories: diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml index 4d7558620a..a71c20070e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreProductVariant.yaml @@ -122,6 +122,8 @@ required: - length - title - id + - created_at + - updated_at - width - weight - height @@ -129,8 +131,6 @@ required: - hs_code - mid_code - material - - created_at - - updated_at - deleted_at - sku - barcode 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..b0e6213abb --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/StoreRegionCountry.yaml @@ -0,0 +1,33 @@ +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. + 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/StoreReturn.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml index 2b3ca272bf..346a9d0a1b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreReturn.yaml @@ -3,10 +3,10 @@ description: The return's details. x-schemaName: StoreReturn required: - items - - order_id - id - - created_at - display_id + - created_at + - order_id - canceled_at - received_at properties: diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 25ec9b80ea..51038dd77c 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -568,14 +568,6 @@ paths: description: Create a cart. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -640,14 +632,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. @@ -697,14 +681,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. @@ -778,14 +754,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. @@ -889,14 +857,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. @@ -969,14 +929,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. @@ -1047,14 +999,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. @@ -1134,14 +1078,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. @@ -1214,14 +1150,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. @@ -1283,14 +1211,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. @@ -1351,7 +1271,7 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - x-workflow: addShippingMethodToWorkflow + x-workflow: addShippingMethodToCartWorkflow /store/carts/{id}/taxes: post: operationId: PostCartsIdTaxes @@ -1366,14 +1286,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. @@ -1422,14 +1334,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list description: 'Storefront guide: How to retrieve a list of collections.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2289,14 +2193,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. @@ -2341,14 +2237,6 @@ paths: description: Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2469,14 +2357,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. @@ -2524,14 +2404,6 @@ paths: description: 'Storefront guide: How to register a customer.' x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2598,14 +2470,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve description: 'Storefront guide: How to retrieve the logged-in customer.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2656,14 +2520,6 @@ paths: description: 'Storefront guide: How to edit a customer''s profile.' x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2729,14 +2585,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -2869,14 +2717,6 @@ paths: description: 'Storefront guide: How to create an address for the logged-in customer.' x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -3010,14 +2850,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. @@ -3075,14 +2907,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. @@ -3207,14 +3031,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. @@ -3292,14 +3108,6 @@ paths: description: Retrieve the orders of the logged-in customer. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -3478,14 +3286,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. @@ -3534,14 +3334,6 @@ paths: description: 'Storefront guide: How to implement payment during checkout.' x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -3609,14 +3401,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. @@ -3692,14 +3476,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment description: 'Storefront guide: How to implement payment during checkout.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -3812,14 +3588,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list description: 'Storefront guide: How to retrieve a list of product categories.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -4706,14 +4474,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. @@ -4777,14 +4537,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/products/price description: 'Storefront guide: How to retrieve a product variants'' prices.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -5790,14 +5542,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. @@ -5880,14 +5624,6 @@ paths: url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list description: 'Storefront guide: How to retrieve a list of regions.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -6065,14 +5801,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. @@ -6178,14 +5906,6 @@ paths: description: Retrieve a list of return reasons. The return reasons can be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - name: fields in: query description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. @@ -6293,14 +6013,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. @@ -7173,9 +6885,9 @@ components: x-schemaName: AdminCreateFulfillment required: - data - - order_id - - metadata - items + - metadata + - order_id - location_id - provider_id - delivery_address @@ -7496,6 +7208,7 @@ components: x-schemaName: AdminCreateProduct required: - title + - options properties: title: type: string @@ -8081,22 +7794,84 @@ components: description: The shipping option's details. x-schemaName: AdminCreateShippingOption required: - - label - - description - - code + - name + - service_zone_id + - shipping_profile_id + - price_type + - provider_id + - type + - prices properties: - label: + name: type: string - title: label - description: The type's label. - description: + title: name + description: The shipping option's name. + service_zone_id: type: string - title: description - description: The type's description. - code: + title: service_zone_id + description: The ID of the associated service zone. + shipping_profile_id: type: string - title: code - description: The type's code. + title: shipping_profile_id + description: The ID of the associated shipping profile. + data: + type: object + description: The shipping option's data, useful for the fulfillment provider handling its processing. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + price_type: + type: string + description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider. + enum: + - flat + - calculated + provider_id: + type: string + title: provider_id + description: The ID of the fulfillment provider handling this shipping option. + type: + $ref: '#/components/schemas/AdminCreateShippingOptionType' + prices: + type: array + description: The shipping option's prices. + items: + oneOf: + - type: object + description: The price's details. + x-schemaName: AdminCreateShippingOptionPriceWithCurrency + required: + - currency_code + - amount + properties: + 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. + - type: object + description: The price's details. + 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' AdminCreateShippingOptionRule: type: object description: The details of the shipping option rule. @@ -8136,6 +7911,27 @@ components: title: value description: A value of the attribute that enables this rule. example: cusgroup_123 + AdminCreateShippingOptionType: + type: object + description: The shipping option type's details. + x-schemaName: AdminCreateShippingOptionType + required: + - label + - description + - code + properties: + label: + type: string + title: label + description: The type's label. + description: + type: string + title: description + description: The type's description. + code: + type: string + title: code + description: The type's code. AdminCreateShippingProfile: type: object description: The shipping profile's details. @@ -9362,7 +9158,7 @@ components: title: deleted_at description: The date the exchange was deleted. order: - $ref: '#/components/schemas/AdminOrder' + $ref: '#/components/schemas/BaseOrder' allow_backorder: type: boolean title: allow_backorder @@ -9398,7 +9194,6 @@ components: - exchange properties: order: - description: The details of the associated order. $ref: '#/components/schemas/Order' exchange: $ref: '#/components/schemas/AdminExchange' @@ -10345,16 +10140,16 @@ components: - shipping_methods - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total @@ -10658,12 +10453,12 @@ components: - exchange - actions - status - - order_id - - metadata - id + - version + - metadata - created_at - updated_at - - version + - order_id - canceled_at - return_id - exchange_id @@ -10710,11 +10505,7 @@ components: title: claim_id description: The ID of the associated claim. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' return_order: $ref: '#/components/schemas/AdminReturn' exchange: @@ -10795,11 +10586,11 @@ components: required: - order_change - order - - order_id - - internal_note - id - created_at - updated_at + - order_id + - internal_note - return_id - exchange_id - claim_id @@ -10836,11 +10627,7 @@ components: title: exchange_id description: The ID of the associated exchange. order: - type: string - title: order - description: The order change's order. - externalDocs: - url: '#pagination' + $ref: '#/components/schemas/AdminOrder' reference: type: string title: reference @@ -11000,16 +10787,60 @@ components: type: boolean title: requires_shipping description: Whether the fulfillment requires shipping. + AdminOrderItem: + type: object + description: The order item's details. + x-schemaName: AdminOrderItem + required: + - order_id + - item_id + - version + - history + - item + properties: + order_id: + type: string + title: order_id + description: The ID of the order this item belongs to. + item_id: + type: string + title: item_id + description: The ID of the associated line item. + version: + type: number + title: version + description: The order item's version. + history: + type: object + description: The order item's history. + required: + - version + properties: + version: + type: object + description: The version changes of the item. + required: + - from + - to + properties: + from: + type: number + title: from + description: The original version. + to: + type: number + title: to + description: The new version. + item: + $ref: '#/components/schemas/AdminOrderLineItem' AdminOrderLineItem: type: object description: The item's details. x-schemaName: AdminOrderLineItem required: - title - - metadata - id - - subtitle - - thumbnail + - metadata - created_at - updated_at - item_total @@ -11023,6 +10854,8 @@ components: - tax_total - discount_total - discount_tax_total + - subtitle + - thumbnail - variant_id - product_id - product_title @@ -11223,17 +11056,17 @@ components: - order_change - currency_code - id - - created_at - - updated_at - - email - version - region_id - customer_id - sales_channel_id + - email - payment_collections - payment_status - fulfillment_status - summary + - created_at + - updated_at - original_item_total - original_item_subtotal - original_item_tax_total @@ -12625,6 +12458,10 @@ components: metadata: type: object description: The item's metadata, can hold custom key-value pairs. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. AdminPostOrderEditsItemsActionReqSchema: type: object description: The details to update in the item. @@ -12642,6 +12479,10 @@ components: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. AdminPostOrderEditsReqSchema: type: object description: The order edit's details. @@ -12725,6 +12566,10 @@ components: type: number title: unit_price description: The item's unit price. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The original price of the item before a promotion or sale. AdminPostOrderExchangesReqSchema: type: object description: The exchange's details. @@ -13404,10 +13249,12 @@ components: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -13419,8 +13266,6 @@ components: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: collection: @@ -16729,6 +16574,18 @@ components: metadata: type: object description: The tax rate's metadata, can hold custom key-value pairs. + AdminUpdateTaxRegion: + type: object + description: The details to update in a tax region. + x-schemaName: AdminUpdateTaxRegion + properties: + province_code: + type: string + title: province_code + description: The tax region's province code. + metadata: + type: object + description: The tax region's metadata, can hold custom key-value pairs. AdminUpdateUser: type: object description: The properties to update in a user. @@ -17277,63 +17134,9 @@ components: 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 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 details of a captured payment. @@ -17915,8 +17718,52 @@ components: description: The date the claim was updated. BaseCollection: type: object - description: The collection's details. + description: The product 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 collection's creation date. + updated_at: + type: string + format: date-time + title: updated_at + description: The collection's update date. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The collection's deletion date. + products: + type: array + description: The collection's products. + items: + $ref: '#/components/schemas/AdminProduct' + metadata: + type: object + description: The collection's metadata, used to store custom key-value pairs. BaseExchangeItem: type: object description: The item's details. @@ -18104,7 +17951,6 @@ components: description: The order's details. x-schemaName: BaseOrder required: - - payment_collections - id - version - region_id @@ -18117,7 +17963,6 @@ components: - payment_status - fulfillment_status - summary - - metadata - created_at - updated_at - original_item_total @@ -18147,20 +17992,16 @@ components: type: array description: The order's payment collections. items: - $ref: '#/components/schemas/AdminPaymentCollection' + $ref: '#/components/schemas/BasePaymentCollection' 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' + $ref: '#/components/schemas/BaseOrderAddress' billing_address: - $ref: '#/components/schemas/AdminOrderAddress' + $ref: '#/components/schemas/BaseOrderAddress' id: type: string title: id @@ -18340,7 +18181,7 @@ components: description: The tax total of the order's shipping excluding promotions. BaseOrderAddress: type: object - description: An order address + description: An order address. x-schemaName: BaseOrderAddress required: - id @@ -18389,8 +18230,6 @@ components: title: country_code description: The address's country code. example: us - country: - $ref: '#/components/schemas/AdminRegionCountry' province: type: string title: province @@ -18414,7 +18253,7 @@ components: description: The date the address was updated. BaseOrderFulfillment: type: object - description: The fulfillment's fulfillments. + description: The fulfillment's details. x-schemaName: BaseOrderFulfillment required: - id @@ -18423,6 +18262,7 @@ components: - shipped_at - delivered_at - canceled_at + - requires_shipping - data - provider_id - shipping_option_id @@ -18484,6 +18324,10 @@ components: 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. BaseOrderItemDetail: type: object description: The item's detail. @@ -19460,7 +19304,7 @@ components: $ref: '#/components/schemas/BasePayment' BasePaymentProvider: type: object - description: The payment provider's payment providers. + description: The payment provider's details. x-schemaName: BasePaymentProvider required: - id @@ -19693,8 +19537,85 @@ components: description: The product's metadata. BaseProductCategory: type: object - description: The category's categories. + description: The product category's details. x-schemaName: BaseProductCategory + required: + - id + - name + - description + - handle + - is_active + - is_internal + - rank + - parent_category_id + - parent_category + - category_children + - created_at + - updated_at + - deleted_at + properties: + category_children: + type: array + description: The category's children. + items: + type: object + parent_category: + type: object + products: + type: array + description: The category's products. + items: + type: object + name: + type: string + title: name + description: The category's name. + description: + type: string + title: description + description: The category's description. + id: + type: string + title: id + description: The category's ID. + metadata: + type: object + description: The category's metadata, can hold custom key-value pairs. + created_at: + type: string + format: date-time + title: created_at + description: The date the category was created. + updated_at: + type: string + format: date-time + title: updated_at + description: The date the category was updated. + handle: + type: string + title: handle + description: The category's unique handle. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the category was deleted. + is_active: + type: boolean + title: is_active + description: Whether the category is active. If disabled, the category isn't shown in the storefront. + is_internal: + type: boolean + title: is_internal + description: Whether the category is internal. If enabled, the category is only seen by admin users. + rank: + type: number + title: rank + description: The category's rank among sibling categories. + parent_category_id: + type: string + title: parent_category_id + description: The ID of the category's parent. BaseProductImage: type: object description: The image's details. @@ -19733,47 +19654,47 @@ components: type: object description: The product option's details. x-schemaName: BaseProductOption + required: + - id + - title properties: id: type: string title: id - description: The option's ID. + description: The product option's ID. title: type: string title: title - description: The option's title. + description: The product option's title. product: type: object product_id: type: string title: product_id - description: The option's product id. + description: The ID of the product this option belongs to. values: type: array - description: The option's values. + description: The product option's values. items: $ref: '#/components/schemas/BaseProductOptionValue' metadata: type: object - description: The 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 option's created at. + description: The date the product option was created. updated_at: type: string format: date-time title: updated_at - description: The option's updated at. + description: The date the product option was updated. deleted_at: type: string format: date-time title: deleted_at - description: The option's deleted at. - required: - - id - - title + description: The date the product option was deleted. BaseProductOptionValue: type: object description: The product option value's details. @@ -19816,8 +19737,40 @@ components: description: The date the value was deleted. BaseProductTag: type: object - description: The tag's tags. + description: The product tag's details. x-schemaName: BaseProductTag + required: + - id + - value + - created_at + - updated_at + 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. BaseProductVariant: type: object description: The product variant's details. @@ -20843,28 +20796,6 @@ components: - 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 @@ -21040,72 +20971,6 @@ components: 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 address's details. @@ -21420,44 +21285,14 @@ components: description: The order change's claim. x-schemaName: OrderClaim required: + - id + - type - order_id + - order_version + - display_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 @@ -21488,79 +21323,29 @@ components: title: no_notification description: Whether the customer should be notified about changes in the claim. refund_amount: - type: number - title: refund_amount + oneOf: + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's refund amount. + - type: string + title: refund_amount + description: The claim's refund amount. + - type: number + title: refund_amount + description: The claim's 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/OrderShippingMethod' transactions: type: array description: The claim's transactions. @@ -21568,9 +21353,7 @@ components: 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' + $ref: '#/components/schemas/OrderTransaction' metadata: type: object description: The claim's metadata, used to store custom key-value pairs. @@ -21584,147 +21367,62 @@ components: format: date-time title: updated_at description: The claim's update date. - original_item_total: + type: + type: string + description: The claim's type. + enum: + - replace + - refund + order: + $ref: '#/components/schemas/Order' + order_version: 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. + title: order_version + description: The claim's order version. + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + - type: string + title: raw_refund_amount + description: The claim's raw refund amount. + - type: number + title: raw_refund_amount + description: The claim's raw refund amount. + created_by: + type: string + title: created_by + description: The ID of the user that created the claim. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the claim was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the claim was canceled. + format: date-time 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 + - order_id + - order_version + - display_id + - additional_items - 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. @@ -21739,98 +21437,31 @@ 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' + $ref: '#/components/schemas/Return' 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 + $ref: '#/components/schemas/OrderShippingMethod' 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' + $ref: '#/components/schemas/OrderTransaction' metadata: type: object description: The exchange's metadata, can hold custom key-value pairs. @@ -21844,94 +21475,44 @@ components: format: date-time title: updated_at description: The date that the exchange was updated. - original_item_total: + order: + $ref: '#/components/schemas/Order' + order_version: 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. + title: order_version + description: The version of the order when the exchange is applied. + raw_difference_due: + oneOf: + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + - type: string + title: raw_difference_due + description: The exchange's raw difference due. + - type: number + title: raw_difference_due + description: The exchange's raw difference due. + allow_backorder: + type: boolean + title: allow_backorder + description: Whether variants that are out of stock can be added to the exchange as outbound items. + created_by: + type: string + title: created_by + description: The ID of the user that created the exchange. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the exchange was deleted. + canceled_at: + type: string + title: canceled_at + description: The date the exchange was canceled. + format: date-time OrderItem: type: object description: The order item's detail. @@ -21941,21 +21522,13 @@ components: - 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 @@ -21974,58 +21547,34 @@ components: 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. @@ -22050,9 +21599,7 @@ components: - is_discountable - is_tax_inclusive - unit_price - - raw_unit_price - quantity - - raw_quantity - detail - created_at - updated_at @@ -22069,19 +21616,6 @@ components: - 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 @@ -22164,56 +21698,14 @@ components: 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. @@ -22291,188 +21783,6 @@ components: 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. @@ -22539,8 +21849,6 @@ components: - item_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -22561,12 +21869,6 @@ components: 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 @@ -22607,11 +21909,10 @@ components: x-schemaName: OrderReturnItem required: - id - - quantity - - received_quantity - - damaged_quantity - - item_id - return_id + - order_id + - item_id + - quantity properties: id: type: string @@ -22625,18 +21926,10 @@ components: 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 @@ -22648,6 +21941,20 @@ components: metadata: type: object description: The return item's metadata, can hold custom key-value pairs. + order_id: + type: string + title: order_id + description: The ID of the order the return belongs to. + 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. OrderShippingMethod: type: object description: The shipping method's details. @@ -22657,7 +21964,6 @@ components: - order_id - name - amount - - raw_amount - is_tax_inclusive - created_at - updated_at @@ -22669,14 +21975,6 @@ components: - 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 @@ -22698,20 +21996,6 @@ components: 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 @@ -22780,118 +22064,6 @@ components: 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. @@ -22958,8 +22130,6 @@ components: - shipping_method_id - total - subtotal - - raw_total - - raw_subtotal - id - code - rate @@ -22980,12 +22150,6 @@ components: 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 @@ -23027,6 +22191,7 @@ components: required: - id - order_id + - order - amount - currency_code - reference @@ -23076,6 +22241,8 @@ components: format: date-time title: updated_at description: The date that the transaction was updated. + order: + type: object RefundReason: type: object description: The refund reason's details. @@ -23130,54 +22297,8 @@ components: - 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 + - display_id + - metadata properties: id: type: string @@ -23204,32 +22325,6 @@ components: description: The return's items. items: $ref: '#/components/schemas/OrderReturnItem' - 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: '#/components/schemas/OrderAddress' - billing_address: - $ref: '#/components/schemas/OrderAddress' shipping_methods: type: array description: The return's shipping methods. @@ -23240,9 +22335,6 @@ components: description: The return's transactions. items: $ref: '#/components/schemas/OrderTransaction' - summary: - type: object - description: The return's summary. metadata: type: object description: The return's metadata, can hold custom key-value pairs. @@ -23256,171 +22348,70 @@ components: 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: '#/components/schemas/OrderChange' canceled_at: type: string title: canceled_at description: The date the return was canceled. format: date-time - discount_subtotal: + raw_refund_amount: + oneOf: + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + - type: string + title: raw_refund_amount + description: The return order's raw refund amount. + - type: number + title: raw_refund_amount + description: The return order's raw refund amount. + order: + $ref: '#/components/schemas/Order' + exchange_id: + type: string + title: exchange_id + description: The ID of the exchange this return belongs to, if any. + exchange: + type: object + claim_id: + type: string + title: claim_id + description: The ID of the claim this return belongs to, if any. + claim: + $ref: '#/components/schemas/OrderClaim' + display_id: 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. + title: display_id + description: The return order's display ID. + location_id: + type: string + title: location_id + description: The ID of the stock location the items are returned to. + no_notification: + type: boolean + title: no_notification + description: Whether to notify the customer about changes in the return. + created_by: + type: string + title: created_by + description: The ID of the user that created the return. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The date the return was deleted. + requested_at: + type: string + title: requested_at + description: The date the return was requested. + format: date-time + received_at: + type: string + title: received_at + description: The date the return was received. + format: date-time StoreAddCartLineItem: type: object description: The details of the line item to add. @@ -24287,11 +23278,11 @@ components: x-schemaName: StoreCollection required: - title - - metadata - id - - handle + - metadata - created_at - updated_at + - handle - deleted_at properties: id: @@ -24795,19 +23786,17 @@ components: description: The order's details. x-schemaName: StoreOrder required: + - items + - shipping_methods + - currency_code - 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 @@ -24837,10 +23826,6 @@ components: 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 @@ -24868,24 +23853,24 @@ components: title: display_id description: The order's display ID. shipping_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/StoreOrderAddress' billing_address: - $ref: '#/components/schemas/BaseOrderAddress' + $ref: '#/components/schemas/StoreOrderAddress' items: type: array description: The order's items. items: - $ref: '#/components/schemas/BaseOrderLineItem' + $ref: '#/components/schemas/StoreOrderLineItem' shipping_methods: type: array description: The order's shipping methods. items: - $ref: '#/components/schemas/BaseOrderShippingMethod' + $ref: '#/components/schemas/StoreOrderShippingMethod' payment_collections: type: array description: The order's payment collections. items: - $ref: '#/components/schemas/BasePaymentCollection' + $ref: '#/components/schemas/StorePaymentCollection' payment_status: type: string description: The order's payment status. @@ -24904,7 +23889,7 @@ components: type: array description: The order's fulfillments. items: - $ref: '#/components/schemas/BaseOrderFulfillment' + $ref: '#/components/schemas/StoreOrderFulfillment' fulfillment_status: type: string description: The order's fulfillment status. @@ -25020,6 +24005,4176 @@ components: type: number title: original_shipping_tax_total description: The total taxes of the order's shipping excluding promotions. + customer: + $ref: '#/components/schemas/StoreCustomer' + transactions: + type: array + description: The order's transactions. + items: + $ref: '#/components/schemas/BaseOrderTransaction' + StoreOrderAddress: + type: object + description: An order address + x-schemaName: StoreOrderAddress + required: + - id + - metadata + - created_at + - updated_at + properties: + 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 + country: + $ref: '#/components/schemas/StoreRegionCountry' + 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. + 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 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: The fulfillment's requires shipping. + StoreOrderLineItem: + type: object + description: The item's details. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - 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/StoreProductVariant' + variant_id: + type: string + title: variant_id + description: The ID of the associated variant. + product: + $ref: '#/components/schemas/StoreProduct' + 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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The tax line's tax lines. + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + required: + - id + - title + - subtitle + - thumbnail + - variant_id + - product_id + - product_title + - product_description + - product_subtitle + - product_type + - product_collection + - product_handle + - variant_sku + - variant_barcode + - variant_title + - variant_option_values + - requires_shipping + - is_discountable + - is_tax_inclusive + - unit_price + - quantity + - detail + - created_at + - updated_at + - metadata + - original_total + - original_subtotal + - original_tax_total + - item_total + - item_subtotal + - item_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - refundable_total + - refundable_total_per_unit + properties: + id: + type: string + title: id + description: The item's ID. + title: + type: string + title: title + description: The item's title. + subtitle: + type: string + title: subtitle + description: The item's subtitle. + thumbnail: + type: string + title: thumbnail + description: The item's thumbnail. + variant: + type: object + description: The item's variant. + 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. + upc: + type: string + title: upc + description: The variant's upc. + 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. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + 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 variant rank. + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: BaseProduct + product_id: + type: string + title: product_id + description: The variant's product id. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + metadata: + type: object + description: The variant's metadata. + variant_id: + type: string + title: variant_id + description: The item's variant id. + product: + type: object + description: The item's product. + x-schemaName: BaseProduct + required: + - id + - title + - handle + - subtitle + - description + - is_giftcard + - status + - thumbnail + - width + - weight + - length + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - variants + - options + - images + - discountable + - external_id + - created_at + - updated_at + - deleted_at + properties: + id: + type: string + title: id + description: The product's ID. + title: + type: string + title: title + description: The product's title. + handle: + type: string + title: handle + description: The product's handle. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + description: + type: string + title: description + description: The product's description. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + length: + type: number + title: length + description: The product's length. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection: + type: object + description: The product's collection. + x-schemaName: BaseCollection + collection_id: + type: string + title: collection_id + description: The product's collection id. + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: BaseProductCategory + type: + type: object + description: The product's type. + x-schemaName: BaseProduct + type_id: + type: string + title: type_id + description: The product's type id. + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: BaseProductTag + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: BaseProductVariant + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: BaseProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: BaseProductImage + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + metadata: + type: object + description: The product's metadata. + product_id: + type: string + title: product_id + description: The item's product id. + product_title: + type: string + title: product_title + description: The item's product title. + product_description: + type: string + title: product_description + description: The item's product description. + product_subtitle: + type: string + title: product_subtitle + description: The item's product subtitle. + product_type: + type: string + title: product_type + description: The item's product type. + product_collection: + type: string + title: product_collection + description: The item's product collection. + product_handle: + type: string + title: product_handle + description: The item's product handle. + variant_sku: + type: string + title: variant_sku + description: The item's variant sku. + variant_barcode: + type: string + title: variant_barcode + description: The item's variant barcode. + variant_title: + type: string + title: variant_title + description: The item's variant title. + variant_option_values: + type: object + description: The item's variant option values. + requires_shipping: + type: boolean + title: requires_shipping + description: The item's requires shipping. + is_discountable: + type: boolean + title: is_discountable + description: The item's is discountable. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The item's is tax inclusive. + compare_at_unit_price: + type: number + title: compare_at_unit_price + description: The item's compare at unit price. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + tax_lines: + type: array + description: The item's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The item's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + detail: + 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The adjustment's details. + detail: + allOf: + - $ref: '#/components/schemas/BaseOrderItemDetail' + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + required: + - detail + - 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 + - refundable_total + - refundable_total_per_unit + properties: + variant: + type: object + description: The item's variant. + x-schemaName: StoreProductVariant + required: + - options + - length + - title + - id + - created_at + - updated_at + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - deleted_at + - sku + - barcode + - ean + - upc + - allow_backorder + - manage_inventory + properties: + options: + type: array + description: The variant's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOptionValue + product: + type: object + description: The variant's product. + x-schemaName: StoreProduct + length: + type: number + title: length + description: The variant's length. + title: + type: string + title: title + description: The variant's title. + id: + type: string + title: id + description: The variant's ID. + metadata: + type: object + description: The variant's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The variant's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The variant's updated at. + product_id: + type: string + title: product_id + description: The variant's product 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. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The variant's deleted at. + 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: The variant's allow backorder. + manage_inventory: + type: boolean + title: manage_inventory + description: The variant's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The variant's inventory quantity. + variant_rank: + type: number + title: variant_rank + description: The variant's variant rank. + calculated_price: + type: object + description: The variant's calculated price. + x-schemaName: BaseCalculatedPriceSet + product: + type: object + description: The item's product. + x-schemaName: StoreProduct + required: + - variants + - options + - images + - length + - title + - status + - description + - id + - created_at + - updated_at + - subtitle + - thumbnail + - handle + - is_giftcard + - width + - weight + - height + - origin_country + - hs_code + - mid_code + - material + - collection_id + - type_id + - discountable + - external_id + - deleted_at + properties: + collection: + type: object + description: The product's collection. + x-schemaName: StoreCollection + categories: + type: array + description: The product's categories. + items: + type: object + description: The category's categories. + x-schemaName: StoreProductCategory + variants: + type: array + description: The product's variants. + items: + type: object + description: The variant's variants. + x-schemaName: StoreProductVariant + type: + type: object + description: The product's type. + x-schemaName: StoreProduct + tags: + type: array + description: The product's tags. + items: + type: object + description: The tag's tags. + x-schemaName: StoreProductTag + options: + type: array + description: The product's options. + items: + type: object + description: The option's options. + x-schemaName: StoreProductOption + images: + type: array + description: The product's images. + items: + type: object + description: The image's images. + x-schemaName: StoreProductImage + length: + type: number + title: length + description: The product's length. + title: + type: string + title: title + description: The product's title. + status: + type: string + description: The product's status. + enum: + - draft + - proposed + - published + - rejected + description: + type: string + title: description + description: The product's description. + id: + type: string + title: id + description: The product's ID. + metadata: + type: object + description: The product's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The product's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The product's updated at. + subtitle: + type: string + title: subtitle + description: The product's subtitle. + thumbnail: + type: string + title: thumbnail + description: The product's thumbnail. + handle: + type: string + title: handle + description: The product's handle. + is_giftcard: + type: boolean + title: is_giftcard + description: The product's is giftcard. + width: + type: number + title: width + description: The product's width. + weight: + type: number + title: weight + description: The product's weight. + height: + type: number + title: height + description: The product's height. + origin_country: + type: string + title: origin_country + description: The product's origin country. + hs_code: + type: string + title: hs_code + description: The product's hs code. + mid_code: + type: string + title: mid_code + description: The product's mid code. + material: + type: string + title: material + description: The product's material. + collection_id: + type: string + title: collection_id + description: The product's collection id. + type_id: + type: string + title: type_id + description: The product's type id. + discountable: + type: boolean + title: discountable + description: The product's discountable. + external_id: + type: string + title: external_id + description: The product's external id. + deleted_at: + type: string + format: date-time + title: deleted_at + description: The product's deleted at. + tax_lines: + type: array + description: The item's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderLineItemTaxLine + required: + - item + - item_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + item: + type: object + description: The tax line's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The tax line's item id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - item + properties: + item: + type: object + description: The tax line's item. + x-schemaName: StoreOrderLineItem + adjustments: + type: array + description: The item's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderLineItemAdjustment + required: + - item + - item_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: BaseOrderLineItem + item_id: + type: string + title: item_id + description: The adjustment's item id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - item + properties: + item: + type: object + description: The adjustment's item. + x-schemaName: StoreOrderLineItem + detail: + allOf: + - 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: item_id + description: The detail's item id. + item: + type: object + description: The detail's item. + x-schemaName: BaseOrderLineItem + quantity: + type: number + title: quantity + description: The detail's quantity. + fulfilled_quantity: + type: number + title: fulfilled_quantity + description: The detail's fulfilled quantity. + delivered_quantity: + type: number + title: delivered_quantity + description: The detail's delivered quantity. + shipped_quantity: + type: number + title: shipped_quantity + description: The detail's shipped quantity. + return_requested_quantity: + type: number + title: return_requested_quantity + description: The detail's return requested quantity. + return_received_quantity: + type: number + title: return_received_quantity + description: The detail's return received quantity. + return_dismissed_quantity: + type: number + title: return_dismissed_quantity + description: The detail's return dismissed quantity. + written_off_quantity: + type: number + title: written_off_quantity + description: The detail's written off quantity. + metadata: + type: object + description: The detail's metadata. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The item's detail. + required: + - item + properties: + item: + type: object + description: The detail's item. + x-schemaName: StoreOrderLineItem + 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. + 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. + item_total: + type: number + title: item_total + description: The item's item total. + item_subtotal: + type: number + title: item_subtotal + description: The item's item subtotal. + item_tax_total: + type: number + title: item_tax_total + description: The item's item tax total. + original_total: + type: number + title: original_total + description: The item's original total. + original_subtotal: + type: number + title: original_subtotal + description: The item's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The item's original tax total. + total: + type: number + title: total + description: The item's total. + subtotal: + type: number + title: subtotal + description: The item's subtotal. + tax_total: + type: number + title: tax_total + description: The item's tax total. + discount_total: + type: number + title: discount_total + description: The item's discount total. + discount_tax_total: + type: number + title: discount_tax_total + description: The item's discount tax total. + 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. + unit_price: + type: number + title: unit_price + description: The item's unit price. + quantity: + type: number + title: quantity + description: The item's quantity. + refundable_total: + type: number + title: refundable_total + description: The item's refundable total. + refundable_total_per_unit: + type: number + title: refundable_total_per_unit + description: The item's refundable total per unit. + description: The item's detail. + 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. StoreOrderResponse: type: object description: The order's details. @@ -25029,6 +28184,1718 @@ components: properties: order: $ref: '#/components/schemas/StoreOrder' + 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 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: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The tax line's details. + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + required: + - id + - order_id + - name + - amount + - is_tax_inclusive + - shipping_option_id + - data + - metadata + - original_total + - original_subtotal + - original_tax_total + - total + - subtotal + - tax_total + - discount_total + - discount_tax_total + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + tax_lines: + type: array + description: The shipping method's tax lines. + items: + type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + adjustments: + type: array + description: The shipping method's adjustments. + items: + type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + detail: + type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: The adjustment's adjustments. + 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: + allOf: + - $ref: '#/components/schemas/BaseOrderShippingDetail' + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + 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: + tax_lines: + type: array + description: The shipping method's tax lines. + items: + allOf: + - type: object + description: The tax line's tax lines. + x-schemaName: BaseOrderShippingMethodTaxLine + required: + - shipping_method + - shipping_method_id + - total + - subtotal + - id + - code + - rate + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The tax line's shipping method id. + total: + type: number + title: total + description: The tax line's total. + subtotal: + type: number + title: subtotal + description: The tax line's 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 tax line's tax rate id. + code: + type: string + title: code + description: The tax line's code. + rate: + type: number + title: rate + description: The tax line's rate. + provider_id: + type: string + title: provider_id + description: The tax line's provider id. + created_at: + type: string + format: date-time + title: created_at + description: The tax line's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The tax line's updated at. + - type: object + description: The tax line's tax lines. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The tax line's shipping method. + x-schemaName: StoreOrderShippingMethod + adjustments: + type: array + description: The shipping method's adjustments. + items: + allOf: + - type: object + description: The adjustment's adjustments. + x-schemaName: BaseOrderShippingMethodAdjustment + required: + - shipping_method + - shipping_method_id + - id + - amount + - order_id + - created_at + - updated_at + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: BaseOrderShippingMethod + shipping_method_id: + type: string + title: shipping_method_id + description: The adjustment's shipping method id. + 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 adjustment's order id. + description: + type: string + title: description + description: The adjustment's description. + promotion_id: + type: string + title: promotion_id + description: The adjustment's promotion id. + 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 adjustment's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The adjustment's updated at. + - type: object + description: The adjustment's adjustments. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The adjustment's shipping method. + x-schemaName: StoreOrderShippingMethod + detail: + allOf: + - type: object + description: The shipping method's detail. + x-schemaName: BaseOrderShippingDetail + required: + - id + - shipping_method_id + - shipping_method + - created_at + - updated_at + properties: + id: + type: string + title: id + description: The detail's ID. + shipping_method_id: + type: string + title: shipping_method_id + description: The detail's shipping method id. + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: BaseOrderShippingMethod + claim_id: + type: string + title: claim_id + description: The detail's claim id. + exchange_id: + type: string + title: exchange_id + description: The detail's exchange id. + return_id: + type: string + title: return_id + description: The detail's return id. + created_at: + type: string + format: date-time + title: created_at + description: The detail's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The detail's updated at. + - type: object + description: The shipping method's detail. + required: + - shipping_method + properties: + shipping_method: + type: object + description: The detail's shipping method. + x-schemaName: StoreOrderShippingMethod + id: + type: string + title: id + description: The shipping method's ID. + order_id: + type: string + title: order_id + description: The shipping method's order id. + name: + type: string + title: name + description: The shipping method's name. + description: + type: string + title: description + description: The shipping method's description. + amount: + type: number + title: amount + description: The shipping method's amount. + is_tax_inclusive: + type: boolean + title: is_tax_inclusive + description: The shipping method's is tax inclusive. + shipping_option_id: + type: string + title: shipping_option_id + description: The shipping method's shipping option id. + data: + type: object + description: The shipping method's data. + metadata: + type: object + description: The shipping method's metadata. + original_total: + type: number + title: original_total + description: The shipping method's original total. + original_subtotal: + type: number + title: original_subtotal + description: The shipping method's original subtotal. + original_tax_total: + type: number + title: original_tax_total + description: The shipping method's original tax total. + total: + type: number + title: total + description: The shipping method's total. + 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 shipping method's created at. + updated_at: + type: string + format: date-time + title: updated_at + description: The shipping method's updated at. + description: Details of changes to a shipping method. StorePaymentCollection: type: object description: The payment collection's details. @@ -25203,10 +30070,12 @@ components: - status - description - id - - handle + - created_at + - updated_at - subtitle - - is_giftcard - thumbnail + - handle + - is_giftcard - width - weight - height @@ -25218,8 +30087,6 @@ components: - type_id - discountable - external_id - - created_at - - updated_at - deleted_at properties: categories: @@ -25743,6 +30610,8 @@ components: - length - title - id + - created_at + - updated_at - width - weight - height @@ -25750,8 +30619,6 @@ components: - hs_code - mid_code - material - - created_at - - updated_at - deleted_at - sku - barcode @@ -25808,16 +30675,50 @@ components: format: date-time title: 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. + 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. StoreReturn: type: object description: The return's details. x-schemaName: StoreReturn required: - items - - order_id - id - - created_at - display_id + - created_at + - order_id - canceled_at - received_at 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 b3acb44b1e..abe31e16de 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -4,16 +4,6 @@ post: description: Create a cart. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 9c5bc4811b..b84ab4e7c8 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 @@ -12,16 +12,6 @@ get: 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: >- @@ -80,16 +70,6 @@ post: 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: >- 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 2753f1a285..c10b9db5d8 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 @@ -14,16 +14,6 @@ post: 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: >- 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 6d47ad4d1a..0e15e4f2ae 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 @@ -15,16 +15,6 @@ post: 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: >- 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 624db1819c..e59e05a17b 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 @@ -21,16 +21,6 @@ post: 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: >- @@ -104,16 +94,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: >- 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 4da5438a5b..c8d7a97049 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 @@ -11,16 +11,6 @@ post: 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: >- @@ -94,16 +84,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: >- 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 268a1feccd..9e15c18dd9 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 @@ -17,16 +17,6 @@ post: 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: >- @@ -93,4 +83,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - x-workflow: addShippingMethodToWorkflow + x-workflow: addShippingMethodToCartWorkflow 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 53083c97a2..6384c4d49b 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 @@ -11,16 +11,6 @@ post: 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: >- 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 6e1d04c206..ee8d050e9a 100644 --- a/www/apps/api-reference/specs/store/paths/store_collections.yaml +++ b/www/apps/api-reference/specs/store/paths/store_collections.yaml @@ -10,16 +10,6 @@ get: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list description: 'Storefront guide: How to retrieve a list of collections.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 b0372f85a0..e071f754f3 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 @@ -16,16 +16,6 @@ get: 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: >- 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 311bd31b20..5ccfc03d10 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies.yaml @@ -6,16 +6,6 @@ get: as `code`. The currencies can also be sorted or paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 8923514148..02cffa86e9 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 @@ -12,16 +12,6 @@ get: 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: >- 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 e7559cb943..ac96f39ce0 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -11,16 +11,6 @@ post: description: 'Storefront guide: How to register a customer.' x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 15fb5f297b..50fd19afab 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 @@ -11,16 +11,6 @@ get: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve description: 'Storefront guide: How to retrieve the logged-in customer.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -78,16 +68,6 @@ post: description: 'Storefront guide: How to edit a customer''s profile.' x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 d6e5ff8cd4..0ce04420fa 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 @@ -12,16 +12,6 @@ get: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses description: 'Storefront guide: How to retrieve the logged-in customer''s addresses.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- @@ -166,16 +156,6 @@ post: description: 'Storefront guide: How to create an address for the logged-in customer.' x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 57d7a06e97..416754e314 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 @@ -13,16 +13,6 @@ get: 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: >- @@ -87,16 +77,6 @@ post: 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: >- @@ -229,16 +209,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: >- 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 ce0f9d7c2d..c6ce7ddb95 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -7,16 +7,6 @@ get: fields such as `id`. The orders can also be sorted or paginated. x-authenticated: true parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 0007d5124e..9cc9e0baca 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 @@ -12,16 +12,6 @@ get: 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: >- 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 b1ba01acf5..4e0b7594ef 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 @@ -10,16 +10,6 @@ post: description: 'Storefront guide: How to implement payment during checkout.' x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 c928693c72..cff382905d 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 @@ -19,16 +19,6 @@ post: 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: >- 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 ff2cc3665a..7a2420d6f5 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 @@ -10,16 +10,6 @@ get: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment description: 'Storefront guide: How to implement payment during checkout.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 5f57286785..7c95a58681 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 @@ -11,16 +11,6 @@ get: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list description: 'Storefront guide: How to retrieve a list of product categories.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 543b1b7b9e..bb7cf01187 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 @@ -16,16 +16,6 @@ get: 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: >- 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 87c50646a5..3e1faa8197 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -10,16 +10,6 @@ get: https://docs.medusajs.com/v2/resources/storefront-development/products/price description: 'Storefront guide: How to retrieve a product variants'' prices.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 433f898614..ab09b59ce3 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 @@ -16,16 +16,6 @@ get: 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: >- 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 d29f094f66..7c6204dc43 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -9,16 +9,6 @@ get: url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list description: 'Storefront guide: How to retrieve a list of regions.' parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 d363123774..27546147ee 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 @@ -12,16 +12,6 @@ get: 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: >- 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 22f55f9017..c5f4062f5b 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 @@ -6,16 +6,6 @@ get: paginated. x-authenticated: false parameters: - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - name: fields in: query description: >- 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 b829e8aac6..e212f0db83 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 @@ -12,16 +12,6 @@ get: 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: >- diff --git a/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx b/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx index 52d5cfabd1..9e5b084e66 100644 --- a/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx +++ b/www/apps/resources/references/auth_provider/classes/auth_provider.AbstractAuthModuleProvider/page.mdx @@ -37,13 +37,6 @@ and the module's options using the second parameter. If you're creating a client or establishing a connection with a third-party service, do it in the constructor. -In the constructor, you must pass to the parent constructor two parameters: - -1. The first one is an empty object. -2. The second is an object having two properties: - - `provider`: The ID of the provider. For example, `emailpass`. - - `displayName`: The label or displayable name of the provider. For example, `Email and Password Authentication`. - #### Example ```ts @@ -59,6 +52,7 @@ type Options = { } class MyAuthProviderService extends AbstractAuthModuleProvider { + static identifier = "my-auth" protected logger_: Logger protected options_: Options // assuming you're initializing a client @@ -68,13 +62,7 @@ class MyAuthProviderService extends AbstractAuthModuleProvider { { logger }: InjectedDependencies, options: Options ) { - super( - {}, - { - provider: "my-auth", - displayName: "My Custom Authentication" - } - ) + super(...arguments) this.logger_ = logger this.options_ = options @@ -89,17 +77,38 @@ class MyAuthProviderService extends AbstractAuthModuleProvider { export default MyAuthProviderService ``` +### constructor + ### validateOptions -Override this static method in order for the loader to validate the options provided to the module provider. +This method validates the options of the provider set in `medusa-config.ts`. +Implementing this method is optional. It's useful if your provider requires custom validation. + +If the options aren't valid, throw an error. + +#### Example + +```ts +class MyAuthProviderService extends AbstractAuthModuleProvider { + static validateOptions(options: Record) { + if (!options.apiKey) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "API key is required in the provider's options." + ) + } + } + // ... +} +``` #### Parameters -`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> +`","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> #### Returns - + ### authenticate @@ -413,10 +422,14 @@ Create the file `src/modules/my-auth/index.ts` with the following content: ```ts title="src/modules/my-auth/index.ts" import MyAuthProviderService from "./service" +import { + ModuleProvider, + Modules +} from "@medusajs/framework/utils" -export default { +export default ModuleProvider(Modules.AUTH, { services: [MyAuthProviderService], -} +}) ``` This exports the module's definition, indicating that the `MyAuthProviderService` is the module's service. @@ -440,7 +453,7 @@ module.exports = defineConfig({ options: { providers: [ { - resolve: "./modules/my-auth", + resolve: "./src/modules/my-auth", id: "my-auth", options: { // provider options... diff --git a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx index bfa9ecd1f6..967e32c816 100644 --- a/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx +++ b/www/apps/resources/references/file/classes/file.AbstractFileProviderService/page.mdx @@ -54,6 +54,7 @@ type Options = { class MyFileProviderService extends AbstractFileProviderService { protected logger_: Logger protected options_: Options + static identifier = "my-file" // assuming you're initializing a client protected client @@ -78,15 +79,33 @@ export default MyFileProviderService ### validateOptions -Override this static method in order for the loader to validate the options provided to the module provider. +This method validates the options of the provider set in `medusa-config.ts`. +Implementing this method is optional. It's useful if your provider requires custom validation. + +If the options aren't valid, throw an error. + +#### Example + +```ts +class MyFileProviderService extends AbstractFileProviderService { + static validateOptions(options: Record) { + if (!options.apiKey) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "API key is required in the provider's options." + ) + } + } +} +``` #### Parameters -`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> +`","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> #### Returns - + ### upload @@ -185,10 +204,14 @@ Create the file `src/modules/my-file/index.ts` with the following content: ```ts title="src/modules/my-file/index.ts" import MyFileProviderService from "./service" +import { + ModuleProvider, + Modules +} from "@medusajs/framework/utils" -export default { +export default ModuleProvider(Modules.FILE, { services: [MyFileProviderService], -} +}) ``` This exports the module's definition, indicating that the `MyFileProviderService` is the module's service. @@ -214,11 +237,11 @@ module.exports = defineConfig({ // ... modules: [ { - resolve: "@medusajs/medusa/file", + resolve: "@medusajs/framework/file", options: { providers: [ { - resolve: "./modules/my-file", + resolve: "./src/modules/my-file", id: "my-file", options: { // provider options... diff --git a/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx b/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx index 3030c38ba2..e761584aad 100644 --- a/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx +++ b/www/apps/resources/references/fulfillment_provider/classes/fulfillment_provider.AbstractFulfillmentProviderService/page.mdx @@ -454,10 +454,14 @@ Create the file `src/modules/my-fulfillment/index.ts` with the following content ```ts title="src/modules/my-fulfillment/index.ts" import MyFulfillmentProviderService from "./service" +import { + ModuleProvider, + Modules +} from "@medusajs/framework/utils" -export default { +export default ModuleProvider(Modules.FULFILLMENT, { services: [MyFulfillmentProviderService], -} +}) ``` This exports the module's definition, indicating that the `MyFulfillmentProviderService` is the module's service. @@ -481,7 +485,7 @@ module.exports = defineConfig({ options: { providers: [ { - resolve: "./modules/my-fulfillment", + resolve: "./src/modules/my-fulfillment", id: "my-fulfillment", options: { // provider options... diff --git a/www/apps/resources/references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx b/www/apps/resources/references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx index bdebb76876..759f160167 100644 --- a/www/apps/resources/references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx +++ b/www/apps/resources/references/medusa_config/interfaces/medusa_config.ConfigModule/page.mdx @@ -8,9 +8,9 @@ import { TypeList } from "docs-ui" In this document, you’ll learn how to create a file service in the Medusa application and the methods you must implement in it. -The configurations for your Medusa application are in `medusa-config.js` located in the root of your Medusa project. The configurations include configurations for database, modules, and more. +The configurations for your Medusa application are in `medusa-config.ts` located in the root of your Medusa project. The configurations include configurations for database, modules, and more. -`medusa-config.js` exports the value returned by the `defineConfig` utility function imported from `@medusajs/utils`. +`medusa-config.ts` exports the value returned by the `defineConfig` utility function imported from `@medusajs/framework/utils`. `defineConfig` accepts as a parameter an object with the following properties: @@ -21,7 +21,7 @@ The configurations for your Medusa application are in `medusa-config.js` located For example: -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { // ... @@ -42,7 +42,7 @@ module.exports = defineConfig({ ## Environment Variables -It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.js`. +It's highly recommended to store the values of configurations in environment variables, then reference them within `medusa-config.ts`. During development, you can set your environment variables in the `.env` file at the root of your Medusa application project. In production, setting the environment variables depends on the hosting provider. @@ -62,7 +62,7 @@ Make sure to create the PostgreSQL database before using it. You can check how t #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { databaseName: process.env.DATABASE_NAME || @@ -99,9 +99,9 @@ For example, set the following database URL in your environment variables: DATABASE_URL=postgres://postgres@localhost/medusa-store ``` -Then, use the value in `medusa-config.js`: +Then, use the value in `medusa-config.ts`: -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { databaseUrl: process.env.DATABASE_URL, @@ -115,7 +115,7 @@ module.exports = defineConfig({ The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`. -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { databaseSchema: process.env.DATABASE_SCHEMA || @@ -132,7 +132,7 @@ This configuration specifies whether database messages should be logged. #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { databaseLogging: false @@ -158,7 +158,7 @@ Make sure to add to the end of the database URL `?ssl_mode=disable` as well when #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { databaseDriverOptions: process.env.NODE_ENV !== "development" ? @@ -193,7 +193,7 @@ For a local Redis installation, the connection URL should be `redis://localhost: #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { redisUrl: process.env.REDIS_URL || @@ -212,7 +212,7 @@ If this configuration option is provided, it is prepended to `sess:`. #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { redisPrefix: process.env.REDIS_URL || "medusa:", @@ -229,7 +229,7 @@ for the list of available options. #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { redisOptions: { @@ -248,7 +248,7 @@ This configuration defines additional options to pass to [express-session](https #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { sessionOptions: { @@ -287,7 +287,7 @@ In production, it's recommended to deploy two instances: #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { workerMode: process.env.WORKER_MODE || "shared" @@ -303,7 +303,7 @@ This property configures the application's http-specific settings. #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ projectConfig: { http: { @@ -330,7 +330,7 @@ This property holds configurations for the Medusa Admin dashboard. ### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ admin: { backendUrl: process.env.MEDUSA_BACKEND_URL || @@ -347,11 +347,11 @@ in both development and production environments. The default value is `false`. #### Example -```js title="medusa-config.js" +```ts +title = "medusa-config.ts" module.exports = defineConfig({ admin: { - disable: process.env.ADMIN_DISABLED === "true" || - false + disable: process.env.ADMIN_DISABLED === "true" || false, }, // ... }) @@ -376,7 +376,7 @@ the value of the `path` configuration, as it's `/app` by default. #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ admin: { path: process.env.ADMIN_PATH || `/app`, @@ -392,7 +392,7 @@ The default value is `./build`. #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ admin: { outDir: process.env.ADMIN_BUILD_DIR || `./build`, @@ -407,7 +407,7 @@ The URL of your Medusa application. This is useful to set when you deploy the Me #### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ admin: { backendUrl: process.env.MEDUSA_BACKEND_URL || @@ -435,22 +435,20 @@ add them to this property if you're changing their configurations or adding prov ::: -The keys of the `modules` configuration object refer to the module's registration name. Its value can be one of the following: +`modules` is an array of objects, each holding a module's registration configurations. Each object has the following properties: -1. A boolean value indicating whether the module type is enabled. This is only supported for Medusa's commerce and architectural modules; -2. Or an object having the following properties: - 1. `resolve`: a string indicating the path to the module relative to `src`, or the module's NPM package name. For example, `./modules/my-module`. - 2. `options`: (optional) an object indicating the options to pass to the module. +1. `resolve`: a string indicating the path to the module relative to `src`, or the module's NPM package name. For example, `./modules/my-module`. +2. `options`: (optional) an object indicating the options to pass to the module. ### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ - modules: { - helloModuleService: { + modules: [ + { resolve: "./modules/hello" } - } + ] // ... }) ``` @@ -462,7 +460,7 @@ ___ Some features in the Medusa application are guarded by a feature flag. This ensures constant shipping of new features while maintaining the engine’s stability. You can enable a feature in your application by enabling its feature flag. Feature flags are enabled through either environment -variables or through this configuration property exported in `medusa-config.js`. +variables or through this configuration property exported in `medusa-config.ts`. The `featureFlags`'s value is an object. Its properties are the names of the feature flags, and their value is a boolean indicating whether the feature flag is enabled. @@ -470,7 +468,7 @@ You can find available feature flags and their key name [here](https://github.co ### Example -```js title="medusa-config.js" +```ts title="medusa-config.ts" module.exports = defineConfig({ featureFlags: { analytics: true, diff --git a/www/apps/resources/references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx b/www/apps/resources/references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx index de61c38caf..e74758574f 100644 --- a/www/apps/resources/references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx +++ b/www/apps/resources/references/medusa_config/interfaces/medusa_config.ProjectConfigOptions/page.mdx @@ -4,4 +4,4 @@ import { TypeList } from "docs-ui" Essential configurations related to the Medusa application, such as database and CORS configurations. -`","description":"This configuration specifies the supported authentication providers per actor type (such as `user`, `customer`, or any custom actors).\nFor example, you only want to allow SSO logins for `users`, while you want to allow email/password logins for `customers` to the storefront.\n\n`authMethodsPerActor` is a a map where the actor type (eg. 'user') is the key, and the value is an array of supported auth provider IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"databaseName","type":"`string`","description":"The name of the database to connect to. If the name is specified in `databaseUrl`, then you don't have to use this configuration.\n\nMake sure to create the PostgreSQL database before using it. You can check how to create a database in\n[PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseUrl","type":"`string`","description":"The PostgreSQL connection URL of the database, which is of the following format:\n\n```bash\npostgres://[user][:password]@[host][:port]/[dbname]\n```\n\nWhere:\n\n- `[user]`: (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the `postgres` superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html).\n- `[:password]`: an optional password for the user. When provided, make sure to put `:` before the password.\n- `[host]`: (required) your PostgreSQL host. When run locally, it should be `localhost`.\n- `[:port]`: an optional port that the PostgreSQL server is listening on. By default, it's `5432`. When provided, make sure to put `:` before the port.\n- `[dbname]`: (required) the name of the database.\n\nYou can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseSchema","type":"`string`","description":"The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`.\n\n```js title=\"medusa-config.js\"\nmodule.exports = defineConfig({\n projectConfig: {\n databaseSchema: process.env.DATABASE_SCHEMA ||\n \"custom\",\n // ...\n },\n // ...\n})\n```","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseLogging","type":"`boolean`","description":"This configuration specifies whether database messages should be logged.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseDriverOptions","type":"`Record` & `object`","description":"This configuration is used to pass additional options to the database connection. You can pass any configuration. For example, pass the\n`ssl` property that enables support for TLS/SSL connections.\n\nThis is useful for production databases, which can be supported by setting the `rejectUnauthorized` attribute of `ssl` object to `false`.\nDuring development, it’s recommended not to pass this option.\n\n:::note\n\nMake sure to add to the end of the database URL `?ssl_mode=disable` as well when disabling `rejectUnauthorized`.\n\n:::","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"connection","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ssl","type":"`object`","description":"Configure support for TLS/SSL connection","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"redisUrl","type":"`string`","description":"This configuration specifies the connection URL to Redis to store the Medusa server's session.\n\n:::note\n\nYou must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/).\n\n:::\n\nThe Redis connection URL has the following format:\n\n```bash\nredis[s]://[[username][:password]@][host][:port][/db-number]\n```\n\nFor a local Redis installation, the connection URL should be `redis://localhost:6379` unless you’ve made any changes to the Redis configuration during installation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"redisPrefix","type":"`string`","description":"This configuration defines a prefix on all keys stored in Redis for the Medusa server's session. The default value is `sess:`.\n\nIf this configuration option is provided, it is prepended to `sess:`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"redisOptions","type":"`RedisOptions`","description":"This configuration defines options to pass ioredis for the Redis connection used to store the Medusa server's session. Refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions)\nfor the list of available options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionOptions","type":"[SessionOptions](../../../types/interfaces/types.SessionOptions/page.mdx)","description":"This configuration defines additional options to pass to [express-session](https://www.npmjs.com/package/express-session), which is used to store the Medusa server's session.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resave","type":"`boolean`","description":"Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rolling","type":"`boolean`","description":"Whether the session identifier cookie should be force-set on every response. The default value is `false`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveUninitialized","type":"`boolean`","description":"Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"secret","type":"`string`","description":"The secret to sign the session ID cookie. By default, the value of `http.cookieSecret` is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"Used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, its value is `10 * 60 * 60 * 1000`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"Configure the application's worker mode.\n\nWorkers are processes running separately from the main application. They're useful for executing long-running or resource-heavy tasks in the background, such as importing products.\n\nWith a worker, these tasks are offloaded to a separate process. So, they won't affect the performance of the main application.\n\n![Diagram showcasing how the server and worker work together](https://res.cloudinary.com/dza7lstvk/image/upload/fl\\_lossy/f\\_auto/r\\_16/ar\\_16:9,c\\_pad/v1/Medusa%20Book/medusa-worker\\_klkbch.jpg?\\_a=BATFJtAA0)\n\nMedusa has three runtime modes:\n\n- Use `shared` to run the application in a single process.\n- Use `worker` to run the a worker process only.\n- Use `server` to run the application server only.\n\nIn production, it's recommended to deploy two instances:\n\n1. One having the `workerMode` configuration set to `server`.\n2. Another having the `workerMode` configuration set to `worker`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProjectConfigOptions"/> +`","description":"This configuration specifies the supported authentication providers per actor type (such as `user`, `customer`, or any custom actors).\nFor example, you only want to allow SSO logins for `users`, while you want to allow email/password logins for `customers` to the storefront.\n\n`authMethodsPerActor` is a a map where the actor type (eg. 'user') is the key, and the value is an array of supported auth provider IDs.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"databaseName","type":"`string`","description":"The name of the database to connect to. If the name is specified in `databaseUrl`, then you don't have to use this configuration.\n\nMake sure to create the PostgreSQL database before using it. You can check how to create a database in\n[PostgreSQL's documentation](https://www.postgresql.org/docs/current/sql-createdatabase.html).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseUrl","type":"`string`","description":"The PostgreSQL connection URL of the database, which is of the following format:\n\n```bash\npostgres://[user][:password]@[host][:port]/[dbname]\n```\n\nWhere:\n\n- `[user]`: (required) your PostgreSQL username. If not specified, the system's username is used by default. The database user that you use must have create privileges. If you're using the `postgres` superuser, then it should have these privileges by default. Otherwise, make sure to grant your user create privileges. You can learn how to do that in [PostgreSQL's documentation](https://www.postgresql.org/docs/current/ddl-priv.html).\n- `[:password]`: an optional password for the user. When provided, make sure to put `:` before the password.\n- `[host]`: (required) your PostgreSQL host. When run locally, it should be `localhost`.\n- `[:port]`: an optional port that the PostgreSQL server is listening on. By default, it's `5432`. When provided, make sure to put `:` before the port.\n- `[dbname]`: (required) the name of the database.\n\nYou can learn more about the connection URL format in [PostgreSQL’s documentation](https://www.postgresql.org/docs/current/libpq-connect.html).","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseSchema","type":"`string`","description":"The database schema to connect to. This is not required to provide if you’re using the default schema, which is `public`.\n\n```ts title=\"medusa-config.ts\"\nmodule.exports = defineConfig({\n projectConfig: {\n databaseSchema: process.env.DATABASE_SCHEMA ||\n \"custom\",\n // ...\n },\n // ...\n})\n```","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseLogging","type":"`boolean`","description":"This configuration specifies whether database messages should be logged.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"databaseDriverOptions","type":"`Record` & `object`","description":"This configuration is used to pass additional options to the database connection. You can pass any configuration. For example, pass the\n`ssl` property that enables support for TLS/SSL connections.\n\nThis is useful for production databases, which can be supported by setting the `rejectUnauthorized` attribute of `ssl` object to `false`.\nDuring development, it’s recommended not to pass this option.\n\n:::note\n\nMake sure to add to the end of the database URL `?ssl_mode=disable` as well when disabling `rejectUnauthorized`.\n\n:::","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"connection","type":"`object`","description":"","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"ssl","type":"`object`","description":"Configure support for TLS/SSL connection","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]},{"name":"redisUrl","type":"`string`","description":"This configuration specifies the connection URL to Redis to store the Medusa server's session.\n\n:::note\n\nYou must first have Redis installed. You can refer to [Redis's installation guide](https://redis.io/docs/getting-started/installation/).\n\n:::\n\nThe Redis connection URL has the following format:\n\n```bash\nredis[s]://[[username][:password]@][host][:port][/db-number]\n```\n\nFor a local Redis installation, the connection URL should be `redis://localhost:6379` unless you’ve made any changes to the Redis configuration during installation.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"redisPrefix","type":"`string`","description":"This configuration defines a prefix on all keys stored in Redis for the Medusa server's session. The default value is `sess:`.\n\nIf this configuration option is provided, it is prepended to `sess:`.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"redisOptions","type":"`RedisOptions`","description":"This configuration defines options to pass ioredis for the Redis connection used to store the Medusa server's session. Refer to [ioredis’s RedisOptions documentation](https://redis.github.io/ioredis/index.html#RedisOptions)\nfor the list of available options.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"sessionOptions","type":"[SessionOptions](../../../types/interfaces/types.SessionOptions/page.mdx)","description":"This configuration defines additional options to pass to [express-session](https://www.npmjs.com/package/express-session), which is used to store the Medusa server's session.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"name","type":"`string`","description":"The name of the session ID cookie to set in the response (and read from in the request). The default value is `connect.sid`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#name) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"resave","type":"`boolean`","description":"Whether the session should be saved back to the session store, even if the session was never modified during the request. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#resave) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"rolling","type":"`boolean`","description":"Whether the session identifier cookie should be force-set on every response. The default value is `false`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#rolling) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"saveUninitialized","type":"`boolean`","description":"Whether a session that is \"uninitialized\" is forced to be saved to the store. The default value is `true`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#saveUninitialized) for more details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"secret","type":"`string`","description":"The secret to sign the session ID cookie. By default, the value of `http.cookieSecret` is used.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#secret) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"ttl","type":"`number`","description":"Used when calculating the `Expires` `Set-Cookie` attribute of cookies. By default, its value is `10 * 60 * 60 * 1000`.\nRefer to [express-session’s documentation](https://www.npmjs.com/package/express-session#cookiemaxage) for details.","optional":true,"defaultValue":"","expandable":false,"children":[]}]},{"name":"workerMode","type":"`\"shared\"` \\| `\"worker\"` \\| `\"server\"`","description":"Configure the application's worker mode.\n\nWorkers are processes running separately from the main application. They're useful for executing long-running or resource-heavy tasks in the background, such as importing products.\n\nWith a worker, these tasks are offloaded to a separate process. So, they won't affect the performance of the main application.\n\n![Diagram showcasing how the server and worker work together](https://res.cloudinary.com/dza7lstvk/image/upload/fl\\_lossy/f\\_auto/r\\_16/ar\\_16:9,c\\_pad/v1/Medusa%20Book/medusa-worker\\_klkbch.jpg?\\_a=BATFJtAA0)\n\nMedusa has three runtime modes:\n\n- Use `shared` to run the application in a single process.\n- Use `worker` to run the a worker process only.\n- Use `server` to run the application server only.\n\nIn production, it's recommended to deploy two instances:\n\n1. One having the `workerMode` configuration set to `server`.\n2. Another having the `workerMode` configuration set to `worker`.","optional":true,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="ProjectConfigOptions"/> diff --git a/www/apps/resources/references/medusa_config/types/medusa_config.PluginDetails/page.mdx b/www/apps/resources/references/medusa_config/types/medusa_config.PluginDetails/page.mdx index a91ee837d9..ae634214d6 100644 --- a/www/apps/resources/references/medusa_config/types/medusa_config.PluginDetails/page.mdx +++ b/www/apps/resources/references/medusa_config/types/medusa_config.PluginDetails/page.mdx @@ -4,6 +4,4 @@ import { TypeList } from "docs-ui" **PluginDetails**: `Object` -## Properties - `","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"version","type":"`string`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="PluginDetails"/> diff --git a/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx b/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx index 152b2a4620..a1d69f3ef6 100644 --- a/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx +++ b/www/apps/resources/references/notification/classes/notification.AbstractNotificationProviderService/page.mdx @@ -82,15 +82,33 @@ export default MyNotificationProviderService ### validateOptions -Override this static method in order for the loader to validate the options provided to the module provider. +This method validates the options of the provider set in `medusa-config.ts`. +Implementing this method is optional. It's useful if your provider requires custom validation. + +If the options aren't valid, throw an error. + +#### Example + +```ts +class MyNotificationProviderService extends AbstractNotificationProviderService { + static validateOptions(options: Record) { + if (!options.apiKey) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "API key is required in the provider's options." + ) + } + } +} +``` #### Parameters -`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> +`","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> #### Returns - + ### send @@ -124,7 +142,7 @@ class MyNotificationProviderService extends AbstractNotificationProviderService #### Parameters -`","description":"The data that gets passed over to the provider for rendering the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="send"/> +`","description":"The data that gets passed over to the provider for rendering the notification.","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"content","type":"`null` \\| [NotificationContent](../../../types/NotificationTypes/interfaces/types.NotificationTypes.NotificationContent/page.mdx)","description":"The content that gets passed to the provider.","optional":true,"defaultValue":"","expandable":false,"children":[{"name":"subject","type":"`string`","description":"the subject of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"text","type":"`string`","description":"the text content of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]},{"name":"html","type":"`string`","description":"the html content of the notification","optional":true,"defaultValue":"","expandable":false,"children":[]}]}]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="send"/> #### Returns @@ -138,10 +156,14 @@ Create the file `src/modules/my-notification/index.ts` with the following conten ```ts title="src/modules/my-notification/index.ts" import MyNotificationProviderService from "./service" +import { + ModuleProvider, + Modules +} from "@medusajs/framework/utils" -export default { +export default ModuleProvider(Modules.NOTIFICATION, { services: [MyNotificationProviderService], -} +}) ``` This exports the module's definition, indicating that the `MyNotificationProviderService` is the module's service. @@ -171,7 +193,7 @@ module.exports = defineConfig({ options: { providers: [ { - resolve: "./modules/my-notification", + resolve: "./src/modules/my-notification", id: "my-notification", options: { channels: ["email"], diff --git a/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx b/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx index 039bedc430..df82c78a25 100644 --- a/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx +++ b/www/apps/resources/references/payment_provider/classes/payment_provider.AbstractPaymentProvider/page.mdx @@ -68,6 +68,7 @@ type Options = { class MyPaymentProviderService extends AbstractPaymentProvider< Options > { + static identifier = "my-payment" protected logger_: Logger protected options_: Options // Assuming you're using a client to integrate @@ -96,19 +97,37 @@ export default MyPaymentProviderService #### Parameters -`(`name`: `string`, `registration`: T) => [MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]},{"name":"createScope","type":"() => [MedusaContainer](../../../medusa/types/medusa.MedusaContainer-1/page.mdx)","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]},{"name":"config","type":"TConfig","description":"The options passed to the payment module provider.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="new AbstractPaymentProvider"/> + ### validateOptions -Override this static method in order for the loader to validate the options provided to the module provider. +This method validates the options of the provider set in `medusa-config.ts`. +Implementing this method is optional. It's useful if your provider requires custom validation. + +If the options aren't valid, throw an error. + +#### Example + +```ts +class MyPaymentProviderService extends AbstractPaymentProvider { + static validateOptions(options: Record) { + if (!options.apiKey) { + throw new MedusaError( + MedusaError.Types.INVALID_DATA, + "API key is required in the provider's options." + ) + } + } +} +``` #### Parameters -`","description":"","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> +`","description":"The provider's options.","optional":false,"defaultValue":"","expandable":false,"children":[]}]} expandUrl="https://docs.medusajs.com/v2/advanced-development/data-models/manage-relationships#retrieve-records-of-relation" sectionTitle="validateOptions"/> #### Returns - + ### capturePayment @@ -681,10 +700,14 @@ Create the file `src/modules/my-payment/index.ts` with the following content: ```ts title="src/modules/my-payment/index.ts" import MyPaymentProviderService from "./service" +import { + ModuleProvider, + Modules +} from "@medusajs/framework/utils" -export default { +export default ModuleProvider(Modules.PAYMENT, { services: [MyPaymentProviderService], -} +}) ``` This exports the module's definition, indicating that the `MyPaymentProviderService` is the module's service. @@ -708,7 +731,7 @@ module.exports = defineConfig({ options: { providers: [ { - resolve: "./modules/my-payment", + resolve: "./src/modules/my-payment", id: "my-payment", options: { // provider options... diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts index d71a9784d0..7de754283c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_claim-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts index bf1f8340ce..90115d50cc 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 57fe61c397..d44c436079 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts index 9e91907b9d..e1865fc484 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_customers_[id]_addresses_[address_id].ts @@ -17,14 +17,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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts index 0f1f42da44..779c591f67 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index 6597c2ae3b..66efefcbef 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts index 03d53b02cd..86c3553c1b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts index 87b367420b..117cf31c3d 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_options_[option_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts index c1b229596d..7ca1cb0425 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index 64c28f3502..80a9b725ea 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -24,14 +24,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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts index e7899d613e..294d5d238c 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_dismiss-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts index a24a47ab44..986b528d0a 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_receive-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts index 3cf3048e84..b27f93b7ab 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_request-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts index 9c6d833693..8115af5cb7 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_returns_[id]_shipping-method_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts index 5ed6c323d1..3099453cfb 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_tax-rates_[id]_rules_[rule_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts index ab80ec241b..58641d6708 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of API keys. The API keys can be filtered by fields such as `id`. The API keys can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * 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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts index f3311745e4..ab78189bb3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_api-keys_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts index cbbe70fa10..1a3d0f1157 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of campaigns. The campaigns can be filtered by fields such as `id`. The campaigns can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts index 31288eecc4..abd65a04d1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_campaigns_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts index ef04b4caa5..92323a5851 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of claims. The claims can be filtered by fields such as `id`. The claims can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts index a6a189adde..72d3c1fd29 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_claims_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts index a846db31dc..b76f4b5acd 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of collections. The collections can be filtered by fields such as `id`. The collections can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts index 0f9bb18f66..ceade34f44 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_collections_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts index 068a91add1..c75ead460f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of currencies. The currencies can be filtered by fields such as `id`. The currencies can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts index 3c62ebd8b9..ab7b898d95 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_currencies_[code].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts index e32f59d2a3..6da6416f81 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of customer groups. The customer groups can be filtered by fields such as `id`. The customer groups can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts index 535af8c94a..29414ee676 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customer-groups_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts index dcaf31ab79..20d9adc48f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of customers. The customers can be filtered by fields such as `id`. The customers can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts index 4213a3454a..dfd494229d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts index 40ef0dc8e9..fecc914fc1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts index c8d60e0ac5..be0ca6068b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_customers_[id]_addresses_[address_id].ts @@ -17,14 +17,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts index bb3e220dc3..2b7bb7fb53 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_draft-orders.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of draft orders. The draft orders can be filtered by fields such as `id`. The draft orders can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts index a35a2fea61..d308206bc0 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of exchanges. The exchanges can be filtered by fields such as `id`. The exchanges can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts index 3265bc1d51..9ae952f47a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_exchanges_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts index ae0623b589..c50eae4ef5 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-providers.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as `id`. The fulfillment providers can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index 237bad6df1..04e0fbaba1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts index 050afcf674..08e8dc8e81 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of inventory items. The inventory items can be filtered by fields such as `id`. The inventory items can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts index 95d3b1339a..b41b6a8573 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts index 8b4f0531a1..3f1b899ef4 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_inventory-items_[id]_location-levels.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts index 23221153ba..293b272ded 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of invites. The invites can be filtered by fields such as `id`. The invites can also be sorted or paginated. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts index be76836f95..d5368c38c9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_invites_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts index 6ad9255893..39a2f993ce 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of notifications. The notifications can be filtered by fields such as `id`. The notifications can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts index c01981a56b..ef29e7302f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_notifications_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts index 0d75b47878..2b908e741b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of orders. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts index c6f3c31ce4..a896c8d963 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id].ts @@ -11,14 +11,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 @@ -31,6 +23,54 @@ * fields. without prefix it will replace the entire default fields. * externalDocs: * url: "#select-fields-and-relations" + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The order's ID. + * - type: array + * description: The order's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: The order's status. + * - type: array + * description: The order's status. + * items: + * type: string + * title: status + * description: The status's details. + * - name: version + * in: query + * description: The order's version. + * required: false + * schema: + * type: number + * title: version + * description: The order's version. + * - name: created_at + * in: query + * required: false + * schema: {} + * - name: updated_at + * in: query + * required: false + * schema: {} + * - name: deleted_at + * in: query + * required: false + * schema: {} * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts index 636ef8a851..13b079c699 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_changes.ts @@ -15,14 +15,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: |- diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts new file mode 100644 index 0000000000..5fd6670c17 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/get_admin_orders_[id]_line-items.ts @@ -0,0 +1,156 @@ +/** + * @oas [get] /admin/orders/{id}/line-items + * operationId: GetOrdersIdLineItems + * summary: List Line Items + * description: Retrieve a list of line items in a order. The line items can be filtered by fields like FILTER FIELDS. The line items can also be paginated. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The order's ID. + * required: true + * schema: + * type: string + * - 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" + * - name: id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: id + * description: The order's ID. + * - type: array + * description: The order's ID. + * items: + * type: string + * title: id + * description: The id's ID. + * - name: item_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: item_id + * description: The order's item id. + * - type: array + * description: The order's item id. + * items: + * type: string + * title: item_id + * description: The item id's details. + * - name: order_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: order_id + * description: The order's order id. + * - type: array + * description: The order's order id. + * items: + * type: string + * title: order_id + * description: The order id's details. + * - name: version + * in: query + * required: false + * schema: + * oneOf: + * - type: number + * title: version + * description: The order's version. + * - type: array + * description: The order's version. + * items: + * type: number + * title: version + * description: The version's details. + * - name: limit + * in: query + * description: Limit the number of items returned in the list. + * required: false + * schema: + * type: number + * title: limit + * description: Limit the number of items returned in the list. + * externalDocs: + * url: "#pagination" + * - name: offset + * in: query + * description: The number of items to skip when retrieving a list. + * required: false + * schema: + * type: number + * title: offset + * description: The number of items to skip when retrieving a list. + * 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 `-`. + * required: false + * schema: + * type: string + * title: order + * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. + * externalDocs: + * url: "#pagination" + * security: + * - api_token: [] + * - cookie_auth: [] + * - jwt_token: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl '{backend_url}/admin/orders/{id}/line-items' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Orders + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * type: object + * description: SUMMARY + * required: + * - order_items + * properties: + * order_items: + * type: array + * description: The order's order items. + * items: + * $ref: "#/components/schemas/AdminOrderItem" + * "400": + * $ref: "#/components/responses/400_error" + * "401": + * $ref: "#/components/responses/unauthorized" + * "404": + * $ref: "#/components/responses/not_found_error" + * "409": + * $ref: "#/components/responses/invalid_state_error" + * "422": + * $ref: "#/components/responses/invalid_request_error" + * "500": + * $ref: "#/components/responses/500_error" + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts index 8b02c1ac28..c92698e129 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of payments. The payments can be filtered by fields such as `id`. The payments can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts index 41647fb89a..3eec31706c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts index 693c736303..c5a7719e19 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_payments_payment-providers.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of payment providers. The payment providers can be filtered by fields such as `id`. The payment providers can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * 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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts index 3e5e3bc1ba..850dd4b31c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of price lists. The price lists can be filtered by fields such as `id`. The price lists can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts index 1ec097783c..c91684adde 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-lists_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts index 1ef4a4dc05..c0a4fc2bd3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of price preferences. The price preferences can be filtered by fields such as `id`. The price preferences can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts index 493c0798db..1756b8c2c6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_price-preferences_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts index 9bdeeb3630..ee8c3688f7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of product categories. The product categories can be filtered by fields such as `id`. The product categories can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts index ce27e18fda..47fd023f6a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-categories_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts index 9a6bb03250..8cd05c4200 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of product tags. The product tags can be filtered by fields such as `id`. The product tags can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts index c8a3e84590..23c4a4b5af 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-tags_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts index 066ef17c5f..e1ceb0195f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of product types. The product types can be filtered by fields such as `id`. The product types can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts index b0b34cf070..0aaf099472 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-types_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts index 2fc55f6080..5a1f0c5080 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_product-variants.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of product variants. The product variants can be filtered by fields such as `id`. The product variants can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts index 23651090d2..57cb65ab8d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of products. The products can be filtered by fields such as `id`. The products can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts index 160a7052fa..ce416df85e 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts index 85c4fa28c9..19d8975933 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts index 15ddd09e46..155566c1a7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_options_[option_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts index bfc1cba665..7affead612 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts index 4e4dd2e182..defc105315 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_products_[id]_variants_[variant_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts index b6d2e93f27..59f23f57c9 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of promotions. The promotions can be filtered by fields such as `id`. The promotions can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts index 9dd317d32e..cec96a3d21 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_[id].ts @@ -11,14 +11,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 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 39d726cb35..4d2476005e 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 @@ -26,14 +26,6 @@ * - rules * - target-rules * - buy-rules - * - 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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts index 2883a8c596..a4b0837b95 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of refund reasons. The refund reasons can be filtered by fields such as `id`. The refund reasons can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts index cd68c4e263..c5d25d780a 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_refund-reasons_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts index 20ce52983b..4aac12d5d6 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of regions. The regions can be filtered by fields such as `id`. The regions can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts index 184bd3a648..827102b5c8 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_regions_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts index 0c85e15a78..ee9470dcdb 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of reservations. The reservations can be filtered by fields such as `id`. The reservations can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts index 2815c7a999..1676b6107c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_reservations_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts index cf50b18d95..bf7c2bfbb7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of return reasons. The return reasons can be filtered by fields such as `id`. The return reasons can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts index 7d67efbe53..d3dfcf213f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_return-reasons_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts index fd7da7fb15..31ccf3d84d 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of returns. The returns can be filtered by fields such as `id`. The returns can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts index 34653d9c87..c8ec7c0683 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_returns_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts index 7e788523df..d000f31424 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of sales channels. The sales channels can be filtered by fields such as `id`. The sales channels can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts index 40a2d8b13b..cfdf05efa1 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_sales-channels_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts index 1a5ef6eee5..3d9b2e72de 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-options.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of shipping options. The shipping options can be filtered by fields such as `id`. The shipping options can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default 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 index 012a1a5857..fdd96bfe9d 100644 --- 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 @@ -11,14 +11,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: |- diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts index ad66ebb639..f9f75b6d40 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as `id`. The shipping profiles can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts index 3d3cce5251..9467a53fe7 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_shipping-profiles_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts index 0f9a5ebab0..b0bbee6330 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of stock locations. The stock locations can be filtered by fields such as `id`. The stock locations can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts index 9c590d13da..9a0aec6cda 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stock-locations_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts index 455b9f29fe..78301c6d4c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of stores. The stores can be filtered by fields such as `id`. The stores can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts index 609f097860..f613f597ef 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_stores_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts index fdb8aa4b76..791497c3ed 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of tax rates. The tax rates can be filtered by fields such as `id`. The tax rates can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts index ce57c8f596..474a07a20f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-rates_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts index ebcf68a372..655b1c2d2b 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of tax regions. The tax regions can be filtered by fields such as `id`. The tax regions can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts index 0b3449a4c0..c97f86b545 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_tax-regions_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts index d23b68fb67..edc086d0f2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_uploads_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts index 252bad9d24..c47c93b514 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of users. The users can be filtered by fields such as `id`. The users can also be sorted or paginated. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts index 2424bd3e91..db3880819c 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts index 2d921b52db..0905c73484 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_users_me.ts @@ -5,14 +5,6 @@ * description: Retrieve the logged-in user's details. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts index 272cb3cec0..e720485bd3 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of workflows executions. The workflows executions can be filtered by fields such as `id`. The workflows executions can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts index 0c63c9f856..da9b77f778 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts index 063eba344f..62476c6c7f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_workflows-executions_[workflow_id]_[transaction_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts index 607e4e1da4..560d43bdfa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts index c10105b960..d2db89625b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_revoke.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts index ca7e9556e2..cb517799e3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys_[id]_sales-channels.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts index f85b97bede..7336349321 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts @@ -5,14 +5,6 @@ * description: Create a campaign. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts index 352d3d1d50..2a8e39bf37 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts index 163d6e67ae..9a9c79368f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_campaigns_[id]_promotions.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts index 29d08f672c..71cf8e323d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims.ts @@ -5,14 +5,6 @@ * description: Create a claim. The claim is still in the request state, and the changes are only applied on the order once the claim is confirmed. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts index 52a6df5c8a..4e84958e51 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts index 1fb71b3b3e..7994e58204 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_claim-items_[action_id].ts @@ -20,14 +20,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts index 7036d86ce0..8274a4f321 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_inbound_shipping-method_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts index e0a4e51c11..f5a9c5c61c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items.ts @@ -13,14 +13,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts index 2414c66a50..accf9d712b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts index 9995c16218..934d1bb14b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method.ts @@ -13,14 +13,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts index 4924cfa012..0cb477e90c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_claims_[id]_outbound_shipping-method_[action_id].ts @@ -21,14 +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 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 8ca64468da..cfab4597cf 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 @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts index 7aeb2c973a..d51ca82cdd 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections.ts @@ -5,14 +5,6 @@ * description: Create a collection. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts index 65638c448a..3335187bb1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts index 39ae0cfc55..99647c7095 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_collections_[id]_products.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts index 369191a91e..5dd77b277c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups.ts @@ -5,14 +5,6 @@ * description: Create a customer group. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts index 07383b6402..024f294894 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts index e5eef41f70..d5fe6af533 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customer-groups_[id]_customers.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts index e692a56301..391333792a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers.ts @@ -5,14 +5,6 @@ * description: Create a customer. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts index e9395278ec..e22719c07e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts index 513441c72a..bcd78414fe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts index 99b4284eae..3c169622a1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_customers_[id]_addresses_[address_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts index 3307b4e7ec..82e64db5aa 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_draft-orders.ts @@ -5,14 +5,6 @@ * description: Create a draft order. This creates an order with the `is_draft_order` property enabled. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts index 6cba37ec03..fa47fba5c3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges.ts @@ -5,14 +5,6 @@ * description: Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts index aba12ce691..e726e6d0e8 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_inbound_shipping-method_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts index d92f1e5c6d..31db3bc407 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts index 4ecade2962..0a53dd8b28 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts index 42ea68cc67..607b291136 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts index d39f1687af..e838806ce2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_outbound_shipping-method_[action_id].ts @@ -21,14 +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 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 c331bbc559..66db07460c 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 @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts index 789ff33938..5c483a2148 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts index bc8b8f84a5..240e328cb3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillment-sets_[id]_service-zones_[zone_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts index 921a4ebe96..bbbcee47cb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments.ts @@ -5,14 +5,6 @@ * description: Create a fulfillment for an order, return, exchange, and more. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts index 3148508027..59e1f28658 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_cancel.ts @@ -14,14 +14,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts index cbe53bedd3..7c2e718118 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_fulfillments_[id]_shipment.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts index b23ef06c4b..b44e4231cc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items.ts @@ -5,14 +5,6 @@ * description: Create an inventory item. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts index 7e8eb6899e..2eec3d5cc4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts index 501e9183bb..31424d0304 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts index f3db9fa90e..36b60e4d20 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_inventory-items_[id]_location-levels_[location_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts index 3b1c4f9cf4..d535a8c1fb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites.ts @@ -5,14 +5,6 @@ * description: Create a invite. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default 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 19844288d0..d22c125aba 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 @@ -11,14 +11,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 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 b907bb17ef..13d4079d7d 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 @@ -11,14 +11,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 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 eca5af12f9..07f1b531f7 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 @@ -11,14 +11,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 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 90160ffc14..9d13689416 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 @@ -19,14 +19,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts index d9066a3670..146300b28f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_complete.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts index eefdb03908..50a4c6ef7e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts index e15897d62f..7e8067ea30 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_cancel.ts @@ -17,14 +17,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 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 8ba52958c1..0652b79a94 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 @@ -18,14 +18,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: |- diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts index 444bbec087..3577cf3d97 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_orders_[id]_fulfillments_[fulfillment_id]_shipments.ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts index 5a278c61e9..358369fe97 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections.ts @@ -5,14 +5,6 @@ * description: Create a payment collection. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts index 5c6b70f8bd..40942a21cb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payment-collections_[id]_mark-as-paid.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts index 75510784b2..a9cb527806 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_capture.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts index 6c22efb888..abcd978b4a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_payments_[id]_refund.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts index 43ce03e132..0941876393 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists.ts @@ -5,14 +5,6 @@ * description: Create a price list. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts index 7bda75c115..5553ad2d2a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts index b9b00ff0c6..261d31b999 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_products.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts index ed502f4741..1bf166c394 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences.ts @@ -5,14 +5,6 @@ * description: Create a price preference. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts index 123b78a825..7b9407de80 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-preferences_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts index 174d02efcb..b8410af5d5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories.ts @@ -5,14 +5,6 @@ * description: Create a product category. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts index 27e98ee3a0..11879a39ba 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts index 14f785ab16..2a73925914 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-categories_[id]_products.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts index 41e4b61ce4..54908f1d76 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags.ts @@ -5,14 +5,6 @@ * description: Create a product tag. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts index 29bd60cf73..eeeba17748 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-tags_[id].ts @@ -11,14 +11,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 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 ba94d2f1f9..a2f4efc205 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 @@ -5,14 +5,6 @@ * description: Create a product type. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts index bae6a45b81..d43ecd089f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_product-types_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts index d5f773874f..cb708e9f8a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products.ts @@ -5,14 +5,6 @@ * description: Create a product. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts index 84b1937687..8d41e66ff6 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts index 847e8c01d8..68639b09d2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts index 3c4ab07643..30498dbe7c 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_options_[option_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts index f72e83e3c2..af8f87f1fe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts index 8d2e1f3f61..ebe3de7a8a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id].ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts index c62cef85d7..ec5f09f499 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items.ts @@ -18,14 +18,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts index 1a20fae320..b1deec9d98 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_[variant_id]_inventory-items_[inventory_item_id].ts @@ -24,14 +24,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts index aaef139ebc..5550c30426 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_[id]_variants_batch.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts index 6666da3497..2c60665d70 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_batch.ts @@ -5,14 +5,6 @@ * description: Manage products to create, update, or delete them. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts index 111cd4ceda..ab3848f1c0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_export.ts @@ -11,14 +11,6 @@ * Once the execution finishes successfully, a notification is created for the export. You can retrieve the notifications using the `/admin/notification` API route to retrieve the file's download URL. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts index a0fdaef724..c82a36f76f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions.ts @@ -5,14 +5,6 @@ * description: Create a promotion. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts index 4e18dea3dd..e014405c31 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_promotions_[id].ts @@ -11,14 +11,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 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 6306add98d..34146a8342 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 @@ -12,14 +12,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 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 6180fb2e45..7786cfef60 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 @@ -12,14 +12,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 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 c2abaca8e7..ee4c5af341 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 @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts index 8499aa1459..80266690a0 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons.ts @@ -5,14 +5,6 @@ * description: Create a refund reason. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts index 4984f2717a..4ef8f04d25 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_refund-reasons_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts index c0d920703a..f4cbc02f53 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions.ts @@ -5,14 +5,6 @@ * description: Create a region. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts index 9c9eec2263..07e973ce4f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_regions_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts index b60938a919..321376cdb9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations.ts @@ -5,14 +5,6 @@ * description: Create a reservation. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts index 9ec629c763..0fee20f987 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_reservations_[id].ts @@ -11,14 +11,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 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 e4bfc2172a..661a5be1d3 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 @@ -5,14 +5,6 @@ * description: Create a return reason. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default 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 7b61d4139f..91b991542a 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 @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts index 0859e6b665..921c41b62a 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns.ts @@ -5,14 +5,6 @@ * description: Create a return. The return can later be requested or confirmed. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts index 66400d776e..478414bf9b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts index da406d039a..3997689c05 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts index 3b700e9e98..47bdbb938b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_dismiss-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts index dd43051287..ca1b15f5f7 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts index 26e61b8d07..43e409ea62 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts index 809ae525d6..9e7736f676 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive.ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts index f6ee1e7e14..aefc042df3 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_receive_confirm.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts index 17afe248c2..fbcac8a4e2 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts index 176af55064..a794d2da43 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request-items_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts index 5eae45a940..42b371ba82 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_request.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts index ec5a270190..a59e1489be 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts index 19dce7b352..19f620638d 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_returns_[id]_shipping-method_[action_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts index 1067f368c0..24fde74d0b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels.ts @@ -5,14 +5,6 @@ * description: Create a sales channel. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts index ef16ba3bc8..900a7381dc 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts index 4ccd2671d8..88d7d9f946 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_sales-channels_[id]_products.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts index fc78d40e41..f030a342fe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-options.ts @@ -5,14 +5,6 @@ * description: Create a shipping option. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default 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 3b982d2d2c..3afd215395 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 @@ -11,14 +11,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 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 c1eed17ac8..6b55dbbeff 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 @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts index e1f874f2fd..be33f3d0bb 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles.ts @@ -5,14 +5,6 @@ * description: Create a shipping profile. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts index ba055074fd..f396c63610 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_shipping-profiles_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts index eb5b7f3aae..8a6f9f4b61 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations.ts @@ -5,14 +5,6 @@ * description: Create a stock location. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts index c673b4a86e..5651dccfc4 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts index 2029c78536..bb17709e7e 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_fulfillment-providers.ts @@ -12,14 +12,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 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 080e66439d..91a07cf7c9 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 @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts index b972d6ad19..6cd61feb33 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stock-locations_[id]_sales-channels.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts index f22a475c32..000857aa9b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_stores_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts index 1fe8ababaf..f32cc7de6b 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates.ts @@ -5,14 +5,6 @@ * description: Create a tax rate. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts index d0f6bcc713..4f64bd9252 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts index 63be1b50c6..d885226dfe 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-rates_[id]_rules.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts index 695fb2ce8e..7e3ab3f300 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions.ts @@ -5,14 +5,6 @@ * description: Create a tax region. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts new file mode 100644 index 0000000000..ea0291f140 --- /dev/null +++ b/www/utils/generated/oas-output/operations/admin/post_admin_tax-regions_[id].ts @@ -0,0 +1,67 @@ +/** + * @oas [post] /admin/tax-regions/{id} + * operationId: PostTaxRegionsId + * summary: Update a Tax Region + * description: Update a tax region's details. + * x-authenticated: true + * parameters: + * - name: id + * in: path + * description: The tax region's ID. + * required: true + * schema: + * type: string + * - 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: [] + * requestBody: + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminUpdateTaxRegion" + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: |- + * curl -X POST '{backend_url}/admin/tax-regions/{id}' \ + * -H 'Authorization: Bearer {access_token}' + * tags: + * - Tax Regions + * responses: + * "200": + * description: OK + * content: + * application/json: + * schema: + * $ref: "#/components/schemas/AdminTaxRegionResponse" + * "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: updateTaxRegionsWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts index e1e6e084ba..bfa4b92dde 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_users_[id].ts @@ -11,14 +11,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 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 86103b3618..5b5b82c463 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 @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts index 19ca846163..d2917541b9 100644 --- a/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/delete_store_carts_[id]_promotions.ts @@ -11,14 +11,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 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 f8905ce810..b313756f03 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 @@ -15,14 +15,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts index 6a314881f7..7985a7f93e 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_carts_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections.ts b/www/utils/generated/oas-output/operations/store/get_store_collections.ts index 6a63920ceb..4f59e6d356 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections.ts @@ -8,14 +8,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/products/collections/list * description: "Storefront guide: How to retrieve a list of collections." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts index 120420343b..701a6eb6f0 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_collections_[id].ts @@ -14,14 +14,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts index c5f43158a5..f5ce66794f 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of currencies. The currencies can be filtered by fields such as `code`. The currencies can also be sorted or paginated. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts index 9761b49c6a..985e7f71eb 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_currencies_[code].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts index ea17aba9c7..ddab2a89ce 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me.ts @@ -9,14 +9,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/retrieve * description: "Storefront guide: How to retrieve the logged-in customer." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts index b22fe3efdb..4d1922d3b7 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses.ts @@ -9,14 +9,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/customers/addresses#list-customer-addresses * description: "Storefront guide: How to retrieve the logged-in customer's addresses." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts index 330d462ce8..043bc44d5c 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_customers_me_addresses_[address_id].ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders.ts b/www/utils/generated/oas-output/operations/store/get_store_orders.ts index 5062da4f28..2058b77ef5 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders.ts @@ -6,14 +6,6 @@ * description: Retrieve the orders of the logged-in customer. The orders can be filtered by fields such as `id`. The orders can also be sorted or paginated. * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts index 7e0869fe16..30108b60f6 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_orders_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts index 5f0feff27a..14f23ae459 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -8,14 +8,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/checkout/payment * description: "Storefront guide: How to implement payment during checkout." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts index 313b3c7108..9a4fcd76e6 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories.ts @@ -8,14 +8,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/products/categories/list * description: "Storefront guide: How to retrieve a list of product categories." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts index 3e7883cdab..53748a15b0 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts @@ -14,14 +14,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 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 9aea198d32..94c1e10a0e 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 @@ -8,14 +8,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/products/price * description: "Storefront guide: How to retrieve a product variants' prices." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts index aea1d410a1..f4ba8c0b30 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_products_[id].ts @@ -14,14 +14,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions.ts b/www/utils/generated/oas-output/operations/store/get_store_regions.ts index 9017ae20a2..755fe8afeb 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_regions.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_regions.ts @@ -8,14 +8,6 @@ * url: https://docs.medusajs.com/v2/resources/storefront-development/regions/list * description: "Storefront guide: How to retrieve a list of regions." * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default 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 394167d3fb..ab838eccde 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 @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts index 08aeef9aaf..439022def8 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons.ts @@ -5,14 +5,6 @@ * description: Retrieve a list of return reasons. The return reasons can be sorted or paginated. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts index 9bcd73bcee..635e4de606 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts +++ b/www/utils/generated/oas-output/operations/store/get_store_return-reasons_[id].ts @@ -11,14 +11,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 diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index ad02dbdbe4..1a26c097ce 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts.ts @@ -5,14 +5,6 @@ * description: Create a cart. * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts index a7cf50802b..0f3facb5de 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id].ts @@ -11,14 +11,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 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 c315b05dc6..77ea7b3c09 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 @@ -14,14 +14,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 diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts index da97cc8cd5..94f84be1a9 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items.ts @@ -15,14 +15,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 diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts index 16b7a8794f..86b4a7b40c 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_line-items_[line_id].ts @@ -21,14 +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 diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts index 970b82c91d..5947900e40 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_promotions.ts @@ -12,14 +12,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 diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts index adfd4fdbc3..073592307a 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_shipping-methods.ts @@ -15,14 +15,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 @@ -85,7 +77,7 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" - * x-workflow: addShippingMethodToWorkflow + * x-workflow: addShippingMethodToCartWorkflow * */ diff --git a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts index 9f75223508..b22c62ad10 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_carts_[id]_taxes.ts @@ -12,14 +12,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 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 b9e92dc3ca..f531c8c605 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 @@ -8,14 +8,6 @@ * description: "Storefront guide: How to register a customer." * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts index 41e1f6f359..f11f68e5a7 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me.ts @@ -8,14 +8,6 @@ * description: "Storefront guide: How to edit a customer's profile." * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts index 527286ffb9..15e086d51d 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses.ts @@ -9,14 +9,6 @@ * description: "Storefront guide: How to create an address for the logged-in customer." * x-authenticated: true * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default diff --git a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts index e0366cc425..14860fac3e 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts +++ b/www/utils/generated/oas-output/operations/store/post_store_customers_me_addresses_[address_id].ts @@ -15,14 +15,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 diff --git a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts index 387a71767a..2692fda168 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_payment-collections.ts @@ -8,14 +8,6 @@ * description: "Storefront guide: How to implement payment during checkout." * x-authenticated: false * parameters: - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. * - name: fields * in: query * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default 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 474c75fdc1..48759c902e 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 @@ -16,14 +16,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 diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts index 9fe2f69296..7f7cb831e1 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts @@ -5,9 +5,9 @@ * x-schemaName: AdminCreateFulfillment * required: * - data - * - order_id - * - metadata * - items + * - metadata + * - order_id * - location_id * - provider_id * - delivery_address diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts index 7cbadb6e15..c6057f95d4 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOption.ts @@ -4,22 +4,84 @@ * description: The shipping option's details. * x-schemaName: AdminCreateShippingOption * required: - * - label - * - description - * - code + * - name + * - service_zone_id + * - shipping_profile_id + * - price_type + * - provider_id + * - type + * - prices * properties: - * label: + * name: * type: string - * title: label - * description: The type's label. - * description: + * title: name + * description: The shipping option's name. + * service_zone_id: * type: string - * title: description - * description: The type's description. - * code: + * title: service_zone_id + * description: The ID of the associated service zone. + * shipping_profile_id: * type: string - * title: code - * description: The type's code. + * title: shipping_profile_id + * description: The ID of the associated shipping profile. + * data: + * type: object + * description: The shipping option's data, useful for the fulfillment provider handling its processing. + * externalDocs: + * url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property + * price_type: + * type: string + * description: The shipping option's price type. If `flat`, the shipping option has a fixed price set in `prices`. Otherwise, the shipping option's price is calculated by the fulfillment provider. + * enum: + * - flat + * - calculated + * provider_id: + * type: string + * title: provider_id + * description: The ID of the fulfillment provider handling this shipping option. + * type: + * $ref: "#/components/schemas/AdminCreateShippingOptionType" + * prices: + * type: array + * description: The shipping option's prices. + * items: + * oneOf: + * - type: object + * description: The price's details. + * x-schemaName: AdminCreateShippingOptionPriceWithCurrency + * required: + * - currency_code + * - amount + * properties: + * 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. + * - type: object + * description: The price's details. + * 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" * */ diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionType.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionType.ts new file mode 100644 index 0000000000..3fcecff75c --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingOptionType.ts @@ -0,0 +1,25 @@ +/** + * @schema AdminCreateShippingOptionType + * type: object + * description: The shipping option type's details. + * x-schemaName: AdminCreateShippingOptionType + * required: + * - label + * - description + * - code + * properties: + * label: + * type: string + * title: label + * description: The type's label. + * description: + * type: string + * title: description + * description: The type's description. + * code: + * type: string + * title: code + * description: The type's code. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminExchange.ts b/www/utils/generated/oas-output/schemas/AdminExchange.ts index e5ce683e19..164c2ecb24 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchange.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchange.ts @@ -93,7 +93,7 @@ * title: deleted_at * description: The date the exchange was deleted. * order: - * $ref: "#/components/schemas/AdminOrder" + * $ref: "#/components/schemas/BaseOrder" * allow_backorder: * type: boolean * title: allow_backorder diff --git a/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts b/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts index aaeac3d197..c8cb5fc589 100644 --- a/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts +++ b/www/utils/generated/oas-output/schemas/AdminExchangeOrderResponse.ts @@ -8,7 +8,6 @@ * - exchange * properties: * order: - * description: The details of the associated order. * $ref: "#/components/schemas/Order" * exchange: * $ref: "#/components/schemas/AdminExchange" diff --git a/www/utils/generated/oas-output/schemas/AdminOrder.ts b/www/utils/generated/oas-output/schemas/AdminOrder.ts index ef2d92706a..ab4a0183ab 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrder.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrder.ts @@ -9,16 +9,16 @@ * - shipping_methods * - currency_code * - id - * - created_at - * - updated_at - * - email * - version * - region_id * - customer_id * - sales_channel_id + * - email * - payment_status * - fulfillment_status * - summary + * - created_at + * - updated_at * - original_item_total * - original_item_subtotal * - original_item_tax_total diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts index d260e276b1..1610a644cc 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChange.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChange.ts @@ -10,12 +10,12 @@ * - exchange * - actions * - status - * - order_id - * - metadata * - id + * - version + * - metadata * - created_at * - updated_at - * - version + * - order_id * - canceled_at * - return_id * - exchange_id @@ -62,11 +62,7 @@ * title: claim_id * description: The ID of the associated claim. * order: - * type: string - * title: order - * description: The order change's order. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/AdminOrder" * return_order: * $ref: "#/components/schemas/AdminReturn" * exchange: diff --git a/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts b/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts index 8faea3d175..35dc9818b0 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderChangeAction.ts @@ -6,11 +6,11 @@ * required: * - order_change * - order - * - order_id - * - internal_note * - id * - created_at * - updated_at + * - order_id + * - internal_note * - return_id * - exchange_id * - claim_id @@ -47,11 +47,7 @@ * title: exchange_id * description: The ID of the associated exchange. * order: - * type: string - * title: order - * description: The order change's order. - * externalDocs: - * url: "#pagination" + * $ref: "#/components/schemas/AdminOrder" * reference: * type: string * title: reference diff --git a/www/utils/generated/oas-output/schemas/AdminOrderItem.ts b/www/utils/generated/oas-output/schemas/AdminOrderItem.ts new file mode 100644 index 0000000000..afc73ec3cf --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminOrderItem.ts @@ -0,0 +1,50 @@ +/** + * @schema AdminOrderItem + * type: object + * description: The order item's details. + * x-schemaName: AdminOrderItem + * required: + * - order_id + * - item_id + * - version + * - history + * - item + * properties: + * order_id: + * type: string + * title: order_id + * description: The ID of the order this item belongs to. + * item_id: + * type: string + * title: item_id + * description: The ID of the associated line item. + * version: + * type: number + * title: version + * description: The order item's version. + * history: + * type: object + * description: The order item's history. + * required: + * - version + * properties: + * version: + * type: object + * description: The version changes of the item. + * required: + * - from + * - to + * properties: + * from: + * type: number + * title: from + * description: The original version. + * to: + * type: number + * title: to + * description: The new version. + * item: + * $ref: "#/components/schemas/AdminOrderLineItem" + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts index 15948b07bb..1b5c5c1228 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderLineItem.ts @@ -5,10 +5,8 @@ * x-schemaName: AdminOrderLineItem * required: * - title - * - metadata * - id - * - subtitle - * - thumbnail + * - metadata * - created_at * - updated_at * - item_total @@ -22,6 +20,8 @@ * - tax_total * - discount_total * - discount_tax_total + * - subtitle + * - thumbnail * - variant_id * - product_id * - product_title diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index 8b9c95b600..58a1ea09a3 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -8,17 +8,17 @@ * - order_change * - currency_code * - id - * - created_at - * - updated_at - * - email * - version * - region_id * - customer_id * - sales_channel_id + * - email * - payment_collections * - payment_status * - fulfillment_status * - summary + * - created_at + * - updated_at * - original_item_total * - original_item_subtotal * - original_item_tax_total diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts index 1f04e254b4..f732e6bed3 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsAddItemsReqSchema.ts @@ -37,6 +37,10 @@ * metadata: * type: object * description: The item's metadata, can hold custom key-value pairs. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The original price of the item before a promotion or sale. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts index 1edcddeb7b..80f36098f1 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsItemsActionReqSchema.ts @@ -16,6 +16,10 @@ * type: number * title: unit_price * description: The item's unit price. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The original price of the item before a promotion or sale. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts index bedc1cbb76..c0f5e71eed 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsUpdateItemQuantityReqSchema.ts @@ -18,6 +18,10 @@ * type: number * title: unit_price * description: The item's unit price. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The original price of the item before a promotion or sale. * */ diff --git a/www/utils/generated/oas-output/schemas/AdminProduct.ts b/www/utils/generated/oas-output/schemas/AdminProduct.ts index 2080abf78d..43566a5f41 100644 --- a/www/utils/generated/oas-output/schemas/AdminProduct.ts +++ b/www/utils/generated/oas-output/schemas/AdminProduct.ts @@ -13,10 +13,12 @@ * - status * - description * - id - * - handle + * - created_at + * - updated_at * - subtitle - * - is_giftcard * - thumbnail + * - handle + * - is_giftcard * - width * - weight * - height @@ -28,8 +30,6 @@ * - type_id * - discountable * - external_id - * - created_at - * - updated_at * - deleted_at * properties: * collection: diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts new file mode 100644 index 0000000000..e400ee58b9 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRegion.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminUpdateTaxRegion + * type: object + * description: The details to update in a tax region. + * x-schemaName: AdminUpdateTaxRegion + * properties: + * province_code: + * type: string + * title: province_code + * description: The tax region's province code. + * metadata: + * type: object + * description: The tax region's metadata, can hold custom key-value pairs. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts index f4b13a229d..ea2335d125 100644 --- a/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts +++ b/www/utils/generated/oas-output/schemas/BaseCalculatedPriceSet.ts @@ -53,63 +53,9 @@ * 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 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/utils/generated/oas-output/schemas/BaseCollection.ts b/www/utils/generated/oas-output/schemas/BaseCollection.ts index 1d074d9ba9..f111322b18 100644 --- a/www/utils/generated/oas-output/schemas/BaseCollection.ts +++ b/www/utils/generated/oas-output/schemas/BaseCollection.ts @@ -1,8 +1,52 @@ /** * @schema BaseCollection * type: object - * description: The collection's details. + * description: The product 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 collection's creation date. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The collection's update date. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The collection's deletion date. + * products: + * type: array + * description: The collection's products. + * items: + * $ref: "#/components/schemas/AdminProduct" + * metadata: + * type: object + * description: The collection's metadata, used to store custom key-value pairs. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseOrder.ts b/www/utils/generated/oas-output/schemas/BaseOrder.ts index d23be983f7..48a02e69f1 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrder.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrder.ts @@ -4,7 +4,6 @@ * description: The order's details. * x-schemaName: BaseOrder * required: - * - payment_collections * - id * - version * - region_id @@ -17,7 +16,6 @@ * - payment_status * - fulfillment_status * - summary - * - metadata * - created_at * - updated_at * - original_item_total @@ -47,20 +45,16 @@ * type: array * description: The order's payment collections. * items: - * $ref: "#/components/schemas/AdminPaymentCollection" + * $ref: "#/components/schemas/BasePaymentCollection" * 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" + * $ref: "#/components/schemas/BaseOrderAddress" * billing_address: - * $ref: "#/components/schemas/AdminOrderAddress" + * $ref: "#/components/schemas/BaseOrderAddress" * id: * type: string * title: id @@ -239,4 +233,5 @@ * title: original_shipping_tax_total * description: The tax total of the order's shipping excluding promotions. * -*/ \ No newline at end of file +*/ + diff --git a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts index 5a99652682..b1b136f743 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderAddress.ts @@ -1,7 +1,7 @@ /** * @schema BaseOrderAddress * type: object - * description: An order address + * description: An order address. * x-schemaName: BaseOrderAddress * required: * - id @@ -50,8 +50,6 @@ * title: country_code * description: The address's country code. * example: us - * country: - * $ref: "#/components/schemas/AdminRegionCountry" * province: * type: string * title: province diff --git a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts index bffc83d43b..bd82946367 100644 --- a/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/BaseOrderFulfillment.ts @@ -1,7 +1,7 @@ /** * @schema BaseOrderFulfillment * type: object - * description: The fulfillment's fulfillments. + * description: The fulfillment's details. * x-schemaName: BaseOrderFulfillment * required: * - id @@ -10,6 +10,7 @@ * - shipped_at * - delivered_at * - canceled_at + * - requires_shipping * - data * - provider_id * - shipping_option_id @@ -71,5 +72,10 @@ * 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/utils/generated/oas-output/schemas/BasePaymentProvider.ts b/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts index 043b869198..2531903533 100644 --- a/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts +++ b/www/utils/generated/oas-output/schemas/BasePaymentProvider.ts @@ -1,7 +1,7 @@ /** * @schema BasePaymentProvider * type: object - * description: The payment provider's payment providers. + * description: The payment provider's details. * x-schemaName: BasePaymentProvider * required: * - id diff --git a/www/utils/generated/oas-output/schemas/BaseProductCategory.ts b/www/utils/generated/oas-output/schemas/BaseProductCategory.ts index b856b0ea55..221ce6fdce 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductCategory.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductCategory.ts @@ -1,8 +1,85 @@ /** * @schema BaseProductCategory * type: object - * description: The category's categories. + * description: The product category's details. * x-schemaName: BaseProductCategory + * required: + * - id + * - name + * - description + * - handle + * - is_active + * - is_internal + * - rank + * - parent_category_id + * - parent_category + * - category_children + * - created_at + * - updated_at + * - deleted_at + * properties: + * category_children: + * type: array + * description: The category's children. + * items: + * $ref: "#/components/schemas/BaseProductCategory" + * parent_category: + * $ref: "#/components/schemas/BaseProductCategory" + * products: + * type: array + * description: The category's products. + * items: + * $ref: "#/components/schemas/BaseProduct" + * name: + * type: string + * title: name + * description: The category's name. + * description: + * type: string + * title: description + * description: The category's description. + * id: + * type: string + * title: id + * description: The category's ID. + * metadata: + * type: object + * description: The category's metadata, can hold custom key-value pairs. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The date the category was created. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The date the category was updated. + * handle: + * type: string + * title: handle + * description: The category's unique handle. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the category was deleted. + * is_active: + * type: boolean + * title: is_active + * description: Whether the category is active. If disabled, the category isn't shown in the storefront. + * is_internal: + * type: boolean + * title: is_internal + * description: Whether the category is internal. If enabled, the category is only seen by admin users. + * rank: + * type: number + * title: rank + * description: The category's rank among sibling categories. + * parent_category_id: + * type: string + * title: parent_category_id + * description: The ID of the category's parent. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductOption.ts b/www/utils/generated/oas-output/schemas/BaseProductOption.ts index 62664b620f..25a3688df1 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductOption.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductOption.ts @@ -3,47 +3,47 @@ * type: object * description: The product option's details. * x-schemaName: BaseProductOption + * required: + * - id + * - title * properties: * id: * type: string * title: id - * description: The option's ID. + * description: The product option's ID. * title: * type: string * title: title - * description: The option's title. + * description: The product option's title. * product: * $ref: "#/components/schemas/BaseProduct" * product_id: * type: string * title: product_id - * description: The option's product id. + * description: The ID of the product this option belongs to. * values: * type: array - * description: The option's values. + * description: The product option's values. * items: * $ref: "#/components/schemas/BaseProductOptionValue" * metadata: * type: object - * description: The 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 option's created at. + * description: The date the product option was created. * updated_at: * type: string * format: date-time * title: updated_at - * description: The option's updated at. + * description: The date the product option was updated. * deleted_at: * type: string * format: date-time * title: deleted_at - * description: The option's deleted at. - * required: - * - id - * - title + * description: The date the product option was deleted. * */ diff --git a/www/utils/generated/oas-output/schemas/BaseProductTag.ts b/www/utils/generated/oas-output/schemas/BaseProductTag.ts index 49c9639b54..a1fc817c29 100644 --- a/www/utils/generated/oas-output/schemas/BaseProductTag.ts +++ b/www/utils/generated/oas-output/schemas/BaseProductTag.ts @@ -1,8 +1,40 @@ /** * @schema BaseProductTag * type: object - * description: The tag's tags. + * description: The product tag's details. * x-schemaName: BaseProductTag + * required: + * - id + * - value + * - created_at + * - updated_at + * 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. * */ diff --git a/www/utils/generated/oas-output/schemas/Order.ts b/www/utils/generated/oas-output/schemas/Order.ts index 2d664640ee..f6ddabb22f 100644 --- a/www/utils/generated/oas-output/schemas/Order.ts +++ b/www/utils/generated/oas-output/schemas/Order.ts @@ -33,28 +33,6 @@ * - 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 @@ -230,72 +208,6 @@ * 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/utils/generated/oas-output/schemas/OrderClaim.ts b/www/utils/generated/oas-output/schemas/OrderClaim.ts index 107c612005..447b2c3e5b 100644 --- a/www/utils/generated/oas-output/schemas/OrderClaim.ts +++ b/www/utils/generated/oas-output/schemas/OrderClaim.ts @@ -4,44 +4,14 @@ * description: The order change's claim. * x-schemaName: OrderClaim * required: + * - id + * - type * - order_id + * - order_version + * - display_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 @@ -72,79 +42,29 @@ * title: no_notification * description: Whether the customer should be notified about changes in the claim. * refund_amount: - * type: number - * title: refund_amount + * oneOf: + * - type: string + * title: refund_amount + * description: The claim's refund amount. + * - type: number + * title: refund_amount + * description: The claim's refund amount. + * - type: string + * title: refund_amount + * description: The claim's refund amount. + * - type: number + * title: refund_amount + * description: The claim's 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/OrderShippingMethod" * transactions: * type: array * description: The claim's transactions. @@ -152,9 +72,7 @@ * 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" + * $ref: "#/components/schemas/OrderTransaction" * metadata: * type: object * description: The claim's metadata, used to store custom key-value pairs. @@ -168,94 +86,46 @@ * format: date-time * title: updated_at * description: The claim's update date. - * original_item_total: + * type: + * type: string + * description: The claim's type. + * enum: + * - replace + * - refund + * order: + * $ref: "#/components/schemas/Order" + * order_version: * 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. + * title: order_version + * description: The claim's order version. + * raw_refund_amount: + * oneOf: + * - type: string + * title: raw_refund_amount + * description: The claim's raw refund amount. + * - type: number + * title: raw_refund_amount + * description: The claim's raw refund amount. + * - type: string + * title: raw_refund_amount + * description: The claim's raw refund amount. + * - type: number + * title: raw_refund_amount + * description: The claim's raw refund amount. + * created_by: + * type: string + * title: created_by + * description: The ID of the user that created the claim. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the claim was deleted. + * canceled_at: + * type: string + * title: canceled_at + * description: The date the claim was canceled. + * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/OrderExchange.ts b/www/utils/generated/oas-output/schemas/OrderExchange.ts index 675d5ebcea..a1b7f92eb6 100644 --- a/www/utils/generated/oas-output/schemas/OrderExchange.ts +++ b/www/utils/generated/oas-output/schemas/OrderExchange.ts @@ -4,54 +4,17 @@ * 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 + * - order_id + * - order_version + * - display_id + * - additional_items * - 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. @@ -66,98 +29,31 @@ * 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" + * $ref: "#/components/schemas/Return" * 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 + * $ref: "#/components/schemas/OrderShippingMethod" * 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" + * $ref: "#/components/schemas/OrderTransaction" * metadata: * type: object * description: The exchange's metadata, can hold custom key-value pairs. @@ -171,94 +67,44 @@ * format: date-time * title: updated_at * description: The date that the exchange was updated. - * original_item_total: + * order: + * $ref: "#/components/schemas/Order" + * order_version: * 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. + * title: order_version + * description: The version of the order when the exchange is applied. + * raw_difference_due: + * oneOf: + * - type: string + * title: raw_difference_due + * description: The exchange's raw difference due. + * - type: number + * title: raw_difference_due + * description: The exchange's raw difference due. + * - type: string + * title: raw_difference_due + * description: The exchange's raw difference due. + * - type: number + * title: raw_difference_due + * description: The exchange's raw difference due. + * allow_backorder: + * type: boolean + * title: allow_backorder + * description: Whether variants that are out of stock can be added to the exchange as outbound items. + * created_by: + * type: string + * title: created_by + * description: The ID of the user that created the exchange. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the exchange was deleted. + * canceled_at: + * type: string + * title: canceled_at + * description: The date the exchange was canceled. + * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/OrderItem.ts b/www/utils/generated/oas-output/schemas/OrderItem.ts index 2a83113eaf..a253efccdd 100644 --- a/www/utils/generated/oas-output/schemas/OrderItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderItem.ts @@ -8,21 +8,13 @@ * - 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 @@ -41,58 +33,34 @@ * 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. diff --git a/www/utils/generated/oas-output/schemas/OrderLineItem.ts b/www/utils/generated/oas-output/schemas/OrderLineItem.ts index 896e0dd04b..214ec7887e 100644 --- a/www/utils/generated/oas-output/schemas/OrderLineItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderLineItem.ts @@ -10,9 +10,7 @@ * - is_discountable * - is_tax_inclusive * - unit_price - * - raw_unit_price * - quantity - * - raw_quantity * - detail * - created_at * - updated_at @@ -29,19 +27,6 @@ * - 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 @@ -124,56 +109,14 @@ * 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. @@ -251,188 +194,6 @@ * 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/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts b/www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts index 908f7671c5..65717e3acb 100644 --- a/www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts +++ b/www/utils/generated/oas-output/schemas/OrderLineItemTaxLine.ts @@ -8,8 +8,6 @@ * - item_id * - total * - subtotal - * - raw_total - * - raw_subtotal * - id * - code * - rate @@ -30,12 +28,6 @@ * 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 diff --git a/www/utils/generated/oas-output/schemas/OrderReturnItem.ts b/www/utils/generated/oas-output/schemas/OrderReturnItem.ts index 1f83a41637..8b14948b5b 100644 --- a/www/utils/generated/oas-output/schemas/OrderReturnItem.ts +++ b/www/utils/generated/oas-output/schemas/OrderReturnItem.ts @@ -5,11 +5,10 @@ * x-schemaName: OrderReturnItem * required: * - id - * - quantity - * - received_quantity - * - damaged_quantity - * - item_id * - return_id + * - order_id + * - item_id + * - quantity * properties: * id: * type: string @@ -23,18 +22,10 @@ * 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 @@ -46,6 +37,20 @@ * metadata: * type: object * description: The return item's metadata, can hold custom key-value pairs. + * order_id: + * type: string + * title: order_id + * description: The ID of the order the return belongs to. + * 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/utils/generated/oas-output/schemas/OrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts index 90a690e1e4..8e97422ecf 100644 --- a/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts +++ b/www/utils/generated/oas-output/schemas/OrderShippingMethod.ts @@ -8,7 +8,6 @@ * - order_id * - name * - amount - * - raw_amount * - is_tax_inclusive * - created_at * - updated_at @@ -20,14 +19,6 @@ * - 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 @@ -49,20 +40,6 @@ * 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 @@ -131,118 +108,6 @@ * 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/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts b/www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts index 0852e45e5c..a85a316ce5 100644 --- a/www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts +++ b/www/utils/generated/oas-output/schemas/OrderShippingMethodTaxLine.ts @@ -8,8 +8,6 @@ * - shipping_method_id * - total * - subtotal - * - raw_total - * - raw_subtotal * - id * - code * - rate @@ -30,12 +28,6 @@ * 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 diff --git a/www/utils/generated/oas-output/schemas/OrderTransaction.ts b/www/utils/generated/oas-output/schemas/OrderTransaction.ts index 19d487f80a..e4a2ce5141 100644 --- a/www/utils/generated/oas-output/schemas/OrderTransaction.ts +++ b/www/utils/generated/oas-output/schemas/OrderTransaction.ts @@ -6,6 +6,7 @@ * required: * - id * - order_id + * - order * - amount * - currency_code * - reference @@ -55,5 +56,8 @@ * format: date-time * title: updated_at * description: The date that the transaction was updated. + * order: + * $ref: "#/components/schemas/Order" * -*/ \ No newline at end of file +*/ + diff --git a/www/utils/generated/oas-output/schemas/Return.ts b/www/utils/generated/oas-output/schemas/Return.ts index f7562fa67a..b4d003ec8d 100644 --- a/www/utils/generated/oas-output/schemas/Return.ts +++ b/www/utils/generated/oas-output/schemas/Return.ts @@ -8,54 +8,8 @@ * - 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 + * - display_id + * - metadata * properties: * id: * type: string @@ -82,32 +36,6 @@ * description: The return's items. * items: * $ref: "#/components/schemas/OrderReturnItem" - * 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: "#/components/schemas/OrderAddress" - * billing_address: - * $ref: "#/components/schemas/OrderAddress" * shipping_methods: * type: array * description: The return's shipping methods. @@ -118,9 +46,6 @@ * description: The return's transactions. * items: * $ref: "#/components/schemas/OrderTransaction" - * summary: - * type: object - * description: The return's summary. * metadata: * type: object * description: The return's metadata, can hold custom key-value pairs. @@ -134,171 +59,70 @@ * 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: "#/components/schemas/OrderChange" * canceled_at: * type: string * title: canceled_at * description: The date the return was canceled. * format: date-time - * discount_subtotal: + * raw_refund_amount: + * oneOf: + * - type: string + * title: raw_refund_amount + * description: The return order's raw refund amount. + * - type: number + * title: raw_refund_amount + * description: The return order's raw refund amount. + * - type: string + * title: raw_refund_amount + * description: The return order's raw refund amount. + * - type: number + * title: raw_refund_amount + * description: The return order's raw refund amount. + * order: + * $ref: "#/components/schemas/Order" + * exchange_id: + * type: string + * title: exchange_id + * description: The ID of the exchange this return belongs to, if any. + * exchange: + * $ref: "#/components/schemas/OrderExchange" + * claim_id: + * type: string + * title: claim_id + * description: The ID of the claim this return belongs to, if any. + * claim: + * $ref: "#/components/schemas/OrderClaim" + * display_id: * 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. + * title: display_id + * description: The return order's display ID. + * location_id: + * type: string + * title: location_id + * description: The ID of the stock location the items are returned to. + * no_notification: + * type: boolean + * title: no_notification + * description: Whether to notify the customer about changes in the return. + * created_by: + * type: string + * title: created_by + * description: The ID of the user that created the return. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The date the return was deleted. + * requested_at: + * type: string + * title: requested_at + * description: The date the return was requested. + * format: date-time + * received_at: + * type: string + * title: received_at + * description: The date the return was received. + * format: date-time * */ diff --git a/www/utils/generated/oas-output/schemas/StoreCollection.ts b/www/utils/generated/oas-output/schemas/StoreCollection.ts index 7f29948769..f9ecbabdfe 100644 --- a/www/utils/generated/oas-output/schemas/StoreCollection.ts +++ b/www/utils/generated/oas-output/schemas/StoreCollection.ts @@ -5,11 +5,11 @@ * x-schemaName: StoreCollection * required: * - title - * - metadata * - id - * - handle + * - metadata * - created_at * - updated_at + * - handle * - deleted_at * properties: * id: diff --git a/www/utils/generated/oas-output/schemas/StoreOrder.ts b/www/utils/generated/oas-output/schemas/StoreOrder.ts index 51db87ece2..ecc6796167 100644 --- a/www/utils/generated/oas-output/schemas/StoreOrder.ts +++ b/www/utils/generated/oas-output/schemas/StoreOrder.ts @@ -4,19 +4,17 @@ * description: The order's details. * x-schemaName: StoreOrder * required: + * - items + * - shipping_methods + * - currency_code * - 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 @@ -46,10 +44,6 @@ * 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 @@ -77,24 +71,24 @@ * title: display_id * description: The order's display ID. * shipping_address: - * $ref: "#/components/schemas/BaseOrderAddress" + * $ref: "#/components/schemas/StoreOrderAddress" * billing_address: - * $ref: "#/components/schemas/BaseOrderAddress" + * $ref: "#/components/schemas/StoreOrderAddress" * items: * type: array * description: The order's items. * items: - * $ref: "#/components/schemas/BaseOrderLineItem" + * $ref: "#/components/schemas/StoreOrderLineItem" * shipping_methods: * type: array * description: The order's shipping methods. * items: - * $ref: "#/components/schemas/BaseOrderShippingMethod" + * $ref: "#/components/schemas/StoreOrderShippingMethod" * payment_collections: * type: array * description: The order's payment collections. * items: - * $ref: "#/components/schemas/BasePaymentCollection" + * $ref: "#/components/schemas/StorePaymentCollection" * payment_status: * type: string * description: The order's payment status. @@ -113,7 +107,7 @@ * type: array * description: The order's fulfillments. * items: - * $ref: "#/components/schemas/BaseOrderFulfillment" + * $ref: "#/components/schemas/StoreOrderFulfillment" * fulfillment_status: * type: string * description: The order's fulfillment status. @@ -229,6 +223,13 @@ * type: number * title: original_shipping_tax_total * description: The total taxes of the order's shipping excluding promotions. + * customer: + * $ref: "#/components/schemas/StoreCustomer" + * transactions: + * type: array + * description: The order's transactions. + * items: + * $ref: "#/components/schemas/BaseOrderTransaction" * */ diff --git a/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts b/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts new file mode 100644 index 0000000000..077d8756c7 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreOrderAddress.ts @@ -0,0 +1,78 @@ +/** + * @schema StoreOrderAddress + * type: object + * description: An order address + * x-schemaName: StoreOrderAddress + * required: + * - id + * - metadata + * - created_at + * - updated_at + * properties: + * 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 + * country: + * $ref: "#/components/schemas/StoreRegionCountry" + * 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 new file mode 100644 index 0000000000..8510f339d4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreOrderFulfillment.ts @@ -0,0 +1,81 @@ +/** + * @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 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: The fulfillment's requires shipping. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts new file mode 100644 index 0000000000..a313c9547d --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreOrderLineItem.ts @@ -0,0 +1,4016 @@ +/** + * @schema StoreOrderLineItem + * type: object + * description: The item's details. + * x-schemaName: StoreOrderLineItem + * required: + * - detail + * - 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 + * - 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/StoreProductVariant" + * variant_id: + * type: string + * title: variant_id + * description: The ID of the associated variant. + * product: + * $ref: "#/components/schemas/StoreProduct" + * 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: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: BaseOrderLineItem + * required: + * - id + * - title + * - subtitle + * - thumbnail + * - variant_id + * - product_id + * - product_title + * - product_description + * - product_subtitle + * - product_type + * - product_collection + * - product_handle + * - variant_sku + * - variant_barcode + * - variant_title + * - variant_option_values + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - quantity + * - detail + * - created_at + * - updated_at + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - refundable_total + * - refundable_total_per_unit + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * variant: + * type: object + * description: The item's variant. + * 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. + * upc: + * type: string + * title: upc + * description: The variant's upc. + * 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. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * 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 variant rank. + * options: + * type: array + * description: The variant's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: BaseProductOptionValue + * product: + * type: object + * description: The variant's product. + * x-schemaName: BaseProduct + * product_id: + * type: string + * title: product_id + * description: The variant's product id. + * calculated_price: + * type: object + * description: The variant's calculated price. + * x-schemaName: BaseCalculatedPriceSet + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The variant's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The variant's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The variant's deleted at. + * metadata: + * type: object + * description: The variant's metadata. + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * product: + * type: object + * description: The item's product. + * x-schemaName: BaseProduct + * required: + * - id + * - title + * - handle + * - subtitle + * - description + * - is_giftcard + * - status + * - thumbnail + * - width + * - weight + * - length + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - collection_id + * - type_id + * - variants + * - options + * - images + * - discountable + * - external_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * title: + * type: string + * title: title + * description: The product's title. + * handle: + * type: string + * title: handle + * description: The product's handle. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * description: + * type: string + * title: description + * description: The product's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * status: + * type: string + * description: The product's status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * collection: + * type: object + * description: The product's collection. + * x-schemaName: BaseCollection + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * x-schemaName: BaseProductCategory + * type: + * type: object + * description: The product's type. + * x-schemaName: BaseProduct + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * x-schemaName: BaseProductTag + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * x-schemaName: BaseProductVariant + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: BaseProductOption + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * x-schemaName: BaseProductImage + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * metadata: + * type: object + * description: The product's metadata. + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The tax line's item id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The adjustment's item id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * detail: + * 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: item_id + * description: The detail's item id. + * item: + * type: object + * description: The detail's item. + * x-schemaName: BaseOrderLineItem + * quantity: + * type: number + * title: quantity + * description: The detail's quantity. + * fulfilled_quantity: + * type: number + * title: fulfilled_quantity + * description: The detail's fulfilled quantity. + * delivered_quantity: + * type: number + * title: delivered_quantity + * description: The detail's delivered quantity. + * shipped_quantity: + * type: number + * title: shipped_quantity + * description: The detail's shipped quantity. + * return_requested_quantity: + * type: number + * title: return_requested_quantity + * description: The detail's return requested quantity. + * return_received_quantity: + * type: number + * title: return_received_quantity + * description: The detail's return received quantity. + * return_dismissed_quantity: + * type: number + * title: return_dismissed_quantity + * description: The detail's return dismissed quantity. + * written_off_quantity: + * type: number + * title: written_off_quantity + * description: The detail's written off quantity. + * metadata: + * type: object + * description: The detail's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * 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: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * item_id: + * type: string + * title: item_id + * description: The tax line's item id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - item + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: StoreOrderLineItem + * required: + * - detail + * - 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 + * - refundable_total + * - refundable_total_per_unit + * properties: + * variant: + * type: object + * description: The item's variant. + * x-schemaName: StoreProductVariant + * required: + * - options + * - length + * - title + * - id + * - created_at + * - updated_at + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - deleted_at + * - sku + * - barcode + * - ean + * - upc + * - allow_backorder + * - manage_inventory + * properties: + * options: + * type: array + * description: The variant's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: StoreProductOptionValue + * product: + * type: object + * description: The variant's product. + * x-schemaName: StoreProduct + * length: + * type: number + * title: length + * description: The variant's length. + * title: + * type: string + * title: title + * description: The variant's title. + * id: + * type: string + * title: id + * description: The variant's ID. + * metadata: + * type: object + * description: The variant's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The variant's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The variant's updated at. + * product_id: + * type: string + * title: product_id + * description: The variant's product 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. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The variant's deleted at. + * 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: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * calculated_price: + * type: object + * description: The variant's calculated price. + * x-schemaName: BaseCalculatedPriceSet + * product: + * type: object + * description: The item's product. + * x-schemaName: StoreProduct + * required: + * - variants + * - options + * - images + * - length + * - title + * - status + * - description + * - id + * - created_at + * - updated_at + * - subtitle + * - thumbnail + * - handle + * - is_giftcard + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - collection_id + * - type_id + * - discountable + * - external_id + * - deleted_at + * properties: + * collection: + * type: object + * description: The product's collection. + * x-schemaName: StoreCollection + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * x-schemaName: StoreProductCategory + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * x-schemaName: StoreProductVariant + * type: + * type: object + * description: The product's type. + * x-schemaName: StoreProduct + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * x-schemaName: StoreProductTag + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: StoreProductOption + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * x-schemaName: StoreProductImage + * length: + * type: number + * title: length + * description: The product's length. + * title: + * type: string + * title: title + * description: The product's title. + * status: + * type: string + * description: The product's status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * description: + * type: string + * title: description + * description: The product's description. + * id: + * type: string + * title: id + * description: The product's ID. + * metadata: + * type: object + * description: The product's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * handle: + * type: string + * title: handle + * description: The product's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The tax line's item id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - item + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: StoreOrderLineItem + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The adjustment's item id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - item + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: StoreOrderLineItem + * detail: + * allOf: + * - 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: item_id + * description: The detail's item id. + * item: + * type: object + * description: The detail's item. + * x-schemaName: BaseOrderLineItem + * quantity: + * type: number + * title: quantity + * description: The detail's quantity. + * fulfilled_quantity: + * type: number + * title: fulfilled_quantity + * description: The detail's fulfilled quantity. + * delivered_quantity: + * type: number + * title: delivered_quantity + * description: The detail's delivered quantity. + * shipped_quantity: + * type: number + * title: shipped_quantity + * description: The detail's shipped quantity. + * return_requested_quantity: + * type: number + * title: return_requested_quantity + * description: The detail's return requested quantity. + * return_received_quantity: + * type: number + * title: return_received_quantity + * description: The detail's return received quantity. + * return_dismissed_quantity: + * type: number + * title: return_dismissed_quantity + * description: The detail's return dismissed quantity. + * written_off_quantity: + * type: number + * title: written_off_quantity + * description: The detail's written off quantity. + * metadata: + * type: object + * description: The detail's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * - type: object + * description: The item's detail. + * required: + * - item + * properties: + * item: + * type: object + * description: The detail's item. + * x-schemaName: StoreOrderLineItem + * 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. + * 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. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * original_total: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * 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. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * description: The tax line's tax lines. + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: BaseOrderLineItem + * required: + * - id + * - title + * - subtitle + * - thumbnail + * - variant_id + * - product_id + * - product_title + * - product_description + * - product_subtitle + * - product_type + * - product_collection + * - product_handle + * - variant_sku + * - variant_barcode + * - variant_title + * - variant_option_values + * - requires_shipping + * - is_discountable + * - is_tax_inclusive + * - unit_price + * - quantity + * - detail + * - created_at + * - updated_at + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - item_total + * - item_subtotal + * - item_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - refundable_total + * - refundable_total_per_unit + * properties: + * id: + * type: string + * title: id + * description: The item's ID. + * title: + * type: string + * title: title + * description: The item's title. + * subtitle: + * type: string + * title: subtitle + * description: The item's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The item's thumbnail. + * variant: + * type: object + * description: The item's variant. + * 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. + * upc: + * type: string + * title: upc + * description: The variant's upc. + * 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. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * 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 variant rank. + * options: + * type: array + * description: The variant's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: BaseProductOptionValue + * product: + * type: object + * description: The variant's product. + * x-schemaName: BaseProduct + * product_id: + * type: string + * title: product_id + * description: The variant's product id. + * calculated_price: + * type: object + * description: The variant's calculated price. + * x-schemaName: BaseCalculatedPriceSet + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The variant's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The variant's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The variant's deleted at. + * metadata: + * type: object + * description: The variant's metadata. + * variant_id: + * type: string + * title: variant_id + * description: The item's variant id. + * product: + * type: object + * description: The item's product. + * x-schemaName: BaseProduct + * required: + * - id + * - title + * - handle + * - subtitle + * - description + * - is_giftcard + * - status + * - thumbnail + * - width + * - weight + * - length + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - collection_id + * - type_id + * - variants + * - options + * - images + * - discountable + * - external_id + * - created_at + * - updated_at + * - deleted_at + * properties: + * id: + * type: string + * title: id + * description: The product's ID. + * title: + * type: string + * title: title + * description: The product's title. + * handle: + * type: string + * title: handle + * description: The product's handle. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * description: + * type: string + * title: description + * description: The product's description. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * status: + * type: string + * description: The product's status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * length: + * type: number + * title: length + * description: The product's length. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * collection: + * type: object + * description: The product's collection. + * x-schemaName: BaseCollection + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * x-schemaName: BaseProductCategory + * type: + * type: object + * description: The product's type. + * x-schemaName: BaseProduct + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * x-schemaName: BaseProductTag + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * x-schemaName: BaseProductVariant + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: BaseProductOption + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * x-schemaName: BaseProductImage + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * metadata: + * type: object + * description: The product's metadata. + * product_id: + * type: string + * title: product_id + * description: The item's product id. + * product_title: + * type: string + * title: product_title + * description: The item's product title. + * product_description: + * type: string + * title: product_description + * description: The item's product description. + * product_subtitle: + * type: string + * title: product_subtitle + * description: The item's product subtitle. + * product_type: + * type: string + * title: product_type + * description: The item's product type. + * product_collection: + * type: string + * title: product_collection + * description: The item's product collection. + * product_handle: + * type: string + * title: product_handle + * description: The item's product handle. + * variant_sku: + * type: string + * title: variant_sku + * description: The item's variant sku. + * variant_barcode: + * type: string + * title: variant_barcode + * description: The item's variant barcode. + * variant_title: + * type: string + * title: variant_title + * description: The item's variant title. + * variant_option_values: + * type: object + * description: The item's variant option values. + * requires_shipping: + * type: boolean + * title: requires_shipping + * description: The item's requires shipping. + * is_discountable: + * type: boolean + * title: is_discountable + * description: The item's is discountable. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The item's is tax inclusive. + * compare_at_unit_price: + * type: number + * title: compare_at_unit_price + * description: The item's compare at unit price. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The tax line's item id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The adjustment's item id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * detail: + * 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: item_id + * description: The detail's item id. + * item: + * type: object + * description: The detail's item. + * x-schemaName: BaseOrderLineItem + * quantity: + * type: number + * title: quantity + * description: The detail's quantity. + * fulfilled_quantity: + * type: number + * title: fulfilled_quantity + * description: The detail's fulfilled quantity. + * delivered_quantity: + * type: number + * title: delivered_quantity + * description: The detail's delivered quantity. + * shipped_quantity: + * type: number + * title: shipped_quantity + * description: The detail's shipped quantity. + * return_requested_quantity: + * type: number + * title: return_requested_quantity + * description: The detail's return requested quantity. + * return_received_quantity: + * type: number + * title: return_received_quantity + * description: The detail's return received quantity. + * return_dismissed_quantity: + * type: number + * title: return_dismissed_quantity + * description: The detail's return dismissed quantity. + * written_off_quantity: + * type: number + * title: written_off_quantity + * description: The detail's written off quantity. + * metadata: + * type: object + * description: The detail's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * 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: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * item_id: + * type: string + * title: item_id + * description: The adjustment's item id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - item + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: StoreOrderLineItem + * required: + * - detail + * - 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 + * - refundable_total + * - refundable_total_per_unit + * properties: + * variant: + * type: object + * description: The item's variant. + * x-schemaName: StoreProductVariant + * required: + * - options + * - length + * - title + * - id + * - created_at + * - updated_at + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - deleted_at + * - sku + * - barcode + * - ean + * - upc + * - allow_backorder + * - manage_inventory + * properties: + * options: + * type: array + * description: The variant's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: StoreProductOptionValue + * product: + * type: object + * description: The variant's product. + * x-schemaName: StoreProduct + * length: + * type: number + * title: length + * description: The variant's length. + * title: + * type: string + * title: title + * description: The variant's title. + * id: + * type: string + * title: id + * description: The variant's ID. + * metadata: + * type: object + * description: The variant's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The variant's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The variant's updated at. + * product_id: + * type: string + * title: product_id + * description: The variant's product 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. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The variant's deleted at. + * 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: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * calculated_price: + * type: object + * description: The variant's calculated price. + * x-schemaName: BaseCalculatedPriceSet + * product: + * type: object + * description: The item's product. + * x-schemaName: StoreProduct + * required: + * - variants + * - options + * - images + * - length + * - title + * - status + * - description + * - id + * - created_at + * - updated_at + * - subtitle + * - thumbnail + * - handle + * - is_giftcard + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - collection_id + * - type_id + * - discountable + * - external_id + * - deleted_at + * properties: + * collection: + * type: object + * description: The product's collection. + * x-schemaName: StoreCollection + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * x-schemaName: StoreProductCategory + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * x-schemaName: StoreProductVariant + * type: + * type: object + * description: The product's type. + * x-schemaName: StoreProduct + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * x-schemaName: StoreProductTag + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: StoreProductOption + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * x-schemaName: StoreProductImage + * length: + * type: number + * title: length + * description: The product's length. + * title: + * type: string + * title: title + * description: The product's title. + * status: + * type: string + * description: The product's status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * description: + * type: string + * title: description + * description: The product's description. + * id: + * type: string + * title: id + * description: The product's ID. + * metadata: + * type: object + * description: The product's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * handle: + * type: string + * title: handle + * description: The product's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The tax line's item id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - item + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: StoreOrderLineItem + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The adjustment's item id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - item + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: StoreOrderLineItem + * detail: + * allOf: + * - 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: item_id + * description: The detail's item id. + * item: + * type: object + * description: The detail's item. + * x-schemaName: BaseOrderLineItem + * quantity: + * type: number + * title: quantity + * description: The detail's quantity. + * fulfilled_quantity: + * type: number + * title: fulfilled_quantity + * description: The detail's fulfilled quantity. + * delivered_quantity: + * type: number + * title: delivered_quantity + * description: The detail's delivered quantity. + * shipped_quantity: + * type: number + * title: shipped_quantity + * description: The detail's shipped quantity. + * return_requested_quantity: + * type: number + * title: return_requested_quantity + * description: The detail's return requested quantity. + * return_received_quantity: + * type: number + * title: return_received_quantity + * description: The detail's return received quantity. + * return_dismissed_quantity: + * type: number + * title: return_dismissed_quantity + * description: The detail's return dismissed quantity. + * written_off_quantity: + * type: number + * title: written_off_quantity + * description: The detail's written off quantity. + * metadata: + * type: object + * description: The detail's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * - type: object + * description: The item's detail. + * required: + * - item + * properties: + * item: + * type: object + * description: The detail's item. + * x-schemaName: StoreOrderLineItem + * 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. + * 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. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * original_total: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * 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. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * description: The adjustment's details. + * detail: + * allOf: + * - $ref: "#/components/schemas/BaseOrderItemDetail" + * - type: object + * description: The item's detail. + * required: + * - item + * properties: + * item: + * type: object + * description: The detail's item. + * x-schemaName: StoreOrderLineItem + * required: + * - detail + * - 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 + * - refundable_total + * - refundable_total_per_unit + * properties: + * variant: + * type: object + * description: The item's variant. + * x-schemaName: StoreProductVariant + * required: + * - options + * - length + * - title + * - id + * - created_at + * - updated_at + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - deleted_at + * - sku + * - barcode + * - ean + * - upc + * - allow_backorder + * - manage_inventory + * properties: + * options: + * type: array + * description: The variant's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: StoreProductOptionValue + * product: + * type: object + * description: The variant's product. + * x-schemaName: StoreProduct + * length: + * type: number + * title: length + * description: The variant's length. + * title: + * type: string + * title: title + * description: The variant's title. + * id: + * type: string + * title: id + * description: The variant's ID. + * metadata: + * type: object + * description: The variant's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The variant's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The variant's updated at. + * product_id: + * type: string + * title: product_id + * description: The variant's product 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. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The variant's deleted at. + * 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: The variant's allow backorder. + * manage_inventory: + * type: boolean + * title: manage_inventory + * description: The variant's manage inventory. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The variant's inventory quantity. + * variant_rank: + * type: number + * title: variant_rank + * description: The variant's variant rank. + * calculated_price: + * type: object + * description: The variant's calculated price. + * x-schemaName: BaseCalculatedPriceSet + * product: + * type: object + * description: The item's product. + * x-schemaName: StoreProduct + * required: + * - variants + * - options + * - images + * - length + * - title + * - status + * - description + * - id + * - created_at + * - updated_at + * - subtitle + * - thumbnail + * - handle + * - is_giftcard + * - width + * - weight + * - height + * - origin_country + * - hs_code + * - mid_code + * - material + * - collection_id + * - type_id + * - discountable + * - external_id + * - deleted_at + * properties: + * collection: + * type: object + * description: The product's collection. + * x-schemaName: StoreCollection + * categories: + * type: array + * description: The product's categories. + * items: + * type: object + * description: The category's categories. + * x-schemaName: StoreProductCategory + * variants: + * type: array + * description: The product's variants. + * items: + * type: object + * description: The variant's variants. + * x-schemaName: StoreProductVariant + * type: + * type: object + * description: The product's type. + * x-schemaName: StoreProduct + * tags: + * type: array + * description: The product's tags. + * items: + * type: object + * description: The tag's tags. + * x-schemaName: StoreProductTag + * options: + * type: array + * description: The product's options. + * items: + * type: object + * description: The option's options. + * x-schemaName: StoreProductOption + * images: + * type: array + * description: The product's images. + * items: + * type: object + * description: The image's images. + * x-schemaName: StoreProductImage + * length: + * type: number + * title: length + * description: The product's length. + * title: + * type: string + * title: title + * description: The product's title. + * status: + * type: string + * description: The product's status. + * enum: + * - draft + * - proposed + * - published + * - rejected + * description: + * type: string + * title: description + * description: The product's description. + * id: + * type: string + * title: id + * description: The product's ID. + * metadata: + * type: object + * description: The product's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The product's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The product's updated at. + * subtitle: + * type: string + * title: subtitle + * description: The product's subtitle. + * thumbnail: + * type: string + * title: thumbnail + * description: The product's thumbnail. + * handle: + * type: string + * title: handle + * description: The product's handle. + * is_giftcard: + * type: boolean + * title: is_giftcard + * description: The product's is giftcard. + * width: + * type: number + * title: width + * description: The product's width. + * weight: + * type: number + * title: weight + * description: The product's weight. + * height: + * type: number + * title: height + * description: The product's height. + * origin_country: + * type: string + * title: origin_country + * description: The product's origin country. + * hs_code: + * type: string + * title: hs_code + * description: The product's hs code. + * mid_code: + * type: string + * title: mid_code + * description: The product's mid code. + * material: + * type: string + * title: material + * description: The product's material. + * collection_id: + * type: string + * title: collection_id + * description: The product's collection id. + * type_id: + * type: string + * title: type_id + * description: The product's type id. + * discountable: + * type: boolean + * title: discountable + * description: The product's discountable. + * external_id: + * type: string + * title: external_id + * description: The product's external id. + * deleted_at: + * type: string + * format: date-time + * title: deleted_at + * description: The product's deleted at. + * tax_lines: + * type: array + * description: The item's tax lines. + * items: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderLineItemTaxLine + * required: + * - item + * - item_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The tax line's item id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - item + * properties: + * item: + * type: object + * description: The tax line's item. + * x-schemaName: StoreOrderLineItem + * adjustments: + * type: array + * description: The item's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderLineItemAdjustment + * required: + * - item + * - item_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: BaseOrderLineItem + * item_id: + * type: string + * title: item_id + * description: The adjustment's item id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - item + * properties: + * item: + * type: object + * description: The adjustment's item. + * x-schemaName: StoreOrderLineItem + * detail: + * allOf: + * - 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: item_id + * description: The detail's item id. + * item: + * type: object + * description: The detail's item. + * x-schemaName: BaseOrderLineItem + * quantity: + * type: number + * title: quantity + * description: The detail's quantity. + * fulfilled_quantity: + * type: number + * title: fulfilled_quantity + * description: The detail's fulfilled quantity. + * delivered_quantity: + * type: number + * title: delivered_quantity + * description: The detail's delivered quantity. + * shipped_quantity: + * type: number + * title: shipped_quantity + * description: The detail's shipped quantity. + * return_requested_quantity: + * type: number + * title: return_requested_quantity + * description: The detail's return requested quantity. + * return_received_quantity: + * type: number + * title: return_received_quantity + * description: The detail's return received quantity. + * return_dismissed_quantity: + * type: number + * title: return_dismissed_quantity + * description: The detail's return dismissed quantity. + * written_off_quantity: + * type: number + * title: written_off_quantity + * description: The detail's written off quantity. + * metadata: + * type: object + * description: The detail's metadata. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * - type: object + * description: The item's detail. + * required: + * - item + * properties: + * item: + * type: object + * description: The detail's item. + * x-schemaName: StoreOrderLineItem + * 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. + * 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. + * item_total: + * type: number + * title: item_total + * description: The item's item total. + * item_subtotal: + * type: number + * title: item_subtotal + * description: The item's item subtotal. + * item_tax_total: + * type: number + * title: item_tax_total + * description: The item's item tax total. + * original_total: + * type: number + * title: original_total + * description: The item's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The item's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The item's original tax total. + * total: + * type: number + * title: total + * description: The item's total. + * subtotal: + * type: number + * title: subtotal + * description: The item's subtotal. + * tax_total: + * type: number + * title: tax_total + * description: The item's tax total. + * discount_total: + * type: number + * title: discount_total + * description: The item's discount total. + * discount_tax_total: + * type: number + * title: discount_tax_total + * description: The item's discount tax total. + * 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. + * unit_price: + * type: number + * title: unit_price + * description: The item's unit price. + * quantity: + * type: number + * title: quantity + * description: The item's quantity. + * refundable_total: + * type: number + * title: refundable_total + * description: The item's refundable total. + * refundable_total_per_unit: + * type: number + * title: refundable_total_per_unit + * description: The item's refundable total per unit. + * description: The item's detail. + * 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/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts b/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts new file mode 100644 index 0000000000..f19c7136b4 --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreOrderShippingMethod.ts @@ -0,0 +1,1716 @@ +/** + * @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 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: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: BaseOrderShippingMethod + * required: + * - id + * - order_id + * - name + * - amount + * - is_tax_inclusive + * - shipping_option_id + * - data + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The tax line's shipping method id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The adjustment's shipping method id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * original_total: + * type: number + * title: original_total + * description: The shipping method's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * total: + * type: number + * title: total + * description: The shipping method's total. + * detail: + * type: object + * description: The shipping method's detail. + * x-schemaName: BaseOrderShippingDetail + * required: + * - id + * - shipping_method_id + * - shipping_method + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The detail's ID. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The detail's shipping method id. + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: BaseOrderShippingMethod + * claim_id: + * type: string + * title: claim_id + * description: The detail's claim id. + * exchange_id: + * type: string + * title: exchange_id + * description: The detail's exchange id. + * return_id: + * type: string + * title: return_id + * description: The detail's return id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * 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 shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The tax line's shipping method id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * 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: + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The tax line's shipping method id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: StoreOrderShippingMethod + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The adjustment's shipping method id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: StoreOrderShippingMethod + * detail: + * allOf: + * - type: object + * description: The shipping method's detail. + * x-schemaName: BaseOrderShippingDetail + * required: + * - id + * - shipping_method_id + * - shipping_method + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The detail's ID. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The detail's shipping method id. + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: BaseOrderShippingMethod + * claim_id: + * type: string + * title: claim_id + * description: The detail's claim id. + * exchange_id: + * type: string + * title: exchange_id + * description: The detail's exchange id. + * return_id: + * type: string + * title: return_id + * description: The detail's return id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * - type: object + * description: The shipping method's detail. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: StoreOrderShippingMethod + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * original_total: + * type: number + * title: original_total + * description: The shipping method's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * total: + * type: number + * title: total + * description: The shipping method's total. + * 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 shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * description: The tax line's details. + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: BaseOrderShippingMethod + * required: + * - id + * - order_id + * - name + * - amount + * - is_tax_inclusive + * - shipping_option_id + * - data + * - metadata + * - original_total + * - original_subtotal + * - original_tax_total + * - total + * - subtotal + * - tax_total + * - discount_total + * - discount_tax_total + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The tax line's shipping method id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The adjustment's shipping method id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * original_total: + * type: number + * title: original_total + * description: The shipping method's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * total: + * type: number + * title: total + * description: The shipping method's total. + * detail: + * type: object + * description: The shipping method's detail. + * x-schemaName: BaseOrderShippingDetail + * required: + * - id + * - shipping_method_id + * - shipping_method + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The detail's ID. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The detail's shipping method id. + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: BaseOrderShippingMethod + * claim_id: + * type: string + * title: claim_id + * description: The detail's claim id. + * exchange_id: + * type: string + * title: exchange_id + * description: The detail's exchange id. + * return_id: + * type: string + * title: return_id + * description: The detail's return id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * 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 shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The adjustment's shipping method id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * 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: + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The tax line's shipping method id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: StoreOrderShippingMethod + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The adjustment's shipping method id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: StoreOrderShippingMethod + * detail: + * allOf: + * - type: object + * description: The shipping method's detail. + * x-schemaName: BaseOrderShippingDetail + * required: + * - id + * - shipping_method_id + * - shipping_method + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The detail's ID. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The detail's shipping method id. + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: BaseOrderShippingMethod + * claim_id: + * type: string + * title: claim_id + * description: The detail's claim id. + * exchange_id: + * type: string + * title: exchange_id + * description: The detail's exchange id. + * return_id: + * type: string + * title: return_id + * description: The detail's return id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * - type: object + * description: The shipping method's detail. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: StoreOrderShippingMethod + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * original_total: + * type: number + * title: original_total + * description: The shipping method's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * total: + * type: number + * title: total + * description: The shipping method's total. + * 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 shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * description: The adjustment's adjustments. + * 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: + * allOf: + * - $ref: "#/components/schemas/BaseOrderShippingDetail" + * - type: object + * description: The shipping method's detail. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The detail's shipping method. + * 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: + * tax_lines: + * type: array + * description: The shipping method's tax lines. + * items: + * allOf: + * - type: object + * description: The tax line's tax lines. + * x-schemaName: BaseOrderShippingMethodTaxLine + * required: + * - shipping_method + * - shipping_method_id + * - total + * - subtotal + * - id + * - code + * - rate + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The tax line's shipping method id. + * total: + * type: number + * title: total + * description: The tax line's total. + * subtotal: + * type: number + * title: subtotal + * description: The tax line's 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 tax line's tax rate id. + * code: + * type: string + * title: code + * description: The tax line's code. + * rate: + * type: number + * title: rate + * description: The tax line's rate. + * provider_id: + * type: string + * title: provider_id + * description: The tax line's provider id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The tax line's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The tax line's updated at. + * - type: object + * description: The tax line's tax lines. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The tax line's shipping method. + * x-schemaName: StoreOrderShippingMethod + * adjustments: + * type: array + * description: The shipping method's adjustments. + * items: + * allOf: + * - type: object + * description: The adjustment's adjustments. + * x-schemaName: BaseOrderShippingMethodAdjustment + * required: + * - shipping_method + * - shipping_method_id + * - id + * - amount + * - order_id + * - created_at + * - updated_at + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: BaseOrderShippingMethod + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The adjustment's shipping method id. + * 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 adjustment's order id. + * description: + * type: string + * title: description + * description: The adjustment's description. + * promotion_id: + * type: string + * title: promotion_id + * description: The adjustment's promotion id. + * 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 adjustment's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The adjustment's updated at. + * - type: object + * description: The adjustment's adjustments. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The adjustment's shipping method. + * x-schemaName: StoreOrderShippingMethod + * detail: + * allOf: + * - type: object + * description: The shipping method's detail. + * x-schemaName: BaseOrderShippingDetail + * required: + * - id + * - shipping_method_id + * - shipping_method + * - created_at + * - updated_at + * properties: + * id: + * type: string + * title: id + * description: The detail's ID. + * shipping_method_id: + * type: string + * title: shipping_method_id + * description: The detail's shipping method id. + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: BaseOrderShippingMethod + * claim_id: + * type: string + * title: claim_id + * description: The detail's claim id. + * exchange_id: + * type: string + * title: exchange_id + * description: The detail's exchange id. + * return_id: + * type: string + * title: return_id + * description: The detail's return id. + * created_at: + * type: string + * format: date-time + * title: created_at + * description: The detail's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The detail's updated at. + * - type: object + * description: The shipping method's detail. + * required: + * - shipping_method + * properties: + * shipping_method: + * type: object + * description: The detail's shipping method. + * x-schemaName: StoreOrderShippingMethod + * id: + * type: string + * title: id + * description: The shipping method's ID. + * order_id: + * type: string + * title: order_id + * description: The shipping method's order id. + * name: + * type: string + * title: name + * description: The shipping method's name. + * description: + * type: string + * title: description + * description: The shipping method's description. + * amount: + * type: number + * title: amount + * description: The shipping method's amount. + * is_tax_inclusive: + * type: boolean + * title: is_tax_inclusive + * description: The shipping method's is tax inclusive. + * shipping_option_id: + * type: string + * title: shipping_option_id + * description: The shipping method's shipping option id. + * data: + * type: object + * description: The shipping method's data. + * metadata: + * type: object + * description: The shipping method's metadata. + * original_total: + * type: number + * title: original_total + * description: The shipping method's original total. + * original_subtotal: + * type: number + * title: original_subtotal + * description: The shipping method's original subtotal. + * original_tax_total: + * type: number + * title: original_tax_total + * description: The shipping method's original tax total. + * total: + * type: number + * title: total + * description: The shipping method's total. + * 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 shipping method's created at. + * updated_at: + * type: string + * format: date-time + * title: updated_at + * description: The shipping method's updated at. + * description: Details of changes to a shipping method. + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/StoreProduct.ts b/www/utils/generated/oas-output/schemas/StoreProduct.ts index 36aedfd18b..5dbf2e186c 100644 --- a/www/utils/generated/oas-output/schemas/StoreProduct.ts +++ b/www/utils/generated/oas-output/schemas/StoreProduct.ts @@ -12,10 +12,12 @@ * - status * - description * - id - * - handle + * - created_at + * - updated_at * - subtitle - * - is_giftcard * - thumbnail + * - handle + * - is_giftcard * - width * - weight * - height @@ -27,8 +29,6 @@ * - type_id * - discountable * - external_id - * - created_at - * - updated_at * - deleted_at * properties: * categories: diff --git a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts index d639c24d3e..282122b37d 100644 --- a/www/utils/generated/oas-output/schemas/StoreProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/StoreProductVariant.ts @@ -118,6 +118,8 @@ * - length * - title * - id + * - created_at + * - updated_at * - width * - weight * - height @@ -125,8 +127,6 @@ * - hs_code * - mid_code * - material - * - created_at - * - updated_at * - deleted_at * - sku * - barcode diff --git a/www/utils/generated/oas-output/schemas/StoreRegionCountry.ts b/www/utils/generated/oas-output/schemas/StoreRegionCountry.ts new file mode 100644 index 0000000000..6208b8ea4f --- /dev/null +++ b/www/utils/generated/oas-output/schemas/StoreRegionCountry.ts @@ -0,0 +1,38 @@ +/** + * @schema 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. + * 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/utils/generated/oas-output/schemas/StoreReturn.ts b/www/utils/generated/oas-output/schemas/StoreReturn.ts index d892f6a398..3f1440b8cc 100644 --- a/www/utils/generated/oas-output/schemas/StoreReturn.ts +++ b/www/utils/generated/oas-output/schemas/StoreReturn.ts @@ -5,10 +5,10 @@ * x-schemaName: StoreReturn * required: * - items - * - order_id * - id - * - created_at * - display_id + * - created_at + * - order_id * - canceled_at * - received_at * properties: