From cf3c25addf96e4bd832c71d72e3bab141adf67ed Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 6 Sep 2024 12:25:48 +0000 Subject: [PATCH] chore(docs): Updated API Reference (v2) (#9033) Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com> --- .../schemas/AdminCreateCollection.yaml | 1 - .../schemas/AdminCreateCustomerGroup.yaml | 1 - .../schemas/AdminCreateFulfillment.yaml | 19 - .../schemas/AdminCreatePriceList.yaml | 4 - .../schemas/AdminCreateShippingProfile.yaml | 2 +- .../schemas/AdminLinkPriceListProducts.yaml | 11 + .../components/schemas/AdminOrderPreview.yaml | 10 +- .../AdminPostClaimsItemsActionReqSchema.yaml | 2 - ...dminPostClaimsShippingActionReqSchema.yaml | 6 +- .../AdminPostClaimsShippingReqSchema.yaml | 6 +- ...nPostExchangesShippingActionReqSchema.yaml | 6 +- .../AdminPostExchangesShippingReqSchema.yaml | 6 +- .../AdminPostOrderClaimsReqSchema.yaml | 2 - .../schemas/AdminPostOrderEditsReqSchema.yaml | 1 - ...PostOrderEditsShippingActionReqSchema.yaml | 6 +- .../AdminPostOrderEditsShippingReqSchema.yaml | 6 +- .../AdminPostOrderExchangesReqSchema.yaml | 1 - .../AdminPostReceiveReturnsReqSchema.yaml | 2 - .../schemas/AdminPostReturnsReqSchema.yaml | 1 - .../AdminPostReturnsReturnReqSchema.yaml | 2 - ...minPostReturnsShippingActionReqSchema.yaml | 6 +- .../AdminPostReturnsShippingReqSchema.yaml | 6 +- .../schemas/AdminProductVariant.yaml | 4 + .../schemas/AdminUpdateCollection.yaml | 2 - .../schemas/AdminUpdateCustomerGroup.yaml | 2 - .../schemas/AdminUpdatePriceList.yaml | 4 - .../schemas/AdminUpdateSalesChannel.yaml | 3 - .../schemas/AdminUpdateStockLocation.yaml | 9 - .../components/schemas/AdminUpdateStore.yaml | 5 - .../schemas/AdminUpdateTaxRate.yaml | 3 - .../components/schemas/AdminUpdateUser.yaml | 4 - .../components/schemas/OrderPreview.yaml | 29 +- .../schemas/StoreAddCartLineItem.yaml | 1 - .../schemas/StoreUpdateCartLineItem.yaml | 1 - .../schemas/StoreUpdateCustomer.yaml | 5 - .../specs/admin/openapi.full.yaml | 6988 +++-------------- .../specs/admin/paths/admin_api-keys.yaml | 10 +- .../admin/paths/admin_api-keys_{id}.yaml | 64 +- .../paths/admin_api-keys_{id}_revoke.yaml | 38 +- .../admin_api-keys_{id}_sales-channels.yaml | 48 +- .../specs/admin/paths/admin_campaigns.yaml | 62 +- .../admin/paths/admin_campaigns_{id}.yaml | 76 +- .../admin_campaigns_{id}_promotions.yaml | 46 +- .../specs/admin/paths/admin_claims.yaml | 35 +- .../specs/admin/paths/admin_claims_{id}.yaml | 29 - .../admin/paths/admin_claims_{id}_cancel.yaml | 4 +- .../paths/admin_claims_{id}_claim-items.yaml | 36 +- ...n_claims_{id}_claim-items_{action_id}.yaml | 71 +- .../admin_claims_{id}_inbound_items.yaml | 7 +- ...claims_{id}_inbound_items_{action_id}.yaml | 69 +- ...n_claims_{id}_inbound_shipping-method.yaml | 7 +- ...}_inbound_shipping-method_{action_id}.yaml | 43 +- .../admin_claims_{id}_outbound_items.yaml | 36 +- ...laims_{id}_outbound_items_{action_id}.yaml | 72 +- ..._claims_{id}_outbound_shipping-method.yaml | 36 +- ..._outbound_shipping-method_{action_id}.yaml | 72 +- .../paths/admin_claims_{id}_request.yaml | 34 +- .../specs/admin/paths/admin_collections.yaml | 29 - .../admin/paths/admin_collections_{id}.yaml | 58 - .../admin_collections_{id}_products.yaml | 46 +- .../admin/paths/admin_currencies_{code}.yaml | 29 - .../admin/paths/admin_customer-groups.yaml | 29 - .../paths/admin_customer-groups_{id}.yaml | 58 - .../admin_customer-groups_{id}_customers.yaml | 44 +- .../specs/admin/paths/admin_customers.yaml | 39 +- .../admin/paths/admin_customers_{id}.yaml | 64 +- .../paths/admin_customers_{id}_addresses.yaml | 72 +- ...customers_{id}_addresses_{address_id}.yaml | 130 +- .../specs/admin/paths/admin_draft-orders.yaml | 246 +- .../specs/admin/paths/admin_exchanges.yaml | 33 +- .../admin/paths/admin_exchanges_{id}.yaml | 29 - .../paths/admin_exchanges_{id}_cancel.yaml | 4 +- .../admin_exchanges_{id}_inbound_items.yaml | 7 +- ...hanges_{id}_inbound_items_{action_id}.yaml | 43 +- ...xchanges_{id}_inbound_shipping-method.yaml | 7 +- ...}_inbound_shipping-method_{action_id}.yaml | 43 +- .../admin_exchanges_{id}_outbound_items.yaml | 35 +- ...anges_{id}_outbound_items_{action_id}.yaml | 72 +- ...changes_{id}_outbound_shipping-method.yaml | 36 +- ..._outbound_shipping-method_{action_id}.yaml | 72 +- .../paths/admin_exchanges_{id}_request.yaml | 33 +- ...n_fulfillment-sets_{id}_service-zones.yaml | 54 +- ...ent-sets_{id}_service-zones_{zone_id}.yaml | 95 +- .../specs/admin/paths/admin_fulfillments.yaml | 31 +- .../paths/admin_fulfillments_{id}_cancel.yaml | 38 +- .../admin_fulfillments_{id}_shipment.yaml | 36 +- .../admin/paths/admin_inventory-items.yaml | 31 +- .../paths/admin_inventory-items_{id}.yaml | 95 +- ..._inventory-items_{id}_location-levels.yaml | 42 +- ...tory-items_{id}_location-levels_batch.yaml | 31 +- ...ms_{id}_location-levels_{location_id}.yaml | 73 +- .../specs/admin/paths/admin_invites.yaml | 35 +- .../admin/paths/admin_invites_accept.yaml | 84 +- .../specs/admin/paths/admin_invites_{id}.yaml | 29 - .../paths/admin_invites_{id}_resend.yaml | 33 +- .../admin/paths/admin_notifications_{id}.yaml | 29 - .../specs/admin/paths/admin_order-edits.yaml | 3 +- .../paths/admin_order-edits_{id}_confirm.yaml | 8 +- .../paths/admin_order-edits_{id}_items.yaml | 3 +- ...order-edits_{id}_items_item_{item_id}.yaml | 5 +- ...in_order-edits_{id}_items_{action_id}.yaml | 14 +- .../paths/admin_order-edits_{id}_request.yaml | 8 +- ...dmin_order-edits_{id}_shipping-method.yaml | 7 +- ...dits_{id}_shipping-method_{action_id}.yaml | 14 +- .../specs/admin/paths/admin_orders.yaml | 150 +- .../specs/admin/paths/admin_orders_{id}.yaml | 62 +- .../paths/admin_orders_{id}_archive.yaml | 33 +- .../admin/paths/admin_orders_{id}_cancel.yaml | 41 +- .../paths/admin_orders_{id}_changes.yaml | 29 - .../paths/admin_orders_{id}_complete.yaml | 64 +- .../paths/admin_orders_{id}_fulfillments.yaml | 59 +- ..._fulfillments_{fulfillment_id}_cancel.yaml | 45 +- ...lfillments_{fulfillment_id}_shipments.yaml | 58 +- .../paths/admin_payment-collections.yaml | 35 +- ...payment-collections_{id}_mark-as-paid.yaml | 40 +- .../admin/paths/admin_payments_{id}.yaml | 29 - .../paths/admin_payments_{id}_capture.yaml | 39 +- .../paths/admin_payments_{id}_refund.yaml | 43 +- .../specs/admin/paths/admin_price-lists.yaml | 29 - .../admin/paths/admin_price-lists_{id}.yaml | 58 - .../admin_price-lists_{id}_prices_batch.yaml | 63 +- .../admin_price-lists_{id}_products.yaml | 51 +- .../admin/paths/admin_price-preferences.yaml | 29 - .../paths/admin_price-preferences_{id}.yaml | 58 - .../admin/paths/admin_product-categories.yaml | 29 - .../paths/admin_product-categories_{id}.yaml | 79 +- ...dmin_product-categories_{id}_products.yaml | 44 +- .../specs/admin/paths/admin_product-tags.yaml | 29 - .../admin/paths/admin_product-tags_{id}.yaml | 64 +- .../admin/paths/admin_product-types.yaml | 29 - .../admin/paths/admin_product-types_{id}.yaml | 64 +- .../specs/admin/paths/admin_products.yaml | 33 +- .../admin/paths/admin_products_batch.yaml | 33 +- .../admin/paths/admin_products_export.yaml | 43 +- .../admin/paths/admin_products_import.yaml | 8 +- ...ducts_import_{transaction_id}_confirm.yaml | 12 +- .../admin/paths/admin_products_{id}.yaml | 62 +- .../paths/admin_products_{id}_options.yaml | 38 +- ...min_products_{id}_options_{option_id}.yaml | 98 +- .../paths/admin_products_{id}_variants.yaml | 38 +- .../admin_products_{id}_variants_batch.yaml | 34 +- ...s_{id}_variants_inventory-items_batch.yaml | 50 +- ...n_products_{id}_variants_{variant_id}.yaml | 96 +- ...variants_{variant_id}_inventory-items.yaml | 38 +- ...}_inventory-items_{inventory_item_id}.yaml | 69 +- .../specs/admin/paths/admin_promotions.yaml | 170 +- ...ns_rule-attribute-options_{rule_type}.yaml | 8 +- ...tions_{rule_type}_{rule_attribute_id}.yaml | 26 - .../admin/paths/admin_promotions_{id}.yaml | 299 +- ...admin_promotions_{id}_buy-rules_batch.yaml | 109 +- .../admin_promotions_{id}_rules_batch.yaml | 107 +- ...in_promotions_{id}_target-rules_batch.yaml | 109 +- .../admin_promotions_{id}_{rule_type}.yaml | 36 +- .../admin/paths/admin_refund-reasons.yaml | 29 - .../paths/admin_refund-reasons_{id}.yaml | 62 +- .../specs/admin/paths/admin_regions.yaml | 57 +- .../specs/admin/paths/admin_regions_{id}.yaml | 76 +- .../specs/admin/paths/admin_reservations.yaml | 29 - .../admin/paths/admin_reservations_{id}.yaml | 69 +- .../admin/paths/admin_return-reasons.yaml | 29 - .../paths/admin_return-reasons_{id}.yaml | 58 - .../specs/admin/paths/admin_returns.yaml | 177 +- .../specs/admin/paths/admin_returns_{id}.yaml | 58 - .../paths/admin_returns_{id}_cancel.yaml | 4 +- .../admin_returns_{id}_dismiss-items.yaml | 36 +- ...eturns_{id}_dismiss-items_{action_id}.yaml | 72 +- .../admin_returns_{id}_receive-items.yaml | 36 +- ...eturns_{id}_receive-items_{action_id}.yaml | 222 +- .../paths/admin_returns_{id}_receive.yaml | 35 +- .../admin_returns_{id}_receive_confirm.yaml | 35 +- .../admin_returns_{id}_request-items.yaml | 36 +- ...eturns_{id}_request-items_{action_id}.yaml | 223 +- .../paths/admin_returns_{id}_request.yaml | 36 +- .../admin_returns_{id}_shipping-method.yaml | 36 +- ...urns_{id}_shipping-method_{action_id}.yaml | 72 +- .../admin/paths/admin_sales-channels.yaml | 29 - .../paths/admin_sales-channels_{id}.yaml | 58 - .../admin_sales-channels_{id}_products.yaml | 44 +- .../admin/paths/admin_shipping-options.yaml | 37 +- .../paths/admin_shipping-options_{id}.yaml | 95 +- ...min_shipping-options_{id}_rules_batch.yaml | 89 +- .../admin/paths/admin_shipping-profiles.yaml | 29 - .../paths/admin_shipping-profiles_{id}.yaml | 62 +- .../admin/paths/admin_stock-locations.yaml | 29 - .../paths/admin_stock-locations_{id}.yaml | 58 - ...-locations_{id}_fulfillment-providers.yaml | 46 +- ...stock-locations_{id}_fulfillment-sets.yaml | 40 +- ...n_stock-locations_{id}_sales-channels.yaml | 44 +- .../specs/admin/paths/admin_stores_{id}.yaml | 58 - .../specs/admin/paths/admin_tax-rates.yaml | 29 - .../admin/paths/admin_tax-rates_{id}.yaml | 58 - .../paths/admin_tax-rates_{id}_rules.yaml | 34 +- .../admin_tax-rates_{id}_rules_{rule_id}.yaml | 29 - .../specs/admin/paths/admin_tax-regions.yaml | 41 +- .../admin/paths/admin_tax-regions_{id}.yaml | 29 - .../specs/admin/paths/admin_uploads.yaml | 15 +- .../specs/admin/paths/admin_uploads_{id}.yaml | 29 - .../specs/admin/paths/admin_users_me.yaml | 29 - .../specs/admin/paths/admin_users_{id}.yaml | 58 - .../admin_workflows-executions_{id}.yaml | 29 - ...orkflows-executions_{workflow_id}_run.yaml | 27 +- ...xecutions_{workflow_id}_steps_failure.yaml | 11 +- ...xecutions_{workflow_id}_steps_success.yaml | 11 +- ...utions_{workflow_id}_{transaction_id}.yaml | 29 - .../schemas/AdminCreateCollection.yaml | 1 - .../schemas/AdminCreateCustomerGroup.yaml | 1 - .../schemas/AdminCreateFulfillment.yaml | 19 - .../schemas/AdminCreatePriceList.yaml | 4 - .../schemas/AdminCreateShippingProfile.yaml | 2 +- .../schemas/AdminLinkPriceListProducts.yaml | 11 + .../components/schemas/AdminOrderPreview.yaml | 10 +- .../AdminPostClaimsItemsActionReqSchema.yaml | 2 - ...dminPostClaimsShippingActionReqSchema.yaml | 6 +- .../AdminPostClaimsShippingReqSchema.yaml | 6 +- ...nPostExchangesShippingActionReqSchema.yaml | 6 +- .../AdminPostExchangesShippingReqSchema.yaml | 6 +- .../AdminPostOrderClaimsReqSchema.yaml | 2 - .../schemas/AdminPostOrderEditsReqSchema.yaml | 1 - ...PostOrderEditsShippingActionReqSchema.yaml | 6 +- .../AdminPostOrderEditsShippingReqSchema.yaml | 6 +- .../AdminPostOrderExchangesReqSchema.yaml | 1 - .../AdminPostReceiveReturnsReqSchema.yaml | 2 - .../schemas/AdminPostReturnsReqSchema.yaml | 1 - .../AdminPostReturnsReturnReqSchema.yaml | 2 - ...minPostReturnsShippingActionReqSchema.yaml | 6 +- .../AdminPostReturnsShippingReqSchema.yaml | 6 +- .../schemas/AdminProductVariant.yaml | 4 + .../schemas/AdminUpdateCollection.yaml | 2 - .../schemas/AdminUpdateCustomerGroup.yaml | 2 - .../schemas/AdminUpdatePriceList.yaml | 4 - .../schemas/AdminUpdateSalesChannel.yaml | 3 - .../schemas/AdminUpdateStockLocation.yaml | 9 - .../components/schemas/AdminUpdateStore.yaml | 5 - .../schemas/AdminUpdateTaxRate.yaml | 3 - .../components/schemas/AdminUpdateUser.yaml | 4 - .../components/schemas/OrderPreview.yaml | 29 +- .../schemas/StoreAddCartLineItem.yaml | 1 - .../schemas/StoreUpdateCartLineItem.yaml | 1 - .../schemas/StoreUpdateCustomer.yaml | 5 - .../specs/store/openapi.full.yaml | 2076 +---- .../specs/store/paths/store_carts.yaml | 29 - .../specs/store/paths/store_carts_{id}.yaml | 58 - .../paths/store_carts_{id}_complete.yaml | 29 - .../paths/store_carts_{id}_line-items.yaml | 29 - ...store_carts_{id}_line-items_{line_id}.yaml | 58 - .../paths/store_carts_{id}_promotions.yaml | 58 - .../store_carts_{id}_shipping-methods.yaml | 29 - .../store/paths/store_carts_{id}_taxes.yaml | 29 - .../store/paths/store_collections_{id}.yaml | 29 - .../store/paths/store_currencies_{code}.yaml | 29 - .../specs/store/paths/store_customers.yaml | 29 - .../specs/store/paths/store_customers_me.yaml | 58 - .../paths/store_customers_me_addresses.yaml | 174 +- ...e_customers_me_addresses_{address_id}.yaml | 100 - .../specs/store/paths/store_orders.yaml | 54 +- .../specs/store/paths/store_orders_{id}.yaml | 75 - .../paths/store_payment-collections.yaml | 29 - ...ent-collections_{id}_payment-sessions.yaml | 29 - .../store/paths/store_payment-providers.yaml | 55 +- .../store/paths/store_product-categories.yaml | 16 - .../paths/store_product-categories_{id}.yaml | 29 - .../specs/store/paths/store_products.yaml | 420 +- .../store/paths/store_products_{id}.yaml | 29 - .../specs/store/paths/store_regions.yaml | 594 +- .../specs/store/paths/store_regions_{id}.yaml | 29 - .../paths/store_return-reasons_{id}.yaml | 29 - .../specs/store/paths/store_return.yaml | 1 - .../store/paths/store_shipping-options.yaml | 10 - ...min_claims_[id]_claim-items_[action_id].ts | 24 - ...n_claims_[id]_inbound_items_[action_id].ts | 42 - ..._claims_[id]_outbound_items_[action_id].ts | 24 - ...d]_outbound_shipping-method_[action_id].ts | 24 - ...n_customers_[id]_addresses_[address_id].ts | 24 - ...xchanges_[id]_inbound_items_[action_id].ts | 24 - ...changes_[id]_outbound_items_[action_id].ts | 24 - ...d]_outbound_shipping-method_[action_id].ts | 24 - ...tems_[id]_location-levels_[location_id].ts | 24 - ...admin_products_[id]_options_[option_id].ts | 24 - ...min_products_[id]_variants_[variant_id].ts | 24 - ...id]_inventory-items_[inventory_item_id].ts | 24 - ..._returns_[id]_dismiss-items_[action_id].ts | 24 - ..._returns_[id]_receive-items_[action_id].ts | 24 - ..._returns_[id]_request-items_[action_id].ts | 24 - ...eturns_[id]_shipping-method_[action_id].ts | 24 - ...te_admin_tax-rates_[id]_rules_[rule_id].ts | 24 - .../admin/get_admin_api-keys_[id].ts | 24 - .../admin/get_admin_campaigns_[id].ts | 24 - .../operations/admin/get_admin_claims_[id].ts | 24 - .../admin/get_admin_collections_[id].ts | 24 - .../admin/get_admin_currencies_[code].ts | 24 - .../admin/get_admin_customer-groups_[id].ts | 24 - .../admin/get_admin_customers_[id].ts | 24 - ...n_customers_[id]_addresses_[address_id].ts | 24 - .../admin/get_admin_exchanges_[id].ts | 24 - ...lment-sets_[id]_service-zones_[zone_id].ts | 24 - .../admin/get_admin_inventory-items_[id].ts | 24 - .../admin/get_admin_invites_[id].ts | 24 - .../admin/get_admin_notifications_[id].ts | 24 - .../operations/admin/get_admin_orders_[id].ts | 24 - .../admin/get_admin_orders_[id]_changes.ts | 24 - .../admin/get_admin_payments_[id].ts | 24 - .../admin/get_admin_price-lists_[id].ts | 24 - .../admin/get_admin_price-preferences_[id].ts | 24 - .../get_admin_product-categories_[id].ts | 24 - .../admin/get_admin_product-tags_[id].ts | 24 - .../admin/get_admin_product-types_[id].ts | 24 - .../admin/get_admin_products_[id].ts | 24 - ...admin_products_[id]_options_[option_id].ts | 24 - ...min_products_[id]_variants_[variant_id].ts | 24 - .../admin/get_admin_promotions_[id].ts | 24 - .../get_admin_promotions_[id]_[rule_type].ts | 29 +- ...ions_rule-attribute-options_[rule_type].ts | 5 +- ...options_[rule_type]_[rule_attribute_id].ts | 18 - .../admin/get_admin_refund-reasons_[id].ts | 24 - .../operations/admin/get_admin_regions.ts | 28 +- .../admin/get_admin_regions_[id].ts | 24 - .../admin/get_admin_reservations_[id].ts | 24 - .../admin/get_admin_return-reasons_[id].ts | 24 - .../admin/get_admin_returns_[id].ts | 24 - .../admin/get_admin_sales-channels_[id].ts | 24 - .../admin/get_admin_shipping-profiles_[id].ts | 24 - .../admin/get_admin_stock-locations_[id].ts | 24 - .../operations/admin/get_admin_stores_[id].ts | 24 - .../admin/get_admin_tax-rates_[id].ts | 24 - .../admin/get_admin_tax-regions_[id].ts | 24 - .../admin/get_admin_uploads_[id].ts | 24 - .../operations/admin/get_admin_users_[id].ts | 24 - .../operations/admin/get_admin_users_me.ts | 24 - .../get_admin_workflows-executions_[id].ts | 24 - ...ecutions_[workflow_id]_[transaction_id].ts | 24 - .../operations/admin/post_admin_api-keys.ts | 5 +- .../admin/post_admin_api-keys_[id].ts | 24 - .../admin/post_admin_api-keys_[id]_revoke.ts | 29 +- ...post_admin_api-keys_[id]_sales-channels.ts | 24 - .../operations/admin/post_admin_campaigns.ts | 28 +- .../admin/post_admin_campaigns_[id].ts | 24 - .../post_admin_campaigns_[id]_promotions.ts | 24 - .../operations/admin/post_admin_claims.ts | 24 - .../post_admin_claims_[id]_claim-items.ts | 24 - ...min_claims_[id]_claim-items_[action_id].ts | 24 - ...id]_inbound_shipping-method_[action_id].ts | 24 - .../post_admin_claims_[id]_outbound_items.ts | 24 - ..._claims_[id]_outbound_items_[action_id].ts | 24 - ...in_claims_[id]_outbound_shipping-method.ts | 24 - ...d]_outbound_shipping-method_[action_id].ts | 24 - .../admin/post_admin_claims_[id]_request.ts | 24 - .../admin/post_admin_collections.ts | 24 - .../admin/post_admin_collections_[id].ts | 24 - .../post_admin_collections_[id]_products.ts | 24 - .../admin/post_admin_customer-groups.ts | 24 - .../admin/post_admin_customer-groups_[id].ts | 24 - ...st_admin_customer-groups_[id]_customers.ts | 24 - .../operations/admin/post_admin_customers.ts | 24 - .../admin/post_admin_customers_[id].ts | 24 - .../post_admin_customers_[id]_addresses.ts | 24 - ...n_customers_[id]_addresses_[address_id].ts | 24 - .../admin/post_admin_draft-orders.ts | 24 - .../operations/admin/post_admin_exchanges.ts | 24 - .../admin/post_admin_exchanges_[id]_cancel.ts | 2 +- ...id]_inbound_shipping-method_[action_id].ts | 24 - ...ost_admin_exchanges_[id]_outbound_items.ts | 24 - ...changes_[id]_outbound_items_[action_id].ts | 24 - ...exchanges_[id]_outbound_shipping-method.ts | 24 - ...d]_outbound_shipping-method_[action_id].ts | 24 - .../post_admin_exchanges_[id]_request.ts | 24 - ...min_fulfillment-sets_[id]_service-zones.ts | 32 +- ...lment-sets_[id]_service-zones_[zone_id].ts | 34 +- .../admin/post_admin_fulfillments.ts | 24 - .../post_admin_fulfillments_[id]_cancel.ts | 27 +- .../post_admin_fulfillments_[id]_shipment.ts | 24 - .../admin/post_admin_inventory-items.ts | 24 - .../admin/post_admin_inventory-items_[id].ts | 38 - ...in_inventory-items_[id]_location-levels.ts | 24 - ...tems_[id]_location-levels_[location_id].ts | 24 - .../operations/admin/post_admin_invites.ts | 24 - .../admin/post_admin_invites_[id]_resend.ts | 24 - .../admin/post_admin_invites_accept.ts | 50 +- .../admin/post_admin_order-edits.ts | 1 - .../admin/post_admin_orders_[id].ts | 24 - .../admin/post_admin_orders_[id]_archive.ts | 24 - .../admin/post_admin_orders_[id]_cancel.ts | 31 +- .../admin/post_admin_orders_[id]_complete.ts | 24 - .../post_admin_orders_[id]_fulfillments.ts | 24 - ...d]_fulfillments_[fulfillment_id]_cancel.ts | 24 - ...fulfillments_[fulfillment_id]_shipments.ts | 26 +- .../admin/post_admin_payment-collections.ts | 24 - ...n_payment-collections_[id]_mark-as-paid.ts | 24 - .../admin/post_admin_payments_[id]_capture.ts | 24 - .../admin/post_admin_payments_[id]_refund.ts | 24 - .../admin/post_admin_price-lists.ts | 24 - .../admin/post_admin_price-lists_[id].ts | 24 - ...ost_admin_price-lists_[id]_prices_batch.ts | 4 - .../post_admin_price-lists_[id]_products.ts | 35 +- .../admin/post_admin_price-preferences.ts | 24 - .../post_admin_price-preferences_[id].ts | 24 - .../admin/post_admin_product-categories.ts | 24 - .../post_admin_product-categories_[id].ts | 24 - ..._admin_product-categories_[id]_products.ts | 24 - .../admin/post_admin_product-tags.ts | 24 - .../admin/post_admin_product-tags_[id].ts | 24 - .../admin/post_admin_product-types.ts | 24 - .../admin/post_admin_product-types_[id].ts | 24 - .../operations/admin/post_admin_products.ts | 24 - .../admin/post_admin_products_[id].ts | 24 - .../admin/post_admin_products_[id]_options.ts | 24 - ...admin_products_[id]_options_[option_id].ts | 24 - .../post_admin_products_[id]_variants.ts | 24 - ...min_products_[id]_variants_[variant_id].ts | 24 - ...]_variants_[variant_id]_inventory-items.ts | 24 - ...id]_inventory-items_[inventory_item_id].ts | 24 - ...post_admin_products_[id]_variants_batch.ts | 24 - .../admin/post_admin_products_batch.ts | 24 - .../admin/post_admin_products_export.ts | 30 +- .../admin/post_admin_products_import.ts | 1 - .../operations/admin/post_admin_promotions.ts | 28 +- .../admin/post_admin_promotions_[id].ts | 24 - ...t_admin_promotions_[id]_buy-rules_batch.ts | 28 +- .../post_admin_promotions_[id]_rules_batch.ts | 28 +- ...dmin_promotions_[id]_target-rules_batch.ts | 28 +- .../admin/post_admin_refund-reasons.ts | 24 - .../admin/post_admin_refund-reasons_[id].ts | 24 - .../operations/admin/post_admin_regions.ts | 24 - .../admin/post_admin_regions_[id].ts | 24 - .../admin/post_admin_reservations.ts | 24 - .../admin/post_admin_reservations_[id].ts | 24 - .../admin/post_admin_return-reasons.ts | 24 - .../admin/post_admin_return-reasons_[id].ts | 24 - .../operations/admin/post_admin_returns.ts | 24 - .../admin/post_admin_returns_[id].ts | 24 - .../post_admin_returns_[id]_dismiss-items.ts | 24 - ..._returns_[id]_dismiss-items_[action_id].ts | 24 - .../post_admin_returns_[id]_receive-items.ts | 24 - ..._returns_[id]_receive-items_[action_id].ts | 24 - .../admin/post_admin_returns_[id]_receive.ts | 24 - ...post_admin_returns_[id]_receive_confirm.ts | 29 +- .../post_admin_returns_[id]_request-items.ts | 24 - ..._returns_[id]_request-items_[action_id].ts | 24 - .../admin/post_admin_returns_[id]_request.ts | 29 +- ...post_admin_returns_[id]_shipping-method.ts | 24 - ...eturns_[id]_shipping-method_[action_id].ts | 24 - .../admin/post_admin_sales-channels.ts | 24 - .../admin/post_admin_sales-channels_[id].ts | 24 - ...post_admin_sales-channels_[id]_products.ts | 24 - .../admin/post_admin_shipping-options.ts | 24 - .../admin/post_admin_shipping-options_[id].ts | 28 +- ...admin_shipping-options_[id]_rules_batch.ts | 24 - .../admin/post_admin_shipping-profiles.ts | 24 - .../post_admin_shipping-profiles_[id].ts | 26 - .../admin/post_admin_stock-locations.ts | 24 - .../admin/post_admin_stock-locations_[id].ts | 24 - ...ck-locations_[id]_fulfillment-providers.ts | 24 - ...n_stock-locations_[id]_fulfillment-sets.ts | 24 - ...min_stock-locations_[id]_sales-channels.ts | 24 - .../admin/post_admin_stores_[id].ts | 24 - .../operations/admin/post_admin_tax-rates.ts | 24 - .../admin/post_admin_tax-rates_[id].ts | 24 - .../admin/post_admin_tax-rates_[id]_rules.ts | 24 - .../admin/post_admin_tax-regions.ts | 24 - .../operations/admin/post_admin_uploads.ts | 1 - .../operations/admin/post_admin_users_[id].ts | 24 - .../operations/auth/delete_auth_session.ts | 1 - ...or_type]_[auth_provider]_reset-password.ts | 44 + ...uth_[actor_type]_[auth_provider]_update.ts | 43 + .../operations/auth/post_auth_session.ts | 1 - .../auth/post_auth_token_refresh.ts | 31 + ...e_store_carts_[id]_line-items_[line_id].ts | 24 - .../delete_store_carts_[id]_promotions.ts | 24 - ...ore_customers_me_addresses_[address_id].ts | 24 - .../operations/store/get_store_carts_[id].ts | 24 - .../store/get_store_collections_[id].ts | 24 - .../store/get_store_currencies_[code].ts | 24 - .../store/get_store_customers_me.ts | 24 - .../store/get_store_customers_me_addresses.ts | 132 +- ...ore_customers_me_addresses_[address_id].ts | 24 - .../operations/store/get_store_orders.ts | 54 +- .../operations/store/get_store_orders_[id].ts | 70 - .../store/get_store_payment-providers.ts | 55 +- .../store/get_store_product-categories.ts | 16 - .../get_store_product-categories_[id].ts | 24 - .../operations/store/get_store_products.ts | 416 +- .../store/get_store_products_[id].ts | 24 - .../operations/store/get_store_regions.ts | 490 +- .../store/get_store_regions_[id].ts | 24 - .../store/get_store_return-reasons_[id].ts | 24 - .../store/get_store_shipping-options.ts | 8 - .../operations/store/post_store_carts.ts | 24 - .../operations/store/post_store_carts_[id].ts | 24 - .../store/post_store_carts_[id]_complete.ts | 24 - .../store/post_store_carts_[id]_line-items.ts | 24 - ...t_store_carts_[id]_line-items_[line_id].ts | 24 - .../store/post_store_carts_[id]_promotions.ts | 24 - .../post_store_carts_[id]_shipping-methods.ts | 24 - .../store/post_store_carts_[id]_taxes.ts | 24 - .../operations/store/post_store_customers.ts | 24 - .../store/post_store_customers_me.ts | 24 - .../post_store_customers_me_addresses.ts | 37 - ...ore_customers_me_addresses_[address_id].ts | 37 - .../store/post_store_payment-collections.ts | 24 - ...yment-collections_[id]_payment-sessions.ts | 24 - .../operations/store/post_store_return.ts | 1 - .../schemas/AdminCreateCollection.ts | 1 - .../schemas/AdminCreateCustomerGroup.ts | 1 - .../schemas/AdminCreateFulfillment.ts | 19 - .../schemas/AdminCreatePriceList.ts | 4 - .../schemas/AdminCreateShippingProfile.ts | 2 +- .../schemas/AdminLinkPriceListProducts.ts | 16 + .../oas-output/schemas/AdminOrderPreview.ts | 10 +- .../AdminPostClaimsItemsActionReqSchema.ts | 2 - .../AdminPostClaimsShippingActionReqSchema.ts | 6 +- .../AdminPostClaimsShippingReqSchema.ts | 6 +- ...minPostExchangesShippingActionReqSchema.ts | 6 +- .../AdminPostExchangesShippingReqSchema.ts | 6 +- .../schemas/AdminPostOrderClaimsReqSchema.ts | 2 - .../schemas/AdminPostOrderEditsReqSchema.ts | 1 - ...inPostOrderEditsShippingActionReqSchema.ts | 6 +- .../AdminPostOrderEditsShippingReqSchema.ts | 6 +- .../AdminPostOrderExchangesReqSchema.ts | 1 - .../AdminPostReceiveReturnsReqSchema.ts | 2 - .../schemas/AdminPostReturnsReqSchema.ts | 1 - .../AdminPostReturnsReturnReqSchema.ts | 2 - ...AdminPostReturnsShippingActionReqSchema.ts | 6 +- .../AdminPostReturnsShippingReqSchema.ts | 6 +- .../oas-output/schemas/AdminProductVariant.ts | 4 + .../schemas/AdminUpdateCollection.ts | 2 - .../schemas/AdminUpdateCustomerGroup.ts | 2 - .../schemas/AdminUpdatePriceList.ts | 4 - .../schemas/AdminUpdateSalesChannel.ts | 3 - .../schemas/AdminUpdateStockLocation.ts | 9 - .../oas-output/schemas/AdminUpdateStore.ts | 5 - .../oas-output/schemas/AdminUpdateTaxRate.ts | 3 - .../oas-output/schemas/AdminUpdateUser.ts | 4 - .../oas-output/schemas/OrderPreview.ts | 29 +- .../schemas/StoreAddCartLineItem.ts | 1 - .../schemas/StoreUpdateCartLineItem.ts | 1 - .../oas-output/schemas/StoreUpdateCustomer.ts | 5 - 535 files changed, 3668 insertions(+), 23178 deletions(-) create mode 100644 www/apps/api-reference/specs/admin/components/schemas/AdminLinkPriceListProducts.yaml create mode 100644 www/apps/api-reference/specs/store/components/schemas/AdminLinkPriceListProducts.yaml create mode 100644 www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts create mode 100644 www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts create mode 100644 www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts create mode 100644 www/utils/generated/oas-output/schemas/AdminLinkPriceListProducts.ts diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml index 2a9161c132..cb4739e001 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCollection.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateCollection required: - title - - metadata properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml index 411237b91f..bd8d34314b 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateCustomerGroup.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateCustomerGroup required: - name - - metadata properties: name: type: string 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 7d1debb06d..8a6e547262 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateFulfillment.yaml @@ -9,12 +9,7 @@ required: - labels - order - order_id - - shipping_option_id - data - - packed_at - - shipped_at - - delivered_at - - canceled_at - metadata properties: location_id: @@ -28,18 +23,6 @@ properties: delivery_address: type: object description: The fulfillment's delivery address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata properties: first_name: type: string @@ -95,8 +78,6 @@ properties: - sku - quantity - barcode - - line_item_id - - inventory_item_id properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml index a8e62f3999..f360a50004 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreatePriceList.yaml @@ -4,8 +4,6 @@ x-schemaName: AdminCreatePriceList required: - title - description - - starts_at - - ends_at properties: title: type: string @@ -48,8 +46,6 @@ properties: - currency_code - amount - variant_id - - min_quantity - - max_quantity properties: currency_code: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml index 221e02bf81..94a4933a1e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminCreateShippingProfile.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateShippingProfile required: - name - type @@ -15,4 +16,3 @@ properties: metadata: type: object description: The shipping profile's metadata. -x-schemaName: AdminCreateShippingProfile diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminLinkPriceListProducts.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminLinkPriceListProducts.yaml new file mode 100644 index 0000000000..5e8a008bc4 --- /dev/null +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminLinkPriceListProducts.yaml @@ -0,0 +1,11 @@ +type: object +description: The removal details. +properties: + remove: + type: array + description: The products to remove from the price list. + items: + type: string + title: remove + description: The ID of a product. +x-schemaName: AdminLinkPriceListProducts 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 c2149ed29a..b031d34d77 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminOrderPreview.yaml @@ -5,8 +5,8 @@ required: - return_requested_total - order_change - currency_code - - id - version + - id - region_id - customer_id - sales_channel_id @@ -465,14 +465,14 @@ properties: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml index b3b1589daa..6ab38aa512 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema -required: - - reason_id properties: quantity: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml index f7c3f3c219..3741c54e3d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostClaimsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml index ba1745276f..395e129bdd 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The claim's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml index c473ba6e3a..68fc3d9b3e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostExchangesShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml index 6af8ce407a..aee62b6a99 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 0a3dcc4f9c..9daa00cb61 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -4,8 +4,6 @@ x-schemaName: AdminPostOrderClaimsReqSchema required: - type - order_id - - reason_id - - metadata properties: type: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml index 592ffc30b3..c6946ef6fe 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminPostOrderEditsReqSchema required: - order_id - - metadata properties: order_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml index ce424d8297..2e36a37f64 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml index 91e223dc84..cd81378dd5 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The order edit's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml index 60f49ba39f..05e3ed3e54 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id - - metadata properties: order_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index 5369559d9e..ea798aa3c3 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminPostReceiveReturnsReqSchema -required: - - metadata properties: internal_note: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml index 8d64cb70c0..68be6f5dcc 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReqSchema.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminPostReturnsReqSchema required: - order_id - - metadata properties: order_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml index e752425d9b..3d5c38d44d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminPostReturnsReturnReqSchema -required: - - metadata properties: location_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml index 7b46e91e55..5cd4a15e19 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostReturnsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The return's custom price. + title: custom_amount + description: The return's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml index 48a850a29f..9cd63a9d16 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml index 73384be760..8e82d12e9d 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminProductVariant.yaml @@ -61,6 +61,10 @@ properties: type: boolean title: manage_inventory description: The parent's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The parent's inventory quantity. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml index a1a589243a..22a9be4f57 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCollection.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateCollection -required: - - metadata properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml index 71ce5dbe47..acb0253445 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateCustomerGroup.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateCustomerGroup -required: - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml index 464f157c82..97688d7c5f 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdatePriceList.yaml @@ -1,10 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdatePriceList -required: - - description - - starts_at - - ends_at properties: title: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml index fb9b87db05..8f30103306 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateSalesChannel.yaml @@ -1,9 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateSalesChannel -required: - - description - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml index 79f40f4276..2312fd5e3c 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStockLocation.yaml @@ -1,9 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateStockLocation -required: - - address_id - - metadata properties: name: type: string @@ -14,13 +11,7 @@ properties: description: The stock location's address. required: - address_1 - - address_2 - - company - - city - country_code - - phone - - postal_code - - province properties: address_1: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml index 263b8caac1..7df88b6bc0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateStore.yaml @@ -1,11 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateStore -required: - - default_sales_channel_id - - default_region_id - - default_location_id - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml index 791c465256..5580cc1ef6 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateTaxRate.yaml @@ -1,9 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateTaxRate -required: - - code - - metadata properties: rate: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml index 781812e182..1d1bd54d5a 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/AdminUpdateUser.yaml @@ -1,10 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateUser -required: - - first_name - - last_name - - avatar_url properties: first_name: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml index b51f369920..56edabcde0 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/OrderPreview.yaml @@ -5,8 +5,8 @@ required: - order_change - status - currency_code - - id - version + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -671,14 +671,14 @@ properties: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id @@ -724,6 +724,8 @@ properties: - balance - paid_total - refunded_total + - pending_difference + - raw_pending_difference properties: total: oneOf: @@ -935,6 +937,23 @@ properties: - type: object description: The summary's refunded total. x-schemaName: IBigNumber + pending_difference: + oneOf: + - type: string + title: pending_difference + description: The summary's pending difference. + - type: number + title: pending_difference + description: The summary's pending difference. + - type: string + title: pending_difference + description: The summary's pending difference. + - type: object + description: The summary's pending difference. + x-schemaName: IBigNumber + raw_pending_difference: + type: object + description: The summary's raw pending difference. metadata: type: object description: The order preview's metadata. diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml index abf0714b02..c791cbd824 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreAddCartLineItem.yaml @@ -4,7 +4,6 @@ x-schemaName: StoreAddCartLineItem required: - variant_id - quantity - - metadata properties: variant_id: type: string diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml index e7c6862965..a6468aab56 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCartLineItem.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: StoreUpdateCartLineItem required: - quantity - - metadata properties: quantity: type: number diff --git a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml index f9c3b19ebb..f3f14b1f5e 100644 --- a/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/admin/components/schemas/StoreUpdateCustomer.yaml @@ -1,11 +1,6 @@ type: object description: SUMMARY x-schemaName: StoreUpdateCustomer -required: - - company_name - - first_name - - last_name - - phone properties: company_name: type: string diff --git a/www/apps/api-reference/specs/admin/openapi.full.yaml b/www/apps/api-reference/specs/admin/openapi.full.yaml index d747454870..aa59f0ed1e 100644 --- a/www/apps/api-reference/specs/admin/openapi.full.yaml +++ b/www/apps/api-reference/specs/admin/openapi.full.yaml @@ -1582,9 +1582,12 @@ paths: post: operationId: PostApiKeys summary: Create Api Key - description: Create a api key. + description: | + Create a secret or publishable API key. + A secret API key is used for admin authentication. + + A publishable API key is used by client applications to set the scope of the request. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] @@ -1656,30 +1659,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1713,13 +1692,13 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostApiKeysId - summary: Update a Api Key - description: Update a api key's details. + summary: Update an API Key + description: Update an API key's details. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -1739,30 +1718,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1871,13 +1826,14 @@ paths: /admin/api-keys/{id}/revoke: post: operationId: PostApiKeysIdRevoke - summary: Add Revokes to Api Key - description: Add a list of revokes to a api key. + summary: Revoke API Key + description: | + Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, it can't be used by client applications. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -1897,30 +1853,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -1961,13 +1893,14 @@ paths: /admin/api-keys/{id}/sales-channels: post: operationId: PostApiKeysIdSalesChannels - summary: Add Sales Channels to Api Key - description: Add a list of sales channels to a api key. + summary: Manage Sales Channels of a Publishable API Key + x-sidebar-summary: Manage Sales Channels + description: Manage the sales channels of a publishable API key, either to associate them or remove them from the API key. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -1987,30 +1920,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2020,22 +1929,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The sales channels to add or remove from the publishable API key. properties: add: type: array - description: The api key's add. + description: The sales channels to add to the publishable API key. items: type: string title: add - description: The add's details. + description: A sales channel's ID. remove: type: array - description: The api key's remove. + description: The sales channels to remove from the publishable API key. items: type: string title: remove - description: The remove's details. + description: A sales channel's ID. x-codeSamples: - lang: Shell label: cURL @@ -2193,30 +2102,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2227,7 +2112,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The campaign's details. required: - name - campaign_identifier @@ -2243,14 +2128,14 @@ paths: campaign_identifier: type: string title: campaign_identifier - description: The campaign's campaign identifier. + description: The campaign's identifier. description: type: string title: description description: The campaign's description. budget: type: object - description: The campaign's budget. + description: The campaign's budget which, when crossed, ends the campaign. required: - type - limit @@ -2258,47 +2143,50 @@ paths: properties: type: type: string + title: type + description: | + The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. Use `usage` to set a limit on the total number of times the campaign's promotions can be used. enum: - spend - usage limit: type: number title: limit - description: The budget's limit. + description: The campaign budget's limit. currency_code: type: string title: currency_code - description: The budget's currency code. + description: The campaign budget's currency code. This can't be edited later. starts_at: type: string title: starts_at - description: The campaign's starts at. + description: The campaign's start date. format: date-time ends_at: type: string title: ends_at - description: The campaign's ends at. + description: The campaign's end date. format: date-time promotions: type: array description: The campaign's promotions. items: type: object - description: The promotion's promotions. + description: The promotions to add to the campaign. required: - id properties: id: type: string title: id - description: The promotion's ID. + description: A promotion's ID. - type: object - description: SUMMARY + description: The campaign's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The campaign's details. x-codeSamples: - lang: Shell label: cURL @@ -2364,30 +2252,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2447,30 +2311,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2481,7 +2321,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The campaign's details. required: - description - starts_at @@ -2494,7 +2334,7 @@ paths: campaign_identifier: type: string title: campaign_identifier - description: The campaign's campaign identifier. + description: The campaign's identifier. description: type: string title: description @@ -2508,37 +2348,37 @@ paths: limit: type: number title: limit - description: The budget's limit. + description: The campaign budget's limit. starts_at: type: string title: starts_at - description: The campaign's starts at. + description: The campaign's start date. format: date-time ends_at: type: string title: ends_at - description: The campaign's ends at. + description: The campaign's end date. format: date-time promotions: type: array description: The campaign's promotions. items: type: object - description: The promotion's promotions. + description: The promotions to add to the campaign. required: - id properties: id: type: string title: id - description: The promotion's ID. + description: A promotion's ID. - type: object - description: SUMMARY + description: The campaign's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The campaign's details. x-codeSamples: - lang: Shell label: cURL @@ -2640,8 +2480,9 @@ paths: /admin/campaigns/{id}/promotions: post: operationId: PostCampaignsIdPromotions - summary: Add Promotions to Campaign - description: Add a list of promotions to a campaign. + summary: Manage the Promotions of a Campaign + x-sidebar-summary: Manage Promotions + description: Manage the promotions of a campaign, either by adding them or removing them from the campaign. x-authenticated: true parameters: - name: id @@ -2666,30 +2507,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -2699,22 +2516,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The promotions to add or remove from the campaign. properties: add: type: array - description: The campaign's add. + description: The promotions to add to the campaign. items: type: string title: add - description: The add's details. + description: A promotion's ID. remove: type: array - description: The campaign's remove. + description: The promotions to remove from the campaign. items: type: string title: remove - description: The remove's details. + description: A promotion's ID. x-codeSamples: - lang: Shell label: cURL @@ -3586,8 +3403,8 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostClaims - summary: Create Claim - description: Create a claim. + summary: Create a Claim + 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 @@ -3606,30 +3423,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3702,30 +3495,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3760,8 +3529,8 @@ paths: /admin/claims/{id}/cancel: post: operationId: PostClaimsIdCancel - summary: Add Cancels to Claim - description: Add a list of cancels to a claim. + summary: Cancel a Claim + description: Cancel a claim and its associated return. x-authenticated: true parameters: - name: id @@ -3810,8 +3579,9 @@ paths: /admin/claims/{id}/claim-items: post: operationId: PostClaimsIdClaimItems - summary: Add Claim Items to Claim - description: Add a list of claim items to a claim. + summary: Add Claim Items to a Claim + x-sidebar-summary: Add Claim Items + description: Add order items to a claim as claim items. These claim items will have the action `WRITE_OFF_ITEM`. x-authenticated: true parameters: - name: id @@ -3836,30 +3606,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -3900,8 +3646,11 @@ paths: /admin/claims/{id}/claim-items/{action_id}: post: operationId: PostClaimsIdClaimItemsAction_id - summary: Add Claim Items to Claim - description: Add a list of claim items to a claim. + summary: Update a Claim Item + description: | + Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -3912,7 +3661,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the order item's `WRITE_OFF_ITEM` action. required: true schema: type: string @@ -3932,30 +3681,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4031,30 +3756,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4090,8 +3791,10 @@ paths: /admin/claims/{id}/inbound/items: post: operationId: PostClaimsIdInboundItems - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Add Inbound Items to a Claim + x-sidebar-summary: Add Inbound Items + description: | + Add inbound (or return) items to a claim. These inbound items will have a `RETURN_ITEM` action. x-authenticated: true parameters: - name: id @@ -4140,8 +3843,12 @@ paths: /admin/claims/{id}/inbound/items/{action_id}: post: operationId: PostClaimsIdInboundItemsAction_id - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Update Inbound Items of a Claim + x-sidebar-summary: Update Inbound Items + description: | + Update an inbound (or return) item of a claim using the `ID` of the item's `RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -4152,7 +3859,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string @@ -4215,46 +3922,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4288,8 +3955,10 @@ paths: /admin/claims/{id}/inbound/shipping-method: post: operationId: PostClaimsIdInboundShippingMethod - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Add an Inbound Shipping Method to a Claim + x-sidebar-summary: Add Inbound Shipping + description: | + Add an inbound (or return) shipping method to a claim. The inbound shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -4342,8 +4011,12 @@ paths: /admin/claims/{id}/inbound/shipping-method/{action_id}: post: operationId: PostClaimsIdInboundShippingMethodAction_id - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Update Inbound Shipping Method of a Claim + x-sidebar-summary: Update Inbound Shipping + description: | + Update the shipping method for returning items in the claim using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -4354,7 +4027,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -4374,30 +4047,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4490,8 +4139,10 @@ paths: /admin/claims/{id}/outbound/items: post: operationId: PostClaimsIdOutboundItems - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Add Outbound Items to a Claim + x-sidebar-summary: Add Outbound Items + description: | + Add outbound (or new) items to a claim. These outbound items will have an `ITEM_ADD` action. x-authenticated: true parameters: - name: id @@ -4516,30 +4167,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4580,8 +4207,12 @@ paths: /admin/claims/{id}/outbound/items/{action_id}: post: operationId: PostClaimsIdOutboundItemsAction_id - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Update Outbound Item of a Claim + x-sidebar-summary: Update Outbound Item + description: | + Update an outbound (or new) item of a claim using the `ID` of the item's `ITEM_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -4592,7 +4223,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the new claim item's `ITEM_ADD` action. required: true schema: type: string @@ -4612,30 +4243,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4711,30 +4318,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4768,8 +4351,10 @@ paths: /admin/claims/{id}/outbound/shipping-method: post: operationId: PostClaimsIdOutboundShippingMethod - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Add Outbound Shipping Methods to a Claim + x-sidebar-summary: Add Outbound Shipping + description: | + Add an outbound shipping method to a claim. The outbound shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -4794,30 +4379,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4862,8 +4423,12 @@ paths: /admin/claims/{id}/outbound/shipping-method/{action_id}: post: operationId: PostClaimsIdOutboundShippingMethodAction_id - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Update Outbound Shipping Method of a Claim + x-sidebar-summary: Update Outbound Shipping + description: | + Update the shipping method for delivering outbound items in a claim using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -4874,7 +4439,7 @@ paths: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -4894,30 +4459,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -4993,30 +4534,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -5050,8 +4567,9 @@ paths: /admin/claims/{id}/request: post: operationId: PostClaimsIdRequest - summary: Add Requests to Claim - description: Add a list of requests to a claim. + summary: Confirm a Claim Request + x-sidebar-summary: Confirm Claim + description: Confirm a claim request, applying its changes on the associated order. x-authenticated: true parameters: - name: id @@ -5076,30 +4594,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -6043,30 +5537,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -6138,30 +5608,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -6221,30 +5667,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -6333,8 +5755,9 @@ paths: /admin/collections/{id}/products: post: operationId: PostCollectionsIdProducts - summary: Add Products to Collection - description: Add a list of products to a collection. + summary: Manage Products of a Collection + x-sidebar-summary: Manage Products + description: Manage the products of a collection by adding or removing them from the collection. x-authenticated: true parameters: - name: id @@ -6359,30 +5782,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -6392,22 +5791,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The products to add or remove. properties: add: type: array - description: The collection's add. + description: The products to add to the collection. items: type: string title: add - description: The add's details. + description: A product's ID. remove: type: array - description: The collection's remove. + description: The products to remove from the collection. items: type: string title: remove - description: The remove's details. + description: A product's ID. x-codeSamples: - lang: Shell label: cURL @@ -6585,30 +5984,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -7547,30 +6922,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -7642,30 +6993,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -7725,30 +7052,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -7857,8 +7160,9 @@ paths: /admin/customer-groups/{id}/customers: post: operationId: PostCustomerGroupsIdCustomers - summary: Add Customers to Customer Group - description: Add a list of customers to a customer group. + summary: Manage Customers of a Customer Group + x-sidebar-summary: Manage Customers + description: Manage the customers of a group to add or remove them from the group. x-authenticated: true parameters: - name: id @@ -7883,30 +7187,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -7916,22 +7196,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The customers to add or remove from the group. properties: add: type: array - description: The customer group's add. + description: The customers to add to the group. items: type: string title: add - description: The add's details. + description: A customer's ID. remove: type: array - description: The customer group's remove. + description: The customers to remove from the group. items: type: string title: remove - description: The remove's details. + description: A customer's ID. x-codeSamples: - lang: Shell label: cURL @@ -11285,12 +10565,12 @@ paths: title: $or - name: has_account in: query - description: The customer's has account. + description: Filter by whether the customer is registered. required: false schema: type: boolean title: has_account - description: The customer's has account. + description: Filter by whether the customer is registered. security: - api_token: [] - cookie_auth: [] @@ -11370,30 +10650,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -11404,7 +10660,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The customer's details. required: - email - company_name @@ -11438,12 +10694,12 @@ paths: type: object description: The customer's metadata. - type: object - description: SUMMARY + description: The customer's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The customer's details. x-codeSamples: - lang: Shell label: cURL @@ -11510,30 +10766,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -11593,30 +10825,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -11627,7 +10835,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The customer's details. required: - email - company_name @@ -11661,12 +10869,12 @@ paths: type: object description: The customer's metadata. - type: object - description: SUMMARY + description: The customer's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The customer's details. x-codeSamples: - lang: Shell label: cURL @@ -11979,8 +11187,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCustomersIdAddresses - summary: Add Addresses to Customer - description: Add a list of addresses to a customer. + summary: Add a Customer Address + x-sidebar-summary: Add Address + description: Add an address to a customer. x-authenticated: true parameters: - name: id @@ -12005,30 +11214,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -12039,7 +11224,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The address's details. required: - address_name - company @@ -12057,65 +11242,65 @@ paths: address_name: type: string title: address_name - description: The customer's address name. + description: The name of the address. is_default_shipping: type: boolean title: is_default_shipping - description: The customer's is default shipping. + description: Whether this address is used by default for shipping when placing an order. is_default_billing: type: boolean title: is_default_billing - description: The customer's is default billing. + description: Whether this address is used by default for billing when placing an order. company: type: string title: company - description: The customer's company. + description: The address's company. first_name: type: string title: first_name - description: The customer's first name. + description: The address's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The customer's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The customer's address 2. + description: The address's second line. city: type: string title: city - description: The customer's city. + description: The address's city. country_code: type: string title: country_code - description: The customer's country code. + description: The address's country code. province: type: string title: province - description: The customer's province. + description: The address's province. postal_code: type: string title: postal_code - description: The customer's postal code. + description: The address's postal code. phone: type: string title: phone - description: The customer's phone. + description: The address's phone. metadata: type: object - description: The customer's metadata. + description: The address's metadata. - type: object - description: SUMMARY + description: The address's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The address's details. x-codeSamples: - lang: Shell label: cURL @@ -12194,30 +11379,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -12251,8 +11412,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostCustomersIdAddressesAddress_id - summary: Add Addresses to Customer - description: Add a list of addresses to a customer. + summary: Update a Customer's Address + x-sidebar-summary: Update Address + description: Update a customer address's details. x-authenticated: true parameters: - name: id @@ -12283,30 +11445,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -12317,7 +11455,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The address's details. required: - address_name - company @@ -12335,65 +11473,65 @@ paths: address_name: type: string title: address_name - description: The customer's address name. + description: The name of the address. is_default_shipping: type: boolean title: is_default_shipping - description: The customer's is default shipping. + description: Whether this address is used by default for shipping when placing an order. is_default_billing: type: boolean title: is_default_billing - description: The customer's is default billing. + description: Whether this address is used by default for billing when placing an order. company: type: string title: company - description: The customer's company. + description: The address's company. first_name: type: string title: first_name - description: The customer's first name. + description: The address's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The customer's address 1. + description: The address's first line address_2: type: string title: address_2 - description: The customer's address 2. + description: The address's second line city: type: string title: city - description: The customer's city. + description: The address's city. country_code: type: string title: country_code - description: The customer's country code. + description: The address's country code. province: type: string title: province - description: The customer's province. + description: The address's province. postal_code: type: string title: postal_code - description: The customer's postal code. + description: The address's postal code. phone: type: string title: phone - description: The customer's phone. + description: The address's phone. metadata: type: object - description: The customer's metadata. + description: The address's metadata. - type: object - description: SUMMARY + description: The address's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The address's details. x-codeSamples: - lang: Shell label: cURL @@ -12471,30 +11609,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -13465,24 +12579,25 @@ paths: title: $or - name: sales_channel_id in: query - description: The draft order's sales channel id. + description: Filter by the associated sales channels to retrieve its draft orders. required: false schema: type: array - description: The draft order's sales channel id. + description: Filter by the associated sales channels to retrieve its draft orders. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: fulfillment_status in: query - description: The draft order's fulfillment status. + description: Filter by the fulfillment status of the draft order. required: false schema: type: array - description: The draft order's fulfillment status. + description: Filter by the fulfillment status of the draft order. items: type: string + title: fulfillment_status description: The fulfillment status's details. enum: - canceled @@ -13495,13 +12610,14 @@ paths: - delivered - name: payment_status in: query - description: The draft order's payment status. + description: Filter by the payment status of the draft order. required: false schema: type: array - description: The draft order's payment status. + description: Filter by the payment status of the draft order. items: type: string + title: payment_status description: The payment status's details. enum: - canceled @@ -13516,30 +12632,30 @@ paths: - requires_action - name: region_id in: query - description: The draft order's region id. + description: Filter by region IDs to retrieve their associated draft orders. required: false schema: type: array - description: The draft order's region id. + description: Filter by region IDs to retrieve their associated draft orders. items: type: string title: region_id - description: The region id's details. + description: A region's ID. - name: q in: query - description: The draft order's q. + description: Search term to filter the order's searchable properties. required: false schema: type: string title: q - description: The draft order's q. + description: Search term to filter the order's searchable properties. - name: created_at in: query - description: The draft order's created at. + description: Filter by the draft order's creation date. required: false schema: type: object - description: The draft order's created at. + description: Filter by the draft order's creation date. properties: $and: type: array @@ -13559,11 +12675,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -13574,19 +12690,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -13608,42 +12724,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter - type: object description: Filter by values not matching the conditions in this parameter. - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13682,31 +12798,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The value to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13745,32 +12861,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The draft order's updated at. + description: Filter by the draft order's update date. required: false schema: type: object - description: The draft order's updated at. + description: Filter by the draft order's update date. properties: $and: type: array @@ -13790,11 +12906,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -13805,19 +12921,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -13839,42 +12955,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter - type: object description: Filter by values not matching the conditions in this parameter. - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13913,31 +13029,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The value to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -13976,21 +13092,21 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -14055,7 +13171,7 @@ paths: post: operationId: PostDraftOrders summary: Create Draft Order - description: Create a draft order. + description: Create a draft order. This creates an order with the `is_draft_order` property enabled. x-authenticated: true parameters: - name: expand @@ -14074,30 +13190,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -14108,7 +13200,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The draft order's details. required: - sales_channel_id - email @@ -14119,25 +13211,27 @@ paths: - metadata properties: status: - type: boolean + type: string title: status description: The draft order's status. + enum: + - completed sales_channel_id: type: string title: sales_channel_id - description: The draft order's sales channel id. + description: The ID of the associated sales channel. email: type: string title: email - description: The draft order's email. + description: The email of the draft order's customer. format: email customer_id: type: string title: customer_id - description: The draft order's customer id. + description: The ID of the draft order's customer. billing_address: type: object - description: The draft order's billing address. + description: The billing address's details. required: - first_name - last_name @@ -14170,11 +13264,11 @@ paths: address_1: type: string title: address_1 - description: The billing address's address 1. + description: The billing address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The billing address's second line. city: type: string title: city @@ -14229,11 +13323,11 @@ paths: address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The shipping address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The shipping address's second line. city: type: string title: city @@ -14258,7 +13352,7 @@ paths: description: The draft order's items. items: type: object - description: The item's items. + description: The item's details. required: - title - sku @@ -14275,7 +13369,7 @@ paths: sku: type: string title: sku - description: The item's sku. + description: The item's SKU. barcode: type: string title: barcode @@ -14283,7 +13377,7 @@ paths: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. unit_price: oneOf: - type: string @@ -14305,25 +13399,25 @@ paths: precision: type: number title: precision - description: The unit price's precision. + description: The unit price's rounding precision. quantity: type: number title: quantity - description: The item's quantity. + description: The item's ordered quantity. metadata: type: object description: The item's metadata. region_id: type: string title: region_id - description: The draft order's region id. + description: The ID of the associated region. promo_codes: type: array - description: The draft order's promo codes. + description: The promotion codes applied on the draft order. items: type: string title: promo_codes - description: The promo code's promo codes. + description: A promotion code. currency_code: type: string title: currency_code @@ -14331,16 +13425,14 @@ paths: no_notification_order: type: boolean title: no_notification_order - description: The draft order's no notification order. + description: Whether to send the customer notifications on order changes. shipping_methods: type: array description: The draft order's shipping methods. items: type: object - description: The shipping method's shipping methods. + description: The shipping method's details. required: - - shipping_method_id - - order_id - name - option_id - amount @@ -14348,11 +13440,7 @@ paths: shipping_method_id: type: string title: shipping_method_id - description: The shipping method's shipping method id. - order_id: - type: string - title: order_id - description: The shipping method's order id. + description: The ID of an existing shipping method. name: type: string title: name @@ -14360,10 +13448,12 @@ paths: option_id: type: string title: option_id - description: The shipping method's option id. + description: The ID of the shipping option this method is created from. data: type: object - description: The shipping method's data. + description: The shipping method's data, useful for fulfillment providers. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property amount: oneOf: - type: string @@ -14385,17 +13475,17 @@ paths: precision: type: number title: precision - description: The amount's precision. + description: The amount's rounding precision. metadata: type: object description: The draft order's metadata. - type: object - description: SUMMARY + description: The draft order's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The draft order's details. x-codeSamples: - lang: Shell label: cURL @@ -15355,7 +14445,7 @@ paths: post: operationId: PostExchanges summary: Create Exchange - description: Create a exchange. + description: Create an exchange request. Its changes aren't applied on the order until the exchange is confirmed. x-authenticated: true parameters: - name: expand @@ -15374,30 +14464,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -15469,30 +14535,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -15527,8 +14569,8 @@ paths: /admin/exchanges/{id}/cancel: post: operationId: PostExchangesIdCancel - summary: Add Cancels to Exchange - description: Add a list of cancels to a exchange. + summary: Cancel an Exchange + description: Cancel an exchange and its associated return. x-authenticated: true parameters: - name: id @@ -15577,8 +14619,9 @@ paths: /admin/exchanges/{id}/inbound/items: post: operationId: PostExchangesIdInboundItems - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Add Inbound Items to an Exchange + x-sidebary-summary: Add Inbound Items + description: Add inbound (or return) items to an exchange. These inbound items will have the action `RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -15627,8 +14670,12 @@ paths: /admin/exchanges/{id}/inbound/items/{action_id}: post: operationId: PostExchangesIdInboundItemsAction_id - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Update an Inbount Item of an Exchange + x-sidebar-summary: Update Inbound Item + description: | + Update an inbound (or return) item from an exchange using the `ID` of the item's `RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -15639,7 +14686,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string @@ -15718,30 +14765,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -15775,8 +14798,9 @@ paths: /admin/exchanges/{id}/inbound/shipping-method: post: operationId: PostExchangesIdInboundShippingMethod - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Add an Inbound Shipping Method to an Exchange + x-sidebar-summary: Add Inbound Shipping + description: Add an inbound (or return) shipping method to an exchange. The inbound shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -15829,8 +14853,12 @@ paths: /admin/exchanges/{id}/inbound/shipping-method/{action_id}: post: operationId: PostExchangesIdInboundShippingMethodAction_id - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Update Inbound Shipping Method of an Exchange + x-sidebar-summary: Update Inbound Shipping + description: | + Update the shipping method for returning items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -15841,7 +14869,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -15861,30 +14889,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -15977,8 +14981,8 @@ paths: /admin/exchanges/{id}/outbound/items: post: operationId: PostExchangesIdOutboundItems - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Add Outbound Items to Exchange + description: Add outbound (or new) items to an exchange. These outbound items will have the action `ITEM_ADD`. x-authenticated: true parameters: - name: id @@ -16003,30 +15007,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16067,8 +15047,12 @@ paths: /admin/exchanges/{id}/outbound/items/{action_id}: post: operationId: PostExchangesIdOutboundItemsAction_id - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Update Outbound Item of an Exchange + x-sidebar-summary: Update Outbound Item + description: | + Update an outbound (or new) item from an exchange using the `ID` of the item's `ITEM_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -16079,7 +15063,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the new exchange item's `ITEM_ADD` action. required: true schema: type: string @@ -16099,30 +15083,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16198,30 +15158,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16255,8 +15191,9 @@ paths: /admin/exchanges/{id}/outbound/shipping-method: post: operationId: PostExchangesIdOutboundShippingMethod - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Add Outbound Shipping Method to Exchange + x-sidebar-summary: Add Outbound Shipping + description: Add an outbound shipping method to an exchange. The outbound shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -16281,30 +15218,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16349,8 +15262,12 @@ paths: /admin/exchanges/{id}/outbound/shipping-method/{action_id}: post: operationId: PostExchangesIdOutboundShippingMethodAction_id - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Update Outbound Shipping Method of Exchange + x-sidebar-summary: Update Outbound Shipping + description: | + Update the shipping method for delivering outbound items in the exchange using the `ID` of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -16361,7 +15278,7 @@ paths: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -16381,30 +15298,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16480,30 +15373,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16537,8 +15406,8 @@ paths: /admin/exchanges/{id}/request: post: operationId: PostExchangesIdRequest - summary: Add Requests to Exchange - description: Add a list of requests to a exchange. + summary: Confirm an Exchange + description: Confirm an exchange request, applying its changes on the associated order. x-authenticated: true parameters: - name: id @@ -16563,30 +15432,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16837,8 +15682,9 @@ paths: /admin/fulfillment-sets/{id}/service-zones: post: operationId: PostFulfillmentSetsIdServiceZones - summary: Add Service Zones to Fulfillment Set - description: Add a list of service zones to a fulfillment set. + summary: Add a Service Zone to a Fulfillment Set + x-sidebar-summary: Add Service Zone + description: Add a service zone to a fulfillment set. x-authenticated: true parameters: - name: id @@ -16863,30 +15709,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -16896,21 +15718,21 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The service zone's details. required: - name properties: name: type: string title: name - description: The fulfillment set's name. + description: The service zone's name. geo_zones: type: array - description: The fulfillment set's geo zones. + description: The service zone's geo zones. items: oneOf: - type: object - description: The geo zone's geo zones. + description: A country geo zone. required: - metadata - country_code @@ -16927,8 +15749,9 @@ paths: type: string title: type description: The geo zone's type. + default: country - type: object - description: The geo zone's geo zones. + description: A province geo zone. required: - metadata - country_code @@ -16946,12 +15769,13 @@ paths: type: string title: type description: The geo zone's type. + default: province province_code: type: string title: province_code description: The geo zone's province code. - type: object - description: The geo zone's geo zones. + description: A city geo zone required: - metadata - country_code @@ -16970,6 +15794,7 @@ paths: type: string title: type description: The geo zone's type. + default: city province_code: type: string title: province_code @@ -16979,7 +15804,7 @@ paths: title: city description: The geo zone's city. - type: object - description: The geo zone's geo zones. + description: A ZIP geo zone. required: - metadata - country_code @@ -16999,6 +15824,7 @@ paths: type: string title: type description: The geo zone's type. + default: zip province_code: type: string title: province_code @@ -17009,7 +15835,7 @@ paths: description: The geo zone's city. postal_expression: type: object - description: The geo zone's postal expression. + description: The geo zone's postal expression or ZIP code. x-codeSamples: - lang: Shell label: cURL @@ -17078,30 +15904,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -17135,8 +15937,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostFulfillmentSetsIdServiceZonesZone_id - summary: Add Service Zones to Fulfillment Set - description: Add a list of service zones to a fulfillment set. + summary: Update the Service Zone of a Fulfillment Set + x-sidebar-summary: Update Service Zone + description: Update the details of a service zone in a fulfillment set. x-authenticated: true parameters: - name: id @@ -17147,7 +15950,7 @@ paths: type: string - name: zone_id in: path - description: The fulfillment set's zone id. + description: The service zone's ID. required: true schema: type: string @@ -17167,30 +15970,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -17200,21 +15979,19 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - name + description: The service zone's details. properties: name: type: string title: name - description: The fulfillment set's name. + description: The service zone's name. geo_zones: type: array - description: The fulfillment set's geo zones. + description: The service zone's associated geo zones. items: oneOf: - type: object - description: The geo zone's geo zones. + description: A country geo zone. required: - type - metadata @@ -17224,6 +16001,7 @@ paths: type: string title: type description: The geo zone's type. + default: country metadata: type: object description: The geo zone's metadata. @@ -17234,9 +16012,9 @@ paths: id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. - type: object - description: The geo zone's geo zones. + description: A province geo zone. required: - type - metadata @@ -17247,6 +16025,7 @@ paths: type: string title: type description: The geo zone's type. + default: province metadata: type: object description: The geo zone's metadata. @@ -17261,9 +16040,9 @@ paths: id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. - type: object - description: The geo zone's geo zones. + description: A city geo zone required: - type - metadata @@ -17275,6 +16054,7 @@ paths: type: string title: type description: The geo zone's type. + default: city metadata: type: object description: The geo zone's metadata. @@ -17293,9 +16073,9 @@ paths: id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. - type: object - description: The geo zone's geo zones. + description: A ZIP geo zone. required: - type - metadata @@ -17308,6 +16088,7 @@ paths: type: string title: type description: The geo zone's type. + default: zip metadata: type: object description: The geo zone's metadata. @@ -17325,11 +16106,11 @@ paths: description: The geo zone's province code. postal_expression: type: object - description: The geo zone's postal expression. + description: The geo zone's postal expression or ZIP code. id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. x-codeSamples: - lang: Shell label: cURL @@ -17415,7 +16196,7 @@ paths: post: operationId: PostFulfillments summary: Create Fulfillment - description: Create a fulfillment. + description: Create a fulfillment for an order, return, exchange, and more. x-authenticated: true parameters: - name: expand @@ -17434,30 +16215,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -17542,8 +16299,11 @@ paths: /admin/fulfillments/{id}/cancel: post: operationId: PostFulfillmentsIdCancel - summary: Add Cancels to Fulfillment - description: Add a list of cancels to a fulfillment. + summary: Cancel a Fulfillment + description: | + Cancel a fulfillment. The fulfillment can't be shipped or delivered. + + To cancel the fulfillment, the `cancelFulfillment` method of the associated fulfillment provider is used. x-authenticated: true parameters: - name: id @@ -17568,30 +16328,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -17632,8 +16368,9 @@ paths: /admin/fulfillments/{id}/shipment: post: operationId: PostFulfillmentsIdShipment - summary: Add Shipments to Fulfillment - description: Add a list of shipments to a fulfillment. + summary: Create a Shipment for a Fulfillment + x-sidebar-summary: Create Shipment + description: Create a shipment for a fulfillment. The fulfillment must not be shipped or canceled. x-authenticated: true parameters: - name: id @@ -17658,30 +16395,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -18174,7 +16887,7 @@ paths: post: operationId: PostInventoryItems summary: Create Inventory Item - description: Create a inventory item. + description: Create an inventory item. x-authenticated: true parameters: - name: expand @@ -18193,30 +16906,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -18299,30 +16988,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -18356,8 +17021,8 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostInventoryItemsId - summary: Update a Inventory Item - description: Update a inventory item's details. + summary: Update an Inventory Item + description: Update an inventory item's details. x-authenticated: true parameters: - name: id @@ -18382,30 +17047,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -18415,30 +17056,16 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - sku - - hs_code - - weight - - length - - height - - width - - origin_country - - mid_code - - material - - title - - description - - thumbnail - - metadata + description: The properties to update in the inventory item. properties: sku: type: string title: sku - description: The inventory item's sku. + description: The inventory item's SKU. hs_code: type: string title: hs_code - description: The inventory item's hs code. + description: The inventory item's HS code. weight: type: number title: weight @@ -18462,7 +17089,7 @@ paths: mid_code: type: string title: mid_code - description: The inventory item's mid code. + description: The inventory item's MID code. material: type: string title: material @@ -18478,14 +17105,14 @@ paths: requires_shipping: type: boolean title: requires_shipping - description: The inventory item's requires shipping. + description: Whether the inventory item requires shipping. thumbnail: type: string title: thumbnail - description: The inventory item's thumbnail. + description: The URL of an image to be used as the inventory item's thumbnail. You can use the Upload API routes to upload an image and get its URL. metadata: type: object - description: The inventory item's metadata. + description: The inventory item's metadata. Can be custom data in key-value pairs. x-codeSamples: - lang: Shell label: cURL @@ -18740,8 +17367,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostInventoryItemsIdLocationLevels - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. + summary: Create Inventory Level for Inventory Item + x-sidebar-summary: Create Inventory Level + description: Create an inventory level for an inventory item. x-authenticated: true parameters: - name: id @@ -18766,30 +17394,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -18799,22 +17403,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The inventory level's details. required: - location_id properties: location_id: type: string title: location_id - description: The inventory item's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity - description: The inventory item's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The inventory item's incoming quantity. + description: The inventory level's incoming quantity. x-codeSamples: - lang: Shell label: cURL @@ -18850,8 +17454,9 @@ paths: /admin/inventory-items/{id}/location-levels/batch: post: operationId: PostInventoryItemsIdLocationLevelsBatch - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. + summary: Manage Inventory Levels of Inventory Item + x-sidebar-summary: Manage Inventory Levels + description: Manage the inventory levels of an inventory item to create or delete them. x-authenticated: true parameters: - name: id @@ -18869,51 +17474,51 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The inventory levels to create or delete. properties: create: type: array - description: The inventory item's create. + description: The inventory levels to create. items: type: object - description: The create's details. + description: The inventory level's details. required: - location_id properties: location_id: type: string title: location_id - description: The create's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity - description: The create's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The create's incoming quantity. + description: The inventory level's incoming quantity. update: type: array - description: The inventory item's update. + description: The inventory levels to update. items: type: object - description: The update's details. + description: The inventory level's details. properties: stocked_quantity: type: number title: stocked_quantity - description: The update's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The update's incoming quantity. + description: The inventory level's incoming quantity. delete: type: array - description: The inventory item's delete. + description: The inventory levels to delete. items: type: string title: delete - description: The delete's details. + description: The ID of the inventory level to delete. x-codeSamples: - lang: Shell label: cURL @@ -18929,7 +17534,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The inventory item's details. required: - inventory_item properties: @@ -18952,8 +17557,9 @@ paths: /admin/inventory-items/{id}/location-levels/{location_id}: post: operationId: PostInventoryItemsIdLocationLevelsLocation_id - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. + summary: Update an Inventory Level of an Inventory Item + x-sidebar-summary: Update Inventory Level + description: Updates the details of an inventory item's inventory level using its associated location ID. x-authenticated: true parameters: - name: id @@ -18964,7 +17570,7 @@ paths: type: string - name: location_id in: path - description: The inventory item's location id. + description: The ID of the location associated with the inventory level. required: true schema: type: string @@ -18984,30 +17590,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -19017,16 +17599,16 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The properties to update in the inventory level. properties: stocked_quantity: type: number title: stocked_quantity - description: The inventory item's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The inventory item's incoming quantity. + description: The inventory level's incoming quantity. x-codeSamples: - lang: Shell label: cURL @@ -19093,30 +17675,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -19708,47 +18266,23 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: schema: type: object - description: SUMMARY + description: The invite's details. required: - email properties: email: type: string title: email - description: The invite's email. + description: The email of the user to invite. format: email metadata: type: object - description: The invite's metadata. + description: The invite's metadata. Can be custom data in key-value pairs. x-codeSamples: - lang: Shell label: cURL @@ -19783,74 +18317,31 @@ paths: /admin/invites/accept: post: operationId: PostInvitesAccept - summary: Create Invite - description: Create a invite. + summary: Accept Invite + description: | + Accept an invite and create a new user. + Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route. 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. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: schema: type: object - description: SUMMARY - required: - - email - - first_name - - last_name + description: The details of the user to be created. properties: email: type: string title: email - description: The invite's email. + description: The user's email. format: email first_name: type: string title: first_name - description: The invite's first name. + description: The user's first name. last_name: type: string title: last_name - description: The invite's last name. + description: The user's last name. x-codeSamples: - lang: Shell label: cURL @@ -19872,21 +18363,21 @@ paths: schema: oneOf: - type: object - description: SUMMARY + description: The created user's details. required: - user properties: user: $ref: '#/components/schemas/AdminUser' - type: object - description: SUMMARY + description: An error's details. required: - message properties: message: type: string title: message - description: The invite's message. + description: The error message. '400': $ref: '#/components/responses/400_error' '401': @@ -19929,30 +18420,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -20038,8 +18505,8 @@ paths: /admin/invites/{id}/resend: post: operationId: PostInvitesIdResend - summary: Add Resends to Invite - description: Add a list of resends to a invite. + summary: Refresh Invite Token + description: Refresh the token of an invite. x-authenticated: false parameters: - name: id @@ -20064,30 +18531,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -20281,30 +18724,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -20340,9 +18759,8 @@ paths: post: operationId: PostOrderEdits summary: Create Order Edit - description: Create a order edit. + description: Create an order edit. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] @@ -20452,8 +18870,8 @@ paths: /admin/order-edits/{id}/confirm: post: operationId: PostOrderEditsIdConfirm - summary: Add Confirms to Order Edit - description: Add a list of confirms to a order edit. + summary: Confirm Order Edit + description: Confirm an order edit request and apply the changes on the order. x-authenticated: true parameters: - name: id @@ -20494,15 +18912,12 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: confirmOrderEditRequestWorkflow - requestBody: - content: - application/json: - schema: {} /admin/order-edits/{id}/items: post: operationId: PostOrderEditsIdItems summary: Add Items to Order Edit - description: Add a list of items to a order edit. + x-sidebar-summary: Add Items + description: Add new items to an order edit. These items will have the action `ITEM_ADD`. x-authenticated: true parameters: - name: id @@ -20551,8 +18966,9 @@ paths: /admin/order-edits/{id}/items/item/{item_id}: post: operationId: PostOrderEditsIdItemsItemItem_id - summary: Add Items to Order Edit - description: Add a list of items to a order edit. + summary: Update Order Item Quantity of Order Edit + x-sidebar-summary: Update Item Quantity + description: Update an existing order item's quantity of an order edit. x-authenticated: true parameters: - name: id @@ -20611,8 +19027,12 @@ paths: /admin/order-edits/{id}/items/{action_id}: post: operationId: PostOrderEditsIdItemsAction_id - summary: Add Items to Order Edit - description: Add a list of items to a order edit. + summary: Update an Item in an Order Edit + x-sidebar-summary: Update Item + description: | + Update an added item in the order edit by the ID of the item's `ITEM_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -20623,7 +19043,7 @@ paths: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the new item's `ITEM_ADD` action. required: true schema: type: string @@ -20721,8 +19141,8 @@ paths: /admin/order-edits/{id}/request: post: operationId: PostOrderEditsIdRequest - summary: Add Requests to Order Edit - description: Add a list of requests to a order edit. + summary: Request Order Edit + description: Change the status of an active order edit to requested. x-authenticated: true parameters: - name: id @@ -20763,15 +19183,12 @@ paths: '500': $ref: '#/components/responses/500_error' x-workflow: requestOrderEditRequestWorkflow - requestBody: - content: - application/json: - schema: {} /admin/order-edits/{id}/shipping-method: post: operationId: PostOrderEditsIdShippingMethod - summary: Add Shipping Methods to Order Edit - description: Add a list of shipping methods to a order edit. + summary: Add Shipping Method to Order Edit + x-sidebar-summary: Add Shipping Method + description: Add a shipping method to an exchange. The shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -20824,8 +19241,12 @@ paths: /admin/order-edits/{id}/shipping-method/{action_id}: post: operationId: PostOrderEditsIdShippingMethodAction_id - summary: Add Shipping Methods to Order Edit - description: Add a list of shipping methods to a order edit. + summary: Update Shipping Method of an Order Edit + x-sidebar-summary: Update Shipping Method + description: | + Update a shipping method in the order edit by the ID of the method's `SHIPPING_ADD` action. + + Every shipping method has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -20836,7 +19257,7 @@ paths: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -21028,25 +19449,25 @@ paths: title: $or - name: sales_channel_id in: query - description: The order's sales channel id. + description: Filter by sales channel IDs to retrieve the orders associated with them. required: false schema: type: array - description: The order's sales channel id. + description: Filter by sales channel IDs to retrieve the orders associated with them. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: fulfillment_status in: query - description: The order's fulfillment status. + description: Filter by the order's fulfillment status. required: false schema: type: array - description: The order's fulfillment status. + description: Filter by the order's fulfillment status. items: type: string - description: The fulfillment status's details. + description: A fulfillment status. enum: - canceled - not_fulfilled @@ -21058,14 +19479,14 @@ paths: - delivered - name: payment_status in: query - description: The order's payment status. + description: Filter by the order's payment status. required: false schema: type: array - description: The order's payment status. + description: Filter by the order's payment status. items: type: string - description: The payment status's details. + description: A payment status enum: - canceled - not_paid @@ -21079,30 +19500,30 @@ paths: - requires_action - name: region_id in: query - description: The order's region id. + description: Filter by region IDs to retrieve their associated orders. required: false schema: type: array - description: The order's region id. + description: Filter by region IDs to retrieve their associated orders. items: type: string title: region_id - description: The region id's details. + description: A region ID. - name: q in: query - description: The order's q. + description: Search term to filter the order's searchable properties. required: false schema: type: string title: q - description: The order's q. + description: Search term to filter the order's searchable properties. - name: created_at in: query - description: The order's created at. + description: Filter by the order's creation date. required: false schema: type: object - description: The order's created at. + description: Filter by the order's creation date. properties: $and: type: array @@ -21122,11 +19543,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -21137,19 +19558,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -21171,42 +19592,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter - type: object description: Filter by values not matching the conditions in this parameter. - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -21245,31 +19666,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The value to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -21308,32 +19729,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The order's updated at. + description: Filter by the order's update date. required: false schema: type: object - description: The order's updated at. + description: Filter by the order's update date. properties: $and: type: array @@ -21353,11 +19774,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -21368,19 +19789,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -21402,42 +19823,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter - type: object description: Filter by values not matching the conditions in this parameter. - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -21476,31 +19897,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The value to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -21539,21 +19960,21 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -21648,30 +20069,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -21706,8 +20103,8 @@ paths: x-workflow: getOrderDetailWorkflow post: operationId: PostOrdersId - summary: Update a Order - description: Update a order's details. + summary: Update an Order + description: Update an order's details. x-authenticated: true parameters: - name: id @@ -21732,30 +20129,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -21794,8 +20167,8 @@ paths: /admin/orders/{id}/archive: post: operationId: PostOrdersIdArchive - summary: Add Archives to Order - description: Add a list of archives to a order. + summary: Archive an Order + description: Change the status of an order to archived. x-authenticated: true parameters: - name: id @@ -21820,30 +20193,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -21888,8 +20237,16 @@ paths: /admin/orders/{id}/cancel: post: operationId: PostOrdersIdCancel - summary: Add Cancels to Order - description: Add a list of cancels to a order. + summary: Cancel Order + description: | + Cancel an order. The cancelation fails if: + - The order has captured payments. + + + - The order has refund payments. + + + - The order has fulfillments that aren't canceled. x-authenticated: true parameters: - name: id @@ -21914,30 +20271,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22013,30 +20346,6 @@ paths: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22071,8 +20380,8 @@ paths: /admin/orders/{id}/complete: post: operationId: PostOrdersIdComplete - summary: Add Completes to Order - description: Add a list of completes to a order. + summary: Complete Order + description: Mark an order as completed. x-authenticated: true parameters: - name: id @@ -22097,30 +20406,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22129,23 +20414,12 @@ paths: content: application/json: schema: - allOf: - - type: object - description: SUMMARY - required: - - order_id - properties: - order_id: - type: string - title: order_id - description: The order's order id. - - type: object - description: SUMMARY - properties: - additional_data: - type: object - description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. + properties: + additional_data: + type: object + description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. x-codeSamples: - lang: Shell label: cURL @@ -22181,8 +20455,9 @@ paths: /admin/orders/{id}/fulfillments: post: operationId: PostOrdersIdFulfillments - summary: Add Fulfillments to Order - description: Add a list of fulfillments to a order. + summary: Create an Order Fulfillment + x-sidebar-summary: Create Fulfillment + description: Create a fulfillment for an order. The creation fails if the order is canceled. x-authenticated: true parameters: - name: id @@ -22207,30 +20482,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22241,7 +20492,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The fulfillment's details. required: - items - location_id @@ -22249,10 +20500,10 @@ paths: properties: items: type: array - description: The order's items. + description: The items to fulfill. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -22264,25 +20515,25 @@ paths: quantity: type: number title: quantity - description: The item's quantity. + description: The item's quantity to fulfill. location_id: type: string title: location_id - description: The order's location id. + description: The ID of the location to fulfill the items from. If not provided, the location associated with the shipping option of the order's shipping method is used. no_notification: type: boolean title: no_notification - description: The order's no notification. + description: Whether to send the customer a notification about the created fulfillment. metadata: type: object - description: The order's metadata. + description: The order's metadata. Can hold custom key-value pairs. - type: object - description: SUMMARY + description: The fulfillment's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The fulfillment's details. x-codeSamples: - lang: Shell label: cURL @@ -22325,8 +20576,8 @@ paths: /admin/orders/{id}/fulfillments/{fulfillment_id}/cancel: post: operationId: PostOrdersIdFulfillmentsFulfillment_idCancel - summary: Add Cancels to Order - description: Add a list of cancels to a order. + summary: Cancel Fulfillment + description: Cancel an order's fulfillment. The fulfillment can't be canceled if it's shipped. x-authenticated: true parameters: - name: id @@ -22357,30 +20608,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22391,19 +20618,19 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The cancelation details. properties: no_notification: type: boolean title: no_notification - description: The order's no notification. + description: Whether the customer should receive a notification about this change. - type: object - description: SUMMARY + description: The cancelation details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The cancelation details. x-codeSamples: - lang: Shell label: cURL @@ -22435,8 +20662,9 @@ paths: /admin/orders/{id}/fulfillments/{fulfillment_id}/shipments: post: operationId: PostOrdersIdFulfillmentsFulfillment_idShipments - summary: Add Shipments to Order - description: Add a list of shipments to a order. + summary: Create Shipment for an Order's Fulfillment + x-sidebar-summary: Create Shipment + description: Create a shipment for an order's fulfillment. x-authenticated: true parameters: - name: id @@ -22447,7 +20675,7 @@ paths: type: string - name: fulfillment_id in: path - description: The order's fulfillment id. + description: The fulfillment's ID. required: true schema: type: string @@ -22467,30 +20695,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22501,17 +20705,17 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The shipment's details. required: - items - metadata properties: items: type: array - description: The order's items. + description: The items to create shipment for. items: type: object - description: The item's items. + description: The details of the item to create shipment for. required: - id - quantity @@ -22523,10 +20727,10 @@ paths: quantity: type: number title: quantity - description: The item's quantity. + description: The item's quantity to ship. labels: type: array - description: The order's labels. + description: The labels to create for the shipment. items: type: object description: The label's labels. @@ -22546,21 +20750,21 @@ paths: label_url: type: string title: label_url - description: The label's label url. + description: The label's url. no_notification: type: boolean title: no_notification - description: The order's no notification. + description: Whether to send the customer a notification about the created shipment. metadata: type: object - description: The order's metadata. + description: The shipment's metadata. Can hold custom key-value pairs. - type: object - description: SUMMARY + description: The shipment's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The shipment's details. x-codeSamples: - lang: Shell label: cURL @@ -22666,30 +20870,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22699,7 +20879,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The payment collection's details. required: - order_id - amount @@ -22707,11 +20887,11 @@ paths: order_id: type: string title: order_id - description: The payment collection's order id. + description: The ID of the associated order. amount: type: number title: amount - description: The payment collection's amount. + description: The amount to be paid. x-codeSamples: - lang: Shell label: cURL @@ -22792,8 +20972,9 @@ paths: /admin/payment-collections/{id}/mark-as-paid: post: operationId: PostPaymentCollectionsIdMarkAsPaid - summary: Add Mark As Paids to Payment Collection - description: Add a list of mark as paids to a payment collection. + summary: Mark a Payment Collection as Paid + x-sidebar-summary: Mark as Paid + description: Mark a payment collection as paid. This creates and authorizes a payment session, then capture its payment, using the manual payment provider. x-authenticated: true parameters: - name: id @@ -22818,30 +20999,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -22851,14 +21008,14 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The payment details. required: - order_id properties: order_id: type: string title: order_id - description: The payment collection's order id. + description: The ID of the order associated with the payment collection. x-codeSamples: - lang: Shell label: cURL @@ -23585,30 +21742,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -23643,8 +21776,8 @@ paths: /admin/payments/{id}/capture: post: operationId: PostPaymentsIdCapture - summary: Add Captures to Payment - description: Add a list of captures to a payment. + summary: Capture Payment + description: Capture an amount of a payment. This uses the `capturePayment` method of the payment provider associated with the payment's collection. x-authenticated: true parameters: - name: id @@ -23669,30 +21802,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -23702,12 +21811,12 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The payment's details. properties: amount: type: number title: amount - description: The payment's amount. + description: The amount to capture. x-codeSamples: - lang: Shell label: cURL @@ -23739,8 +21848,8 @@ paths: /admin/payments/{id}/refund: post: operationId: PostPaymentsIdRefund - summary: Add Refunds to Payment - description: Add a list of refunds to a payment. + summary: Refund Payment + description: Refund an amount of a payment. This uses the `refundPayment` method of the payment provider associated with the payment's collection. x-authenticated: true parameters: - name: id @@ -23765,30 +21874,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -23798,20 +21883,20 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The refund's details. properties: amount: type: number title: amount - description: The payment's amount. + description: The amount to refund. refund_reason_id: type: string title: refund_reason_id - description: The payment's refund reason id. + description: The ID of a refund reason. note: type: string title: note - description: The payment's note. + description: A note to attach to the refund. x-codeSamples: - lang: Shell label: cURL @@ -24244,30 +22329,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -24341,30 +22402,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -24424,30 +22461,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -24538,8 +22551,9 @@ paths: /admin/price-lists/{id}/prices/batch: post: operationId: PostPriceListsIdPricesBatch - summary: Add Prices to Price List - description: Add a list of prices to a price list. + summary: Manage Prices in Price List + x-sidebar-summary: Manage Prices + description: Manage the prices of a price list to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -24557,90 +22571,90 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The prices to create, update, or delete. properties: create: type: array - description: The price list's create. + description: The prices to create. items: type: object - description: The create's details. + description: A price's details. required: - currency_code - amount - variant_id - - min_quantity - - max_quantity properties: currency_code: type: string title: currency_code - description: The create's currency code. + description: The price's currency code. amount: type: number title: amount - description: The create's amount. + description: The price's amount. variant_id: type: string title: variant_id - description: The create's variant id. + description: The ID of the variant this price is for. min_quantity: type: number title: min_quantity - description: The create's min quantity. + description: The minimum quantity that must be available of the associated variant in the cart for this price to apply. max_quantity: type: number title: max_quantity - description: The create's max quantity. + description: The maximum quantity that must be available of the associated variant in the cart for this price list to apply. rules: type: object - description: The create's rules. + description: Key-value pair rules to apply on the price. + example: + region_id: 123 update: type: array - description: The price list's update. + description: The prices to update. items: type: object - description: The update's details. + description: The properties to update in a price. required: - id - variant_id - - min_quantity - - max_quantity properties: id: type: string title: id - description: The update's ID. + description: The price's ID. currency_code: type: string title: currency_code - description: The update's currency code. + description: The price's currency code. amount: type: number title: amount - description: The update's amount. + description: The price's amount. variant_id: type: string title: variant_id - description: The update's variant id. + description: The ID of the variant this price is for. min_quantity: type: number title: min_quantity - description: The update's min quantity. + description: The minimum quantity that must be available of the associated variant in the cart for this price to apply. max_quantity: type: number title: max_quantity - description: The update's max quantity. + description: The maximum quantity that must be available of the associated variant in the cart for this price list to apply. rules: type: object - description: The update's rules. + description: Key-value pair rules to apply on the price. + example: + region_id: 123 delete: type: array - description: The price list's delete. + description: The prices to delete. items: type: string title: delete - description: The delete's details. + description: A price's ID. x-codeSamples: - lang: Shell label: cURL @@ -24672,8 +22686,8 @@ paths: /admin/price-lists/{id}/products: post: operationId: PostPriceListsIdProducts - summary: Add Products to Price List - description: Add a list of products to a price list. + summary: Remove Products from Price List + description: Remove products from a price list. x-authenticated: true parameters: - name: id @@ -24698,30 +22712,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -24730,23 +22720,7 @@ paths: content: application/json: schema: - type: object - description: SUMMARY - properties: - add: - type: array - description: The price list's add. - items: - type: string - title: add - description: The add's details. - remove: - type: array - description: The price list's remove. - items: - type: string - title: remove - description: The remove's details. + $ref: '#/components/schemas/AdminLinkPriceListProducts' x-codeSamples: - lang: Shell label: cURL @@ -24945,30 +22919,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -25035,30 +22985,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -25118,30 +23044,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -25808,30 +23710,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -25904,30 +23782,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: include_ancestors_tree in: query description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. @@ -26003,30 +23857,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -26036,10 +23866,7 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - parent_category_id - - metadata + description: The properties to update in the product category. properties: name: type: string @@ -26052,26 +23879,26 @@ paths: handle: type: string title: handle - description: The product category's handle. + description: The product category's handle. Must be a unique value. is_internal: type: boolean title: is_internal - description: The product category's is internal. + description: Whether the product category is only used for internal purposes and shouldn't be shown the customer. is_active: type: boolean title: is_active - description: The product category's is active. + description: Whether the product category is active. parent_category_id: type: string title: parent_category_id - description: The product category's parent category id. + description: The ID of a parent category. metadata: type: object - description: The product category's metadata. + description: The product category's metadata. Can hold custom key-value pairs. rank: type: number title: rank - description: The product category's rank. + description: The product category's rank among other categories. x-codeSamples: - lang: Shell label: cURL @@ -26152,8 +23979,9 @@ paths: /admin/product-categories/{id}/products: post: operationId: PostProductCategoriesIdProducts - summary: Add Products to Product Category - description: Add a list of products to a product category. + summary: Manage Products in Product Category + x-sidebar-summary: Manage Products + description: Manage products of a category to add or remove them. x-authenticated: true parameters: - name: id @@ -26178,30 +24006,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -26211,22 +24015,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The products to add or remove from the category. properties: add: type: array - description: The product category's add. + description: The products to add. items: type: string title: add - description: The add's details. + description: A product ID. remove: type: array - description: The product category's remove. + description: The product to remove. items: type: string title: remove - description: The remove's details. + description: A product ID. x-codeSamples: - lang: Shell label: cURL @@ -26766,30 +24570,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -26861,30 +24641,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -26944,30 +24700,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -26977,9 +24709,7 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The properties to update in the product tag. properties: value: type: string @@ -26987,7 +24717,7 @@ paths: description: The product tag's value. metadata: type: object - description: The product tag's metadata. + description: The product tag's metadata. Can hold custom key-value pairs. x-codeSamples: - lang: Shell label: cURL @@ -27575,30 +25305,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -27670,30 +25376,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -27753,30 +25435,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -27786,9 +25444,7 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The properties to update in the product type. properties: value: type: string @@ -27796,7 +25452,7 @@ paths: description: The product type's value. metadata: type: object - description: The product type's metadata. + description: The product type's metadata. Can hold custom key-value pairs. x-codeSamples: - lang: Shell label: cURL @@ -29060,30 +26716,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29095,12 +26727,12 @@ paths: allOf: - $ref: '#/components/schemas/AdminCreateProduct' - type: object - description: SUMMARY + description: The product's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The product's details. x-codeSamples: - lang: Shell label: cURL @@ -29136,8 +26768,8 @@ paths: /admin/products/batch: post: operationId: PostProductsBatch - summary: Create Product - description: Create a product. + summary: Manage Products + description: Manage products to create, update, or delete them. x-authenticated: true parameters: - name: expand @@ -29156,30 +26788,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29220,8 +26828,12 @@ paths: /admin/products/export: post: operationId: PostProductsExport - summary: Create Product - description: Create a product. + summary: Export Products + description: | + Start a product export process to retrieve a CSV of exported products. + + You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`. + 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 @@ -29240,30 +26852,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29304,10 +26892,9 @@ paths: /admin/products/import: post: operationId: PostProductsImport - summary: Create Product - description: Create a product. + summary: Create Product Import + description: Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/import` API route. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] @@ -29348,13 +26935,13 @@ paths: /admin/products/import/{transaction_id}/confirm: post: operationId: PostProductsImportTransaction_idConfirm - summary: Add Confirms to Product - description: Add a list of confirms to a product. + summary: Confirm Product Import + description: Confirm that a created product import should start importing the products into Medusa. x-authenticated: true parameters: - name: transaction_id in: path - description: The product's transaction id. + description: The ID of the transaction returned when the product import was created. required: true schema: type: string @@ -29383,10 +26970,6 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' - requestBody: - content: - application/json: - schema: {} x-workflow: importProductsWorkflowId /admin/products/{id}: get: @@ -29417,30 +27000,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29500,30 +27059,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29535,12 +27070,12 @@ paths: allOf: - $ref: '#/components/schemas/AdminUpdateProduct' - type: object - description: SUMMARY + description: The properties to update in a product. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in a product. x-codeSamples: - lang: Shell label: cURL @@ -29785,8 +27320,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostProductsIdOptions - summary: Add Options to Product - description: Add a list of options to a product. + summary: Create a Product Option + x-sidebar-summary: Create Option + description: Create an option for a product. x-authenticated: true parameters: - name: id @@ -29811,30 +27347,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29846,12 +27358,12 @@ paths: allOf: - $ref: '#/components/schemas/AdminCreateProductOption' - type: object - description: SUMMARY + description: The product option's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The product option's details. x-codeSamples: - lang: Shell label: cURL @@ -29923,30 +27435,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -29980,8 +27468,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostProductsIdOptionsOption_id - summary: Add Options to Product - description: Add a list of options to a product. + summary: Update a Product's Option + x-sidebar-summary: Update Option + description: Update the details of a product option. x-authenticated: true parameters: - name: id @@ -29992,7 +27481,7 @@ paths: type: string - name: option_id in: path - description: The product's option id. + description: The option's ID. required: true schema: type: string @@ -30012,30 +27501,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -30047,12 +27512,12 @@ paths: allOf: - $ref: '#/components/schemas/AdminUpdateProductOption' - type: object - description: SUMMARY + description: The properties to update in the product option. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in the product option. x-codeSamples: - lang: Shell label: cURL @@ -30119,30 +27584,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -30706,8 +28147,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostProductsIdVariants - summary: Add Variants to Product - description: Add a list of variants to a product. + summary: Create a Product Variant + x-sidebar-summary: Create Variant + description: Create a variant for a product. x-authenticated: true parameters: - name: id @@ -30732,30 +28174,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -30767,12 +28185,12 @@ paths: allOf: - $ref: '#/components/schemas/AdminCreateProductVariant' - type: object - description: SUMMARY + description: The product variant's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The product variant's details. x-codeSamples: - lang: Shell label: cURL @@ -30809,8 +28227,9 @@ paths: /admin/products/{id}/variants/batch: post: operationId: PostProductsIdVariantsBatch - summary: Add Variants to Product - description: Add a list of variants to a product. + summary: Manage Variants in a Product + x-sidebary-summary: Manage Variants + description: Manage variants in a product to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -30835,30 +28254,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -30899,8 +28294,9 @@ paths: /admin/products/{id}/variants/inventory-items/batch: post: operationId: PostProductsIdVariantsInventoryItemsBatch - summary: Add Inventory Items to Product - description: Add a list of inventory items to a product. + summary: Manage Variants Inventory in a Product + x-sidebar-summary: Manage Variants Inventory + description: Manage a product's variant's inventoris to associate them with inventory items, update their inventory items, or delete their association with inventory items. x-authenticated: true parameters: - name: id @@ -30918,14 +28314,14 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The product variant inventories to manage. properties: create: type: array - description: The product's create. + description: The The associations to create between product variants and inventory items. items: type: object - description: The create's details. + description: The associations to create between a product variant and an inventory item. required: - required_quantity - inventory_item_id @@ -30934,21 +28330,21 @@ paths: required_quantity: type: number title: required_quantity - description: The create's required quantity. + description: The variant's quantity. inventory_item_id: type: string title: inventory_item_id - description: The create's inventory item id. + description: The ID of the inventory item to associate the variant with. variant_id: type: string title: variant_id - description: The create's variant id. + description: The ID of the variant. update: type: array - description: The product's update. + description: The product variants to update their association with inventory items. items: type: object - description: The update's details. + description: Update a product variant's association with an inventory item. required: - required_quantity - inventory_item_id @@ -30957,21 +28353,21 @@ paths: required_quantity: type: number title: required_quantity - description: The update's required quantity. + description: The variant's quantity. inventory_item_id: type: string title: inventory_item_id - description: The update's inventory item id. + description: The ID of the inventory item the variant is associated with. variant_id: type: string title: variant_id - description: The update's variant id. + description: The ID of the variant. delete: type: array - description: The product's delete. + description: The product variants to delete their association with inventory items. items: type: object - description: The delete's details. + description: Delete a product variant's association with an inventory item. required: - inventory_item_id - variant_id @@ -30979,11 +28375,11 @@ paths: inventory_item_id: type: string title: inventory_item_id - description: The delete's inventory item id. + description: The ID of the inventory item associated with the variant. variant_id: type: string title: variant_id - description: The delete's variant id. + description: The ID of the variant. x-codeSamples: - lang: Shell label: cURL @@ -31048,30 +28444,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -31105,8 +28477,9 @@ paths: $ref: '#/components/responses/500_error' post: operationId: PostProductsIdVariantsVariant_id - summary: Add Variants to Product - description: Add a list of variants to a product. + summary: Update a Product Variant + x-sidebar-summary: Update Variant + description: Update a variant's details. x-authenticated: true parameters: - name: id @@ -31137,30 +28510,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -31172,12 +28521,12 @@ paths: allOf: - $ref: '#/components/schemas/AdminUpdateProductVariant' - type: object - description: SUMMARY + description: The properties to update in the variant. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in the variant. x-codeSamples: - lang: Shell label: cURL @@ -31241,30 +28590,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -31300,8 +28625,9 @@ paths: /admin/products/{id}/variants/{variant_id}/inventory-items: post: operationId: PostProductsIdVariantsVariant_idInventoryItems - summary: Add Inventory Items to Product - description: Add a list of inventory items to a product. + summary: Associate Variant with Inventory Item + x-sidebar-summary: Associate Variant's Inventory + description: Associate with a product variant an inventory item that manages its inventory details. x-authenticated: true parameters: - name: id @@ -31312,7 +28638,7 @@ paths: type: string - name: variant_id in: path - description: The product's variant id. + description: The variant's ID. required: true schema: type: string @@ -31332,30 +28658,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -31401,8 +28703,9 @@ paths: /admin/products/{id}/variants/{variant_id}/inventory-items/{inventory_item_id}: post: operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id - summary: Add Inventory Items to Product - description: Add a list of inventory items to a product. + summary: Update Product Variant's Inventory Details + x-sidebary-summary: Update Variant Inventory + description: Update the inventory item that manages the inventory details of a product variant. x-authenticated: true parameters: - name: id @@ -31413,13 +28716,13 @@ paths: type: string - name: variant_id in: path - description: The product's variant id. + description: The variant's ID. required: true schema: type: string - name: inventory_item_id in: path - description: The product's inventory item id. + description: The inventory item's ID. required: true schema: type: string @@ -31439,30 +28742,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -31545,30 +28824,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -32160,30 +29415,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -32194,7 +29425,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The promotion's details. required: - code - type @@ -32208,19 +29439,22 @@ paths: is_automatic: type: boolean title: is_automatic - description: The promotion's is automatic. + description: Whether the promotion is applied automatically. type: type: string + description: The promotion's type. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion enum: - standard - buyget campaign_id: type: string title: campaign_id - description: The promotion's campaign id. + description: The ID of the campaign that the promotion belongs to. campaign: type: object - description: The promotion's campaign. + description: The details of a campaign to create and add the promotion to it. required: - name - campaign_identifier @@ -32236,14 +29470,14 @@ paths: campaign_identifier: type: string title: campaign_identifier - description: The campaign's campaign identifier. + description: The campaign's identifier. description: type: string title: description description: The campaign's description. budget: type: object - description: The campaign's budget. + description: The campaign's budget which, when crossed, ends the campaign. required: - type - limit @@ -32251,6 +29485,8 @@ paths: properties: type: type: string + description: | + The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. Use `usage` to set a limit on the total number of times the campaign's promotions can be used. enum: - spend - usage @@ -32261,30 +29497,17 @@ paths: currency_code: type: string title: currency_code - description: The budget's currency code. + description: The campaign budget's currency code. This can't be edited later. starts_at: type: string title: starts_at - description: The campaign's starts at. + description: The campaign's start date. format: date-time ends_at: type: string title: ends_at - description: The campaign's ends at. + description: The campaign's end date. format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. application_method: type: object description: The promotion's application method. @@ -32305,7 +29528,7 @@ paths: value: type: number title: value - description: The application method's value. + description: The discounted amount applied by the associated promotion based on the `type`. currency_code: type: string title: currency_code @@ -32313,20 +29536,23 @@ paths: max_quantity: type: number title: max_quantity - description: The application method's max quantity. + description: The max quantity allowed in the cart for the associated promotion to be applied. type: type: string + description: The type of the application method indicating how the associated promotion is applied. enum: - fixed - percentage target_type: type: string + description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order. enum: - order - shipping_methods - items allocation: type: string + description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart. enum: - each - across @@ -32335,7 +29561,7 @@ paths: description: The application method's target rules. items: type: object - description: The target rule's target rules. + description: A target rule's details. required: - operator - description @@ -32344,6 +29570,7 @@ paths: properties: operator: type: string + description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -32359,24 +29586,27 @@ paths: attribute: type: string title: attribute - description: The target rule's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The target rule's values. + description: The attribute's value. + example: prod_123 - type: array - description: The target rule's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 buy_rules: type: array description: The application method's buy rules. items: type: object - description: The buy rule's buy rules. + description: A buy rule's details. required: - operator - description @@ -32385,6 +29615,7 @@ paths: properties: operator: type: string + description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -32400,32 +29631,35 @@ paths: attribute: type: string title: attribute - description: The buy rule's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The buy rule's values. + description: The attribute's value. + example: prod_123 - type: array - description: The buy rule's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 apply_to_quantity: type: number title: apply_to_quantity - description: The application method's apply to quantity. + description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`. buy_rules_min_quantity: type: number title: buy_rules_min_quantity - description: The application method's buy rules min quantity. + description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. rules: type: array description: The promotion's rules. items: type: object - description: The rule's rules. + description: A rule's details. required: - operator - description @@ -32434,6 +29668,7 @@ paths: properties: operator: type: string + description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -32449,25 +29684,28 @@ paths: attribute: type: string title: attribute - description: The rule's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The rule's values. + description: The attribute's value. + example: prod_123 - type: array - description: The rule's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 - type: object - description: SUMMARY + description: The promotion's details. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The promotion's details. x-codeSamples: - lang: Shell label: cURL @@ -32523,7 +29761,9 @@ paths: description: | Retrieve a list of attributes for the promotion and application method types specified in the query parameters. Only the attributes of the rule type specified in the path parameter are retrieved: - - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. + - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. + + - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. x-authenticated: true parameters: - name: rule_type @@ -32624,22 +29864,6 @@ paths: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: Comma-separated relations that should be expanded in the returned data. - - name: fields - in: query - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - required: false - schema: - type: string - title: fields - description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. @@ -32755,30 +29979,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -32838,30 +30038,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -32872,7 +30048,7 @@ paths: schema: allOf: - type: object - description: SUMMARY + description: The properties to update in a promotion. required: - campaign_id properties: @@ -32883,93 +30059,34 @@ paths: is_automatic: type: boolean title: is_automatic - description: The promotion's is automatic. + description: Whether the promotion is applied automatically. type: type: string + description: The promotion's type. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion enum: - standard - buyget campaign_id: type: string title: campaign_id - description: The promotion's campaign id. - campaign: - type: object - description: The promotion's campaign. - required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - type - - limit - - currency_code - properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: - type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + description: The ID of the campaign that the promotion belongs to. application_method: type: object - description: The promotion's application method. + description: The properties to update in the application method. required: + - id - description - max_quantity - currency_code - apply_to_quantity - buy_rules_min_quantity properties: + id: + type: string + title: id + description: The application method's ID. description: type: string title: description @@ -32977,169 +30094,49 @@ paths: value: type: number title: value - description: The application method's value. + description: The discounted amount applied by the associated promotion based on the `type`. max_quantity: type: number title: max_quantity - description: The application method's max quantity. + description: The max quantity allowed in the cart for the associated promotion to be applied. currency_code: type: string title: currency_code description: The application method's currency code. type: type: string + description: The type of the application method indicating how the associated promotion is applied. enum: - fixed - percentage target_type: type: string + description: The target type of the application method indicating whether the associated promotion is applied to the cart's items, shipping methods, or the whole order. enum: - order - shipping_methods - items allocation: type: string + description: The allocation value that indicates whether the associated promotion is applied on each item in a cart or split between the items in the cart. enum: - each - across - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. apply_to_quantity: type: number title: apply_to_quantity - description: The application method's apply to quantity. + description: The quantity that results from matching the `buyget` promotion's condition. For example, if the promotion is a "Buy 2 shirts get 1 free", the value f this attribute is `1`. buy_rules_min_quantity: type: number title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. + description: The minimum quantity required for a `buyget` promotion to be applied. For example, if the promotion is a "Buy 2 shirts get 1 free", the value of this attribute is `2`. - type: object - description: SUMMARY + description: The properties to update in a promotion. properties: additional_data: type: object description: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in a promotion. x-codeSamples: - lang: Shell label: cURL @@ -33238,8 +30235,9 @@ paths: /admin/promotions/{id}/buy-rules/batch: post: operationId: PostPromotionsIdBuyRulesBatch - summary: Add Buy Rules to Promotion - description: Add a list of buy rules to a promotion. + summary: Manage the Buy Rules of a Promotion + x-sidebar-summary: Manage Buy Rules + description: Manage the buy rules of a `buyget` promotion to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -33264,30 +30262,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -33297,22 +30271,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The buy rules to create, update, or delete. properties: create: type: array - description: The promotion's create. + description: The buy rules to create. items: type: object - description: The create's details. + description: A buy rule's details. required: - operator - - description - attribute - values properties: operator: type: string + description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -33324,39 +30298,42 @@ paths: description: type: string title: description - description: The create's description. + description: The buy rule's description. attribute: type: string title: attribute - description: The create's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The create's values. + description: The attribute's value. + example: prod_123 - type: array - description: The create's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 update: type: array - description: The promotion's update. + description: The buy rules to update. items: type: object - description: The update's details. + description: The properties to update in a buy rule. required: - id - - description - values properties: id: type: string title: id - description: The update's ID. + description: The buy rule's ID. operator: type: string + description: The operator used to check whether the buy rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -33368,29 +30345,32 @@ paths: description: type: string title: description - description: The update's description. + description: The buy rule's description. attribute: type: string title: attribute - description: The update's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The update's values. + description: The attribute's value. + example: prod_123 - type: array - description: The update's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 delete: type: array - description: The promotion's delete. + description: The buy rules to delete. items: type: string title: delete - description: The delete's details. + description: A buy rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -33406,7 +30386,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The result of the batch operations. required: - created - updated @@ -33414,17 +30394,17 @@ paths: properties: created: type: array - description: The promotion's created. + description: The created buy rules. items: $ref: '#/components/schemas/AdminPromotionRule' updated: type: array - description: The promotion's updated. + description: The updated buy rules. items: $ref: '#/components/schemas/AdminPromotionRule' deleted: type: object - description: The promotion's deleted. + description: The details of the deleted buy rules. required: - ids - object @@ -33432,19 +30412,20 @@ paths: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the buy rules that were deleted. items: type: string title: ids - description: The id's ids. + description: A buy rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the object that was deleted. + default: promotion-rule deleted: type: boolean title: deleted - description: The deleted's details. + description: Whether the buy rules were deleted. '400': $ref: '#/components/responses/400_error' '401': @@ -33461,8 +30442,9 @@ paths: /admin/promotions/{id}/rules/batch: post: operationId: PostPromotionsIdRulesBatch - summary: Add Rules to Promotion - description: Add a list of rules to a promotion. + summary: Manage a Promotion's Rules + x-sidebar-summary: Manage Rules + description: Manage the rules of a promotion to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -33487,30 +30469,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -33520,22 +30478,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The rules to create, update, or delete. properties: create: type: array - description: The promotion's create. + description: The rules to create. items: type: object - description: The create's details. + description: A rule's details. required: - operator - - description - attribute - values properties: operator: type: string + description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -33547,39 +30505,42 @@ paths: description: type: string title: description - description: The create's description. + description: The rule's description. attribute: type: string title: attribute - description: The create's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The create's values. + description: The attribute's value. + example: prod_123 - type: array - description: The create's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 update: type: array - description: The promotion's update. + description: The rules to update. items: type: object - description: The update's details. + description: The properties to update in a rule. required: - id - - description - values properties: id: type: string title: id - description: The update's ID. + description: The rule's ID. operator: type: string + description: The operator used to check whether the rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -33591,29 +30552,32 @@ paths: description: type: string title: description - description: The update's description. + description: The rule's description. attribute: type: string title: attribute - description: The update's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The update's values. + description: The attribute's value. + example: prod_123 - type: array - description: The update's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 delete: type: array - description: The promotion's delete. + description: The rules to delete. items: type: string title: delete - description: The delete's details. + description: A rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -33629,7 +30593,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The result of the batch operations. required: - created - updated @@ -33637,17 +30601,17 @@ paths: properties: created: type: array - description: The promotion's created. + description: The created rules. items: $ref: '#/components/schemas/AdminPromotionRule' updated: type: array - description: The promotion's updated. + description: The updated rules. items: $ref: '#/components/schemas/AdminPromotionRule' deleted: type: object - description: The promotion's deleted. + description: The details of the deleted buy rules. required: - ids - object @@ -33655,19 +30619,20 @@ paths: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted rules. items: type: string title: ids - description: The id's ids. + description: A rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the object that was deleted. + default: promotion-rule deleted: type: boolean title: deleted - description: The deleted's details. + description: Whether the rules were deleted. '400': $ref: '#/components/responses/400_error' '401': @@ -33684,8 +30649,9 @@ paths: /admin/promotions/{id}/target-rules/batch: post: operationId: PostPromotionsIdTargetRulesBatch - summary: Add Target Rules to Promotion - description: Add a list of target rules to a promotion. + summary: Manage Target Rules of a Promotion + x-sidebar-summary: Manage Target Rules + description: Manage the target rules of a promotion to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -33710,30 +30676,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -33743,22 +30685,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The target rules to create, update, or delete. properties: create: type: array - description: The promotion's create. + description: The target rules to create. items: type: object - description: The create's details. + description: A target rule's details. required: - operator - - description - attribute - values properties: operator: type: string + description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -33770,39 +30712,42 @@ paths: description: type: string title: description - description: The create's description. + description: The target rule's description. attribute: type: string title: attribute - description: The create's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The create's values. + description: The attribute's value. + example: prod_123 - type: array - description: The create's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 update: type: array - description: The promotion's update. + description: The target rules to update. items: type: object - description: The update's details. + description: The properties to update in a target rule. required: - id - - description - values properties: id: type: string title: id - description: The update's ID. + description: The target rule's ID. operator: type: string + description: The operator used to check whether the target rule applies on a cart. For example, `eq` means that the cart's value for the specified attribute must match the specified value. enum: - gte - lte @@ -33814,29 +30759,32 @@ paths: description: type: string title: description - description: The update's description. + description: The target rule's description. attribute: type: string title: attribute - description: The update's attribute. + description: The attribute to compare against when checking whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The update's values. + description: The attribute's value. + example: prod_123 - type: array - description: The update's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 delete: type: array - description: The promotion's delete. + description: The target rules to delete. items: type: string title: delete - description: The delete's details. + description: A target rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -33852,7 +30800,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The result of the batch operations. required: - created - updated @@ -33860,17 +30808,17 @@ paths: properties: created: type: array - description: The promotion's created. + description: The created target rules. items: $ref: '#/components/schemas/AdminPromotionRule' updated: type: array - description: The promotion's updated. + description: The updated target rules. items: $ref: '#/components/schemas/AdminPromotionRule' deleted: type: object - description: The promotion's deleted. + description: The details of the deleted target rules. required: - ids - object @@ -33878,19 +30826,20 @@ paths: properties: ids: type: array - description: The deleted's ids. + description: The IDs of deleted target rules. items: type: string title: ids - description: The id's ids. + description: A target rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the object that was deleted. + default: promotion-rule deleted: type: boolean title: deleted - description: The deleted's details. + description: Whether the target rules were deleted. '400': $ref: '#/components/responses/400_error' '401': @@ -33911,7 +30860,9 @@ paths: x-sidebar-summary: List Rules description: | Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter: - - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved. + - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. + + - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved. x-authenticated: true parameters: - name: id @@ -33946,30 +30897,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -34181,30 +31108,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -34276,30 +31179,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -34359,30 +31238,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -34392,9 +31247,7 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - description + description: The properties to update in the refund reason. properties: label: type: string @@ -34568,20 +31421,6 @@ paths: type: string title: id description: A region's ID. - - name: code - in: query - required: false - schema: - oneOf: - - type: string - title: code - description: Filter by a currency code. - - type: array - description: Filter by currency codes. - items: - type: string - title: code - description: A currency code. - name: name in: query required: false @@ -34971,6 +31810,20 @@ paths: items: type: object title: $or + - name: currency_code + in: query + required: false + schema: + oneOf: + - type: string + title: currency_code + description: The region's currency code. + - type: array + description: The region's currency code. + items: + type: string + title: currency_code + description: The currency code's details. security: - api_token: [] - cookie_auth: [] @@ -35053,30 +31906,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -35149,30 +31978,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -35232,30 +32037,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -35265,9 +32046,7 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The propeties to update in the region. properties: name: type: string @@ -35283,25 +32062,25 @@ paths: items: type: string title: countries - description: The country's countries. + description: A country code. automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: Whether taxes are calculated automatically for carts in the region. payment_providers: type: array - description: The region's payment providers. + description: The payment providers enabled in the region. items: type: string title: payment_providers - description: The payment provider's payment providers. + description: A payment provider's ID. metadata: type: object - description: The region's metadata. + description: The region's metadata. Can hold custom key-value pairs. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The region's is tax inclusive. + description: Whether the prices in the region are tax inclusive. x-codeSamples: - lang: Shell label: cURL @@ -35992,30 +32771,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -36091,30 +32846,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -36174,30 +32905,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -36207,26 +32914,23 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - description - - metadata + description: The properties to update in the reservation. properties: location_id: type: string title: location_id - description: The reservation's location id. + description: The ID of the associated location. quantity: type: number title: quantity - description: The reservation's quantity. + description: The reserved quantity. description: type: string title: description description: The reservation's description. metadata: type: object - description: The reservation's metadata. + description: The reservation's metadata. Can hold custom key-value pairs. x-codeSamples: - lang: Shell label: cURL @@ -36878,30 +33582,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -36973,30 +33653,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -37056,30 +33712,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -37258,25 +33890,25 @@ paths: title: $or - name: sales_channel_id in: query - description: The return's sales channel id. + description: Filter by sales channel IDs to retrieve their associated returns. required: false schema: type: array - description: The return's sales channel id. + description: Filter by sales channel IDs to retrieve their associated returns. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: fulfillment_status in: query - description: The return's fulfillment status. + description: Filter by fulfillment statuses. required: false schema: type: array - description: The return's fulfillment status. + description: Filter by fulfillment statuses. items: type: string - description: The fulfillment status's details. + description: A fulfillment status. enum: - canceled - not_fulfilled @@ -37288,14 +33920,14 @@ paths: - delivered - name: payment_status in: query - description: The return's payment status. + description: Filter by payment statuses. required: false schema: type: array - description: The return's payment status. + description: Filter by payment statuses. items: type: string - description: The payment status's details. + description: A payment status. enum: - canceled - not_paid @@ -37309,30 +33941,30 @@ paths: - requires_action - name: region_id in: query - description: The return's region id. + description: Filter by region IDs to retrieve their associated returns. required: false schema: type: array - description: The return's region id. + description: Filter by region IDs to retrieve their associated returns. items: type: string title: region_id description: The region id's details. - name: q in: query - description: The return's q. + description: Search term to filter the return's searchable properties. required: false schema: type: string title: q - description: The return's q. + description: Search term to filter the return's searchable properties. - name: created_at in: query - description: The return's created at. + description: Filter by the return's creation date. required: false schema: type: object - description: The return's created at. + description: Filter by the return's creation date. properties: $and: type: array @@ -37352,11 +33984,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -37367,19 +33999,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -37401,42 +34033,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter - type: object description: Filter by values not matching the conditions in this parameter. - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -37475,31 +34107,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The value to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -37538,32 +34170,32 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The return's updated at. + description: Filter by the return's update date. required: false schema: type: object - description: The return's updated at. + description: Filter by the return's update date. properties: $and: type: array @@ -37583,11 +34215,11 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -37598,19 +34230,19 @@ paths: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter. - type: object description: Filter by values not matching the conditions in this parameter. properties: @@ -37632,42 +34264,42 @@ paths: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching this parameter - type: object description: Filter by values not matching the conditions in this parameter. - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching the values of this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -37706,31 +34338,31 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The value to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - type: array - description: Filter by values not matching the conditions in this parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: Filter by values not matching the conditions in this parameter. + description: The values to not match. $gt: type: string title: $gt @@ -37769,21 +34401,21 @@ paths: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -37851,7 +34483,7 @@ paths: post: operationId: PostReturns summary: Create Return - description: Create a return. + description: Create a return. The return can later be requested or confirmed. x-authenticated: true parameters: - name: expand @@ -37870,30 +34502,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -37978,30 +34586,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38061,30 +34645,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38129,8 +34689,8 @@ paths: /admin/returns/{id}/cancel: post: operationId: PostReturnsIdCancel - summary: Add Cancels to Return - description: Add a list of cancels to a return. + summary: Cancel a return. + description: Cancel a return. x-authenticated: true parameters: - name: id @@ -38179,8 +34739,9 @@ paths: /admin/returns/{id}/dismiss-items: post: operationId: PostReturnsIdDismissItems - summary: Add Dismiss Items to Return - description: Add a list of dismiss items to a return. + summary: Add Damaged Items to Return + x-sidebar-summary: Add Damaged Items + description: Add damaged items, whose quantity is to be dismissed, to a return. These items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -38205,30 +34766,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38269,8 +34806,12 @@ paths: /admin/returns/{id}/dismiss-items/{action_id}: post: operationId: PostReturnsIdDismissItemsAction_id - summary: Add Dismiss Items to Return - description: Add a list of dismiss items to a return. + summary: Update Damaged Item of Return + x-sidebar-summary: Update Damaged Item + description: | + Update a damaged item, whose quantity is to be dismissed, in the return by the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -38281,7 +34822,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action. required: true schema: type: string @@ -38301,30 +34842,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38400,30 +34917,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38459,8 +34952,8 @@ paths: /admin/returns/{id}/receive: post: operationId: PostReturnsIdReceive - summary: Add Receives to Return - description: Add a list of receives to a return. + summary: Start Return Receival + description: Start a return receival process to be later confirmed using the `/admin/returns/:id/receive/confirm` API route. x-authenticated: true parameters: - name: id @@ -38485,30 +34978,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38625,8 +35094,9 @@ paths: /admin/returns/{id}/receive-items: post: operationId: PostReturnsIdReceiveItems - summary: Add Receive Items to Return - description: Add a list of receive items to a return. + summary: Add Received Items to Return + x-sidebar-summary: Add Received Items + description: Add received items in a return. These items will have the action `RECEIVE_RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -38651,30 +35121,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38715,8 +35161,12 @@ paths: /admin/returns/{id}/receive-items/{action_id}: post: operationId: PostReturnsIdReceiveItemsAction_id - summary: Add Receive Items to Return - description: Add a list of receive items to a return. + summary: Update a Received Item in a Return + x-sidebar-summary: Update Received Item + description: | + Update a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -38727,7 +35177,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the received item's `RECEIVE_RETURN_ITEM` action. required: true schema: type: string @@ -38747,30 +35197,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38813,7 +35239,7 @@ paths: summary: Remove a Received Item from Return x-sidebar-summary: Remove Received Item description: | - Remove an item marked as received in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. + Remove a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true @@ -38846,30 +35272,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38905,8 +35307,9 @@ paths: /admin/returns/{id}/receive/confirm: post: operationId: PostReturnsIdReceiveConfirm - summary: Add Confirms to Return - description: Add a list of confirms to a return. + summary: Confirm Return Receival + description: | + Confirm that a return has been received. This updates the quantity of the items received, if not damaged, and reflects the changes on the order. x-authenticated: true parameters: - name: id @@ -38931,30 +35334,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -38995,8 +35374,9 @@ paths: /admin/returns/{id}/request: post: operationId: PostReturnsIdRequest - summary: Add Requests to Return - description: Add a list of requests to a return. + summary: Confirm Return Request + description: | + Confirm a requested return. The changes are applied on the inventory quantity and the order only after the return has been confirmed as received using the `/admin/returns/:id/received/confirm`. x-authenticated: true parameters: - name: id @@ -39021,30 +35401,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -39148,8 +35504,9 @@ paths: /admin/returns/{id}/request-items: post: operationId: PostReturnsIdRequestItems - summary: Add Request Items to Return - description: Add a list of request items to a return. + summary: Add Requested Items to Return + x-sidebar-summary: Add Items + description: Add items that are requested to be returned. These items will have the action `RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -39174,30 +35531,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -39238,8 +35571,12 @@ paths: /admin/returns/{id}/request-items/{action_id}: post: operationId: PostReturnsIdRequestItemsAction_id - summary: Add Request Items to Return - description: Add a list of request items to a return. + summary: Update Requested Item in Return + x-sidebar-summary: Update Requested Item + description: | + Update a requested item to be returned by the ID of the item's `RETURN_ITEM` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -39250,7 +35587,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the item's `RETURN_ITEM` action. required: true schema: type: string @@ -39270,30 +35607,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -39336,7 +35649,7 @@ paths: summary: Remove Item from Return x-sidebar-summary: Remove Item description: | - Remove an item in the return by the ID of the item's `RETURN_ITEM` action. + Remove a requested item to be returned by the ID of the item's `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. return. x-authenticated: true @@ -39369,30 +35682,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -39428,8 +35717,9 @@ paths: /admin/returns/{id}/shipping-method: post: operationId: PostReturnsIdShippingMethod - summary: Add Shipping Methods to Return - description: Add a list of shipping methods to a return. + summary: Add a Shipping Method to a Return + x-sidebar-summary: Add Shipping Method + description: Add a shipping method to a return. The shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -39454,30 +35744,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -39522,8 +35788,12 @@ paths: /admin/returns/{id}/shipping-method/{action_id}: post: operationId: PostReturnsIdShippingMethodAction_id - summary: Add Shipping Methods to Return - description: Add a list of shipping methods to a return. + summary: Update a Shipping Method of a Return + x-sidebar-summary: Update Shipping Method + description: | + Update a shipping method of the return by the ID of the item's `SHIPPING_ADD` action. + + Every item has an `actions` property, whose value is an array of actions. You can check the action's name using its `action` property, and use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -39534,7 +35804,7 @@ paths: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -39554,30 +35824,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -39653,30 +35899,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -40293,30 +36515,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -40389,30 +36587,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -40472,30 +36646,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -40585,8 +36735,9 @@ paths: /admin/sales-channels/{id}/products: post: operationId: PostSalesChannelsIdProducts - summary: Add Products to Sales Channel - description: Add a list of products to a sales channel. + summary: Manage Products in Sales Channel + x-sidebar-summary: Manage Products + description: Manage products in a sales channel to add or remove them from the channel. x-authenticated: true parameters: - name: id @@ -40611,30 +36762,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -40644,22 +36771,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The products to add or remove from the channel. properties: add: type: array - description: The sales channel's add. + description: The products to add to the sales channel. items: type: string title: add - description: The add's details. + description: A product's ID. remove: type: array - description: The sales channel's remove. + description: The products to remove from the sales channel. items: type: string title: remove - description: The remove's details. + description: A product's ID. x-codeSamples: - lang: Shell label: cURL @@ -41186,20 +37313,20 @@ paths: description: A stock location's ID. - name: is_return in: query - description: The shipping option's is return. + description: Filter by whether the shipping option is used for returns. required: false schema: type: boolean title: is_return - description: The shipping option's is return. + description: Filter by whether the shipping option is used for returns. - name: admin_only in: query - description: The shipping option's admin only. + description: Filter by whether the shipping option is used by admin users only. required: false schema: type: boolean title: admin_only - description: The shipping option's admin only. + description: Filter by whether the shipping option is used by admin users only. security: - api_token: [] - cookie_auth: [] @@ -41282,30 +37409,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -41386,30 +37489,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -41419,7 +37498,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The properties to update in the shipping option. properties: name: type: string @@ -41427,20 +37506,24 @@ paths: description: The shipping option's name. data: type: object - description: The shipping option's data. + description: The shipping option's data that is useful for third-party providers. + externalDocs: + url: https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property price_type: type: string + description: | + The type of the shipping option's price. If `calculated`, its price is retrieved by the associated fulfillment provider during checkout. If `flat`, its price is set in the `prices` property. enum: - calculated - flat provider_id: type: string title: provider_id - description: The shipping option's provider id. + description: The ID of the associated fulfillment provider that is used to process the option. shipping_profile_id: type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: The ID of the shipping profile this shipping option belongs to. type: type: object description: The shipping option's type. @@ -41463,16 +37546,16 @@ paths: description: The type's code. prices: type: array - description: The shipping option's prices. + description: The shipping option's prices. If the `price_type` is `calculated`, pass an empty array. items: oneOf: - type: object - description: The price's prices. + description: The shipping option's price for a currency code. properties: id: type: string title: id - description: The price's ID. + description: The ID of an existing price. currency_code: type: string title: currency_code @@ -41482,16 +37565,16 @@ paths: title: amount description: The price's amount. - type: object - description: The price's prices. + description: The shipping option's price for a region. properties: id: type: string title: id - description: The price's ID. + description: The ID of an existing price. region_id: type: string title: region_id - description: The price's region id. + description: The ID of the associated region. amount: type: number title: amount @@ -41502,7 +37585,7 @@ paths: items: oneOf: - type: object - description: The rule's rules. + description: The details of a new shipping option rule. required: - operator - attribute @@ -41510,6 +37593,7 @@ paths: properties: operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -41522,20 +37606,23 @@ paths: attribute: type: string title: attribute - description: The rule's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: object - description: The rule's rules. + description: Update the properties of an existing rule. required: - id - operator @@ -41548,6 +37635,7 @@ paths: description: The rule's ID. operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -41560,18 +37648,21 @@ paths: attribute: type: string title: attribute - description: The rule's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 x-codeSamples: - lang: Shell label: cURL @@ -41647,8 +37738,9 @@ paths: /admin/shipping-options/{id}/rules/batch: post: operationId: PostShippingOptionsIdRulesBatch - summary: Add Rules to Shipping Option - description: Add a list of rules to a shipping option. + summary: Manage the Rules of a Shipping Option + x-sidebar-summary: Manage Rules + description: Manage the rules of a shipping option to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -41673,30 +37765,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -41706,14 +37774,14 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The rules to create, update, or delete. properties: create: type: array - description: The shipping option's create. + description: The shipping option rules to create. items: type: object - description: The create's details. + description: A shipping option's details. required: - operator - attribute @@ -41721,6 +37789,7 @@ paths: properties: operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -41733,24 +37802,27 @@ paths: attribute: type: string title: attribute - description: The create's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The create's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The create's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 update: type: array - description: The shipping option's update. + description: The shipping option rules to update. items: type: object - description: The update's details. + description: The properties to update in the shipping option rule. required: - id - operator @@ -41760,9 +37832,10 @@ paths: id: type: string title: id - description: The update's ID. + description: The rule's ID. operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -41775,25 +37848,28 @@ paths: attribute: type: string title: attribute - description: The update's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The update's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The update's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 delete: type: array - description: The shipping option's delete. + description: The shipping option rules to delete. items: type: string title: delete - description: The delete's details. + description: A rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -41809,7 +37885,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The batch operation's result. required: - created - updated @@ -41817,17 +37893,17 @@ paths: properties: created: type: array - description: The shipping option's created. + description: The created shipping option rules. items: $ref: '#/components/schemas/AdminShippingOptionRule' updated: type: array - description: The shipping option's updated. + description: The updated shipping option rules. items: $ref: '#/components/schemas/AdminShippingOptionRule' deleted: type: object - description: The shipping option's deleted. + description: The details of the deleted shipping option rules. required: - ids - object @@ -41835,15 +37911,16 @@ paths: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted shipping option rules. items: type: string title: ids - description: The id's ids. + description: A shipping option rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the deleted object. + default: shipping_option_rule deleted: type: boolean title: deleted @@ -42403,30 +38480,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -42499,30 +38552,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -42582,30 +38611,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -42615,9 +38620,7 @@ paths: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The properties to update in the shipping profile. properties: name: type: string @@ -43245,30 +39248,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -43341,30 +39320,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -43424,30 +39379,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -43537,8 +39468,9 @@ paths: /admin/stock-locations/{id}/fulfillment-providers: post: operationId: PostStockLocationsIdFulfillmentProviders - summary: Add Fulfillment Providers to Stock Location - description: Add a list of fulfillment providers to a stock location. + summary: Manage Fulfillment Providers of a Stock Location + x-sidebar-summary: Manage Fulfillment Providers + description: Manage the fulfillment providers to add or remove them from a stock location. x-authenticated: true parameters: - name: id @@ -43563,30 +39495,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -43596,22 +39504,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The fulfillment providers to add or remove from the stock location. properties: add: type: array - description: The stock location's add. + description: The fulfillment providers to add to the stock location. items: type: string title: add - description: The add's details. + description: A fulfillment provider's ID. remove: type: array - description: The stock location's remove. + description: The fulfillment providers to remove from the stock location. items: type: string title: remove - description: The remove's details. + description: A fulfillment provider's ID. x-codeSamples: - lang: Shell label: cURL @@ -43643,8 +39551,9 @@ paths: /admin/stock-locations/{id}/fulfillment-sets: post: operationId: PostStockLocationsIdFulfillmentSets - summary: Add Fulfillment Sets to Stock Location - description: Add a list of fulfillment sets to a stock location. + summary: Add Fulfillment Set to Stock Location + x-sidebar-summary: Add Fulfillment Set + description: Create and add a fulfillment set to a stock location. x-authenticated: true parameters: - name: id @@ -43669,30 +39578,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -43702,7 +39587,7 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The fulfillment set to create. required: - name - type @@ -43710,11 +39595,11 @@ paths: name: type: string title: name - description: The stock location's name. + description: The fulfillment set's name. type: type: string title: type - description: The stock location's type. + description: The fulfillment set's type. x-codeSamples: - lang: Shell label: cURL @@ -43751,8 +39636,9 @@ paths: /admin/stock-locations/{id}/sales-channels: post: operationId: PostStockLocationsIdSalesChannels - summary: Add Sales Channels to Stock Location - description: Add a list of sales channels to a stock location. + summary: Manage Sales Channels of a Stock Location + x-sidebar-summary: Manage Sales Channels + description: Manage the sales channels in a stock location by adding or removing them. x-authenticated: true parameters: - name: id @@ -43777,30 +39663,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -43810,22 +39672,22 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The sales channels to add or remove. properties: add: type: array - description: The stock location's add. + description: The sales channels to add. items: type: string title: add - description: The add's details. + description: A sales channel's ID. remove: type: array - description: The stock location's remove. + description: The sales channels to remove. items: type: string title: remove - description: The remove's details. + description: A sales channel's ID. x-codeSamples: - lang: Shell label: cURL @@ -44015,30 +39877,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -44098,30 +39936,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -44779,30 +40593,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -44875,30 +40665,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -44958,30 +40724,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -45070,8 +40812,9 @@ paths: /admin/tax-rates/{id}/rules: post: operationId: PostTaxRatesIdRules - summary: Add Rules to Tax Rate - description: Add a list of rules to a tax rate. + summary: Create Tax Rule for a Rate + x-sidebar-summary: Create Tax Rule + description: Create a tax rule for a rate. x-authenticated: true parameters: - name: id @@ -45096,30 +40839,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -45198,30 +40917,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -45547,9 +41242,9 @@ paths: oneOf: - type: string title: created_at - description: The tax region's created at. + description: Filter by a tax region's creation date. - type: object - description: The tax region's created at. + description: Apply filters on the tax region's creation date. properties: $and: type: array @@ -45782,9 +41477,9 @@ paths: oneOf: - type: string title: updated_at - description: The tax region's updated at. + description: Filter by a tax region's update date. - type: object - description: The tax region's updated at. + description: Apply filters on the tax region's update date. properties: $and: type: array @@ -46017,9 +41712,9 @@ paths: oneOf: - type: string title: deleted_at - description: The tax region's deleted at. + description: Filter by a tax region's deletion date. - type: object - description: The tax region's deleted at. + description: Apply filters on the tax region's deletion date. properties: $and: type: array @@ -46344,30 +42039,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -46441,30 +42112,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -46543,10 +42190,9 @@ paths: /admin/uploads: post: operationId: PostUploads - summary: Create Upload - description: Create a upload. + summary: Upload Files + description: Upload files to the configured File Module Provider. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] @@ -46557,17 +42203,17 @@ paths: schema: oneOf: - type: object - description: SUMMARY + description: The files to upload. required: - files properties: files: type: array - description: The upload's files. + description: The files to upload. items: oneOf: - type: object - description: The file's files. + description: A file's details. required: - name - content @@ -46579,10 +42225,10 @@ paths: content: type: string title: content - description: The file's content. + description: The file's base64 content. - $ref: '#/components/schemas/File' - $ref: '#/components/schemas/FileList' - description: SUMMARY + description: The files to upload. x-codeSamples: - lang: Shell label: cURL @@ -46640,30 +42286,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -47257,30 +42879,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -47335,30 +42933,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -47412,30 +42986,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -47676,30 +43226,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -47734,13 +43260,13 @@ paths: /admin/workflows-executions/{workflow_id}/run: post: operationId: PostWorkflowsExecutionsWorkflow_idRun - summary: Add Runs to Workflows Execution - description: Add a list of runs to a workflows execution. + summary: Execute a Workflow + description: Execute a workflow by its ID. x-authenticated: true parameters: - name: workflow_id in: path - description: The workflows execution's workflow id. + description: The workflow's ID. required: true schema: type: string @@ -47768,11 +43294,25 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The execution's details. required: - acknowledgement properties: - acknowledgement: {} + acknowledgement: + type: object + description: The workflow's details + required: + - workflowId + - transactionId + properties: + workflowId: + type: string + description: The ID of the executed workflow. + title: workflowId + transactionId: + type: string + description: The ID of the workflow exection's transaction. Use this later to track the workflow execution's progress or succeed / fail its steps. + title: transactionId '400': $ref: '#/components/responses/400_error' '401': @@ -47788,8 +43328,9 @@ paths: /admin/workflows-executions/{workflow_id}/steps/failure: post: operationId: PostWorkflowsExecutionsWorkflow_idStepsFailure - summary: Add Failures to Workflows Execution - description: Add a list of failures to a workflows execution. + summary: Fail a Step in a Workflow's Execution + x-sidebar-summary: Fail a Step + description: Set the status of a step in a workflow's execution as failed. This is useful for long-running workflows. x-authenticated: true parameters: - name: workflow_id @@ -47827,14 +43368,14 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The details of failing the workflow step. required: - success properties: success: type: boolean title: success - description: The workflows execution's success. + description: Whether the workflow step has failed successfully. '400': $ref: '#/components/responses/400_error' '401': @@ -47850,8 +43391,9 @@ paths: /admin/workflows-executions/{workflow_id}/steps/success: post: operationId: PostWorkflowsExecutionsWorkflow_idStepsSuccess - summary: Add Successes to Workflows Execution - description: Add a list of successes to a workflows execution. + summary: Succeed a Step in a Workflow's Execution + x-sidebar-summary: Succed a Step + description: Set the status of a step in a workflow's execution as successful. This is useful for long-running workflows. x-authenticated: true parameters: - name: workflow_id @@ -47889,14 +43431,14 @@ paths: application/json: schema: type: object - description: SUMMARY + description: The details of succeeding the workflow step. required: - success properties: success: type: boolean title: success - description: The workflows execution's success. + description: Whether the workflow step was succeeded. '400': $ref: '#/components/responses/400_error' '401': @@ -47996,30 +43538,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - api_token: [] - cookie_auth: [] @@ -49205,7 +44723,6 @@ components: x-schemaName: AdminCreateCollection required: - title - - metadata properties: title: type: string @@ -49224,7 +44741,6 @@ components: x-schemaName: AdminCreateCustomerGroup required: - name - - metadata properties: name: type: string @@ -49245,12 +44761,7 @@ components: - labels - order - order_id - - shipping_option_id - data - - packed_at - - shipped_at - - delivered_at - - canceled_at - metadata properties: location_id: @@ -49264,18 +44775,6 @@ components: delivery_address: type: object description: The fulfillment's delivery address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata properties: first_name: type: string @@ -49331,8 +44830,6 @@ components: - sku - quantity - barcode - - line_item_id - - inventory_item_id properties: title: type: string @@ -49485,8 +44982,6 @@ components: required: - title - description - - starts_at - - ends_at properties: title: type: string @@ -49529,8 +45024,6 @@ components: - currency_code - amount - variant_id - - min_quantity - - max_quantity properties: currency_code: type: string @@ -50199,6 +45692,7 @@ components: AdminCreateShippingProfile: type: object description: SUMMARY + x-schemaName: AdminCreateShippingProfile required: - name - type @@ -50214,7 +45708,6 @@ components: metadata: type: object description: The shipping profile's metadata. - x-schemaName: AdminCreateShippingProfile AdminCreateStockLocation: type: object description: SUMMARY @@ -52275,6 +47768,18 @@ components: properties: invite: $ref: '#/components/schemas/AdminInvite' + AdminLinkPriceListProducts: + type: object + description: The removal details. + properties: + remove: + type: array + description: The products to remove from the price list. + items: + type: string + title: remove + description: The ID of a product. + x-schemaName: AdminLinkPriceListProducts AdminNotification: type: object description: The notification's details. @@ -52725,8 +48230,8 @@ components: - return_requested_total - order_change - currency_code - - id - version + - id - region_id - customer_id - sales_channel_id @@ -53185,14 +48690,14 @@ components: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id @@ -53771,8 +49276,6 @@ components: type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema - required: - - reason_id properties: quantity: type: number @@ -53791,10 +49294,10 @@ components: description: SUMMARY x-schemaName: AdminPostClaimsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. internal_note: type: string title: internal_note @@ -53813,10 +49316,10 @@ components: type: string title: shipping_option_id description: The claim's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. description: type: string title: description @@ -53942,10 +49445,10 @@ components: description: SUMMARY x-schemaName: AdminPostExchangesShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. internal_note: type: string title: internal_note @@ -53964,10 +49467,10 @@ components: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description @@ -53986,8 +49489,6 @@ components: required: - type - order_id - - reason_id - - metadata properties: type: type: string @@ -54071,7 +49572,6 @@ components: x-schemaName: AdminPostOrderEditsReqSchema required: - order_id - - metadata properties: order_id: type: string @@ -54093,10 +49593,10 @@ components: description: SUMMARY x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. internal_note: type: string title: internal_note @@ -54115,10 +49615,10 @@ components: type: string title: shipping_option_id description: The order edit's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. description: type: string title: description @@ -54151,7 +49651,6 @@ components: x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id - - metadata properties: order_id: type: string @@ -54172,8 +49671,6 @@ components: type: object description: SUMMARY x-schemaName: AdminPostReceiveReturnsReqSchema - required: - - metadata properties: internal_note: type: string @@ -54258,7 +49755,6 @@ components: x-schemaName: AdminPostReturnsReqSchema required: - order_id - - metadata properties: order_id: type: string @@ -54345,8 +49841,6 @@ components: type: object description: SUMMARY x-schemaName: AdminPostReturnsReturnReqSchema - required: - - metadata properties: location_id: type: string @@ -54364,10 +49858,10 @@ components: description: SUMMARY x-schemaName: AdminPostReturnsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The return's custom price. + title: custom_amount + description: The return's custom amount. internal_note: type: string title: internal_note @@ -54386,10 +49880,10 @@ components: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description @@ -55478,6 +50972,10 @@ components: type: boolean title: manage_inventory description: The parent's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The parent's inventory quantity. hs_code: type: string title: hs_code @@ -57833,8 +53331,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateCollection - required: - - metadata properties: title: type: string @@ -57851,8 +53347,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateCustomerGroup - required: - - metadata properties: name: type: string @@ -57865,10 +53359,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdatePriceList - required: - - description - - starts_at - - ends_at properties: title: type: string @@ -58325,9 +53815,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateSalesChannel - required: - - description - - metadata properties: name: type: string @@ -58348,9 +53835,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateStockLocation - required: - - address_id - - metadata properties: name: type: string @@ -58361,13 +53845,7 @@ components: description: The stock location's address. required: - address_1 - - address_2 - - company - - city - country_code - - phone - - postal_code - - province properties: address_1: type: string @@ -58412,11 +53890,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateStore - required: - - default_sales_channel_id - - default_region_id - - default_location_id - - metadata properties: name: type: string @@ -58462,9 +53935,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateTaxRate - required: - - code - - metadata properties: rate: type: number @@ -58511,10 +53981,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateUser - required: - - first_name - - last_name - - avatar_url properties: first_name: type: string @@ -62150,8 +57616,8 @@ components: - order_change - status - currency_code - - id - version + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -62816,14 +58282,14 @@ components: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id @@ -62869,6 +58335,8 @@ components: - balance - paid_total - refunded_total + - pending_difference + - raw_pending_difference properties: total: oneOf: @@ -63080,6 +58548,23 @@ components: - type: object description: The summary's refunded total. x-schemaName: IBigNumber + pending_difference: + oneOf: + - type: string + title: pending_difference + description: The summary's pending difference. + - type: number + title: pending_difference + description: The summary's pending difference. + - type: string + title: pending_difference + description: The summary's pending difference. + - type: object + description: The summary's pending difference. + x-schemaName: IBigNumber + raw_pending_difference: + type: object + description: The summary's raw pending difference. metadata: type: object description: The order preview's metadata. @@ -63836,7 +59321,6 @@ components: required: - variant_id - quantity - - metadata properties: variant_id: type: string @@ -66100,7 +61584,6 @@ components: x-schemaName: StoreUpdateCartLineItem required: - quantity - - metadata properties: quantity: type: number @@ -66113,11 +61596,6 @@ components: type: object description: SUMMARY x-schemaName: StoreUpdateCustomer - required: - - company_name - - first_name - - last_name - - phone properties: company_name: type: string 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 0bea9ac00b..dd867df70d 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 @@ -1286,9 +1286,15 @@ get: post: operationId: PostApiKeys summary: Create Api Key - description: Create a api key. + description: > + Create a secret or publishable API key. + + A secret API key is used for admin authentication. + + + A publishable API key is used by client applications to set the scope of the + request. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] 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 988877cefe..afc2b5dfe5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_api-keys_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -99,13 +70,13 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostApiKeysId - summary: Update a Api Key - description: Update a api key's details. + summary: Update an API Key + description: Update an API key's details. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 81593d3e1b..024a93055a 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 @@ -1,12 +1,15 @@ post: operationId: PostApiKeysIdRevoke - summary: Add Revokes to Api Key - description: Add a list of revokes to a api key. + summary: Revoke API Key + description: > + Revokes an API key. If the API key is a secret, it can't be used for + authentication anymore. If it's publishable, it can't be used by client + applications. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 6fdd40f8dc..3dca03240c 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 @@ -1,12 +1,15 @@ post: operationId: PostApiKeysIdSalesChannels - summary: Add Sales Channels to Api Key - description: Add a list of sales channels to a api key. + summary: Manage Sales Channels of a Publishable API Key + x-sidebar-summary: Manage Sales Channels + description: >- + Manage the sales channels of a publishable API key, either to associate them + or remove them from the API key. x-authenticated: true parameters: - name: id in: path - description: The api key's ID. + description: The API key's ID. required: true schema: type: string @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +48,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The sales channels to add or remove from the publishable API key. properties: add: type: array - description: The api key's add. + description: The sales channels to add to the publishable API key. items: type: string title: add - description: The add's details. + description: A sales channel's ID. remove: type: array - description: The api key's remove. + description: The sales channels to remove from the publishable API key. items: type: string title: remove - description: The remove's details. + description: A sales channel's ID. x-codeSamples: - lang: Shell label: cURL 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 b79b28444b..87152bdab2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns.yaml @@ -152,35 +152,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -191,7 +162,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The campaign's details. required: - name - campaign_identifier @@ -207,14 +178,16 @@ post: campaign_identifier: type: string title: campaign_identifier - description: The campaign's campaign identifier. + description: The campaign's identifier. description: type: string title: description description: The campaign's description. budget: type: object - description: The campaign's budget. + description: >- + The campaign's budget which, when crossed, ends the + campaign. required: - type - limit @@ -222,42 +195,51 @@ post: properties: type: type: string + title: type + description: > + The budget's type. This can't be edited later. Use + `spend` to set a limit on the total amount discounted by + the campaign's promotions. Use `usage` to set a limit on + the total number of times the campaign's promotions can + be used. enum: - spend - usage limit: type: number title: limit - description: The budget's limit. + description: The campaign budget's limit. currency_code: type: string title: currency_code - description: The budget's currency code. + description: >- + The campaign budget's currency code. This can't be + edited later. starts_at: type: string title: starts_at - description: The campaign's starts at. + description: The campaign's start date. format: date-time ends_at: type: string title: ends_at - description: The campaign's ends at. + description: The campaign's end date. format: date-time promotions: type: array description: The campaign's promotions. items: type: object - description: The promotion's promotions. + description: The promotions to add to the campaign. required: - id properties: id: type: string title: id - description: The promotion's ID. + description: A promotion's ID. - type: object - description: SUMMARY + description: The campaign's details. properties: additional_data: type: object @@ -265,7 +247,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The campaign's details. x-codeSamples: - lang: Shell label: cURL 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 e085948ba2..baf0046e4d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_campaigns_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -174,7 +116,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The campaign's details. required: - description - starts_at @@ -187,7 +129,7 @@ post: campaign_identifier: type: string title: campaign_identifier - description: The campaign's campaign identifier. + description: The campaign's identifier. description: type: string title: description @@ -201,32 +143,32 @@ post: limit: type: number title: limit - description: The budget's limit. + description: The campaign budget's limit. starts_at: type: string title: starts_at - description: The campaign's starts at. + description: The campaign's start date. format: date-time ends_at: type: string title: ends_at - description: The campaign's ends at. + description: The campaign's end date. format: date-time promotions: type: array description: The campaign's promotions. items: type: object - description: The promotion's promotions. + description: The promotions to add to the campaign. required: - id properties: id: type: string title: id - description: The promotion's ID. + description: A promotion's ID. - type: object - description: SUMMARY + description: The campaign's details. properties: additional_data: type: object @@ -234,7 +176,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The campaign's details. x-codeSamples: - lang: Shell label: cURL 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 8d2c341d95..4450fa7f19 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 @@ -1,7 +1,10 @@ post: operationId: PostCampaignsIdPromotions - summary: Add Promotions to Campaign - description: Add a list of promotions to a campaign. + summary: Manage the Promotions of a Campaign + x-sidebar-summary: Manage Promotions + description: >- + Manage the promotions of a campaign, either by adding them or removing them + from the campaign. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +48,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The promotions to add or remove from the campaign. properties: add: type: array - description: The campaign's add. + description: The promotions to add to the campaign. items: type: string title: add - description: The add's details. + description: A promotion's ID. remove: type: array - description: The campaign's remove. + description: The promotions to remove from the campaign. items: type: string title: remove - description: The remove's details. + description: A promotion's ID. x-codeSamples: - lang: Shell label: cURL 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 b2699dca70..f3f7a69f78 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims.yaml @@ -1020,8 +1020,10 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostClaims - summary: Create Claim - description: Create a claim. + summary: Create a Claim + 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 @@ -1050,35 +1052,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 c4cc700cb9..20da5de270 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml index 2aa93db129..4b8256711e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_cancel.yaml @@ -1,7 +1,7 @@ post: operationId: PostClaimsIdCancel - summary: Add Cancels to Claim - description: Add a list of cancels to a claim. + summary: Cancel a Claim + description: Cancel a claim and its associated return. x-authenticated: true parameters: - name: id 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 40ef624597..cf7ba477d5 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 @@ -1,7 +1,10 @@ post: operationId: PostClaimsIdClaimItems - summary: Add Claim Items to Claim - description: Add a list of claim items to a claim. + summary: Add Claim Items to a Claim + x-sidebar-summary: Add Claim Items + description: >- + Add order items to a claim as claim items. These claim items will have the + action `WRITE_OFF_ITEM`. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 9b0f7bfc71..19ed08493e 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 @@ -1,7 +1,14 @@ post: operationId: PostClaimsIdClaimItemsAction_id - summary: Add Claim Items to Claim - description: Add a list of claim items to a claim. + summary: Update a Claim Item + description: > + Update an order item in a claim by the ID of the item's `WRITE_OFF_ITEM` + action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +19,7 @@ post: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the order item's `WRITE_OFF_ITEM` action. required: true schema: type: string @@ -42,35 +49,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -160,35 +138,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml index b7ab76c82e..36d437e111 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items.yaml @@ -1,7 +1,10 @@ post: operationId: PostClaimsIdInboundItems - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Add Inbound Items to a Claim + x-sidebar-summary: Add Inbound Items + description: > + Add inbound (or return) items to a claim. These inbound items will have a + `RETURN_ITEM` action. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml index f33e59776b..839882089e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_items_{action_id}.yaml @@ -1,7 +1,15 @@ post: operationId: PostClaimsIdInboundItemsAction_id - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Update Inbound Items of a Claim + x-sidebar-summary: Update Inbound Items + description: > + Update an inbound (or return) item of a claim using the `ID` of the item's + `RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string @@ -80,61 +88,6 @@ delete: required: true schema: type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml index d6bb7c9906..f644a770ea 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_claims_{id}_inbound_shipping-method.yaml @@ -1,7 +1,10 @@ post: operationId: PostClaimsIdInboundShippingMethod - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Add an Inbound Shipping Method to a Claim + x-sidebar-summary: Add Inbound Shipping + description: > + Add an inbound (or return) shipping method to a claim. The inbound shipping + method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id 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 f2fdc34e20..5bcfe59002 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 @@ -1,7 +1,15 @@ post: operationId: PostClaimsIdInboundShippingMethodAction_id - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Update Inbound Shipping Method of a Claim + x-sidebar-summary: Update Inbound Shipping + description: > + Update the shipping method for returning items in the claim using the `ID` + of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 d6f4ecc8df..300d782f8f 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 @@ -1,7 +1,10 @@ post: operationId: PostClaimsIdOutboundItems - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Add Outbound Items to a Claim + x-sidebar-summary: Add Outbound Items + description: > + Add outbound (or new) items to a claim. These outbound items will have an + `ITEM_ADD` action. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 0fcb8bab71..72e02bf0d9 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 @@ -1,7 +1,15 @@ post: operationId: PostClaimsIdOutboundItemsAction_id - summary: Add Items to Claim - description: Add a list of items to a claim. + summary: Update Outbound Item of a Claim + x-sidebar-summary: Update Outbound Item + description: > + Update an outbound (or new) item of a claim using the `ID` of the item's + `ITEM_ADD` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the new claim item's `ITEM_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -160,35 +139,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 5559594225..2af4716ee3 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 @@ -1,7 +1,10 @@ post: operationId: PostClaimsIdOutboundShippingMethod - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Add Outbound Shipping Methods to a Claim + x-sidebar-summary: Add Outbound Shipping + description: > + Add an outbound shipping method to a claim. The outbound shipping method + will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3739658ba1..7c5c13a537 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 @@ -1,7 +1,15 @@ post: operationId: PostClaimsIdOutboundShippingMethodAction_id - summary: Add Shipping Methods to Claim - description: Add a list of shipping methods to a claim. + summary: Update Outbound Shipping Method of a Claim + x-sidebar-summary: Update Outbound Shipping + description: > + Update the shipping method for delivering outbound items in a claim using + the `ID` of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The claim's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -160,35 +139,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 75507042e3..96e2788654 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 @@ -1,7 +1,8 @@ post: operationId: PostClaimsIdRequest - summary: Add Requests to Claim - description: Add a list of requests to a claim. + summary: Confirm a Claim Request + x-sidebar-summary: Confirm Claim + description: Confirm a claim request, applying its changes on the associated order. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 10ec30cef4..74415e9378 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections.yaml @@ -1008,35 +1008,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 6de792ec28..de5e87c71a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_collections_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 2e7f0967a5..3b9e95929f 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 @@ -1,7 +1,10 @@ post: operationId: PostCollectionsIdProducts - summary: Add Products to Collection - description: Add a list of products to a collection. + summary: Manage Products of a Collection + x-sidebar-summary: Manage Products + description: >- + Manage the products of a collection by adding or removing them from the + collection. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +48,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The products to add or remove. properties: add: type: array - description: The collection's add. + description: The products to add to the collection. items: type: string title: add - description: The add's details. + description: A product's ID. remove: type: array - description: The collection's remove. + description: The products to remove from the collection. items: type: string title: remove - description: The remove's details. + description: A product's ID. x-codeSamples: - lang: Shell label: cURL 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 b081a745b5..1a221b3187 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_currencies_{code}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 ebb881dbc1..e0ca398f63 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 @@ -1056,35 +1056,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 ea63382b88..eb6f53c273 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customer-groups_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 9fbfcf4601..9da4308c50 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 @@ -1,7 +1,8 @@ post: operationId: PostCustomerGroupsIdCustomers - summary: Add Customers to Customer Group - description: Add a list of customers to a customer group. + summary: Manage Customers of a Customer Group + x-sidebar-summary: Manage Customers + description: Manage the customers of a group to add or remove them from the group. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +46,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The customers to add or remove from the group. properties: add: type: array - description: The customer group's add. + description: The customers to add to the group. items: type: string title: add - description: The add's details. + description: A customer's ID. remove: type: array - description: The customer group's remove. + description: The customers to remove from the group. items: type: string title: remove - description: The remove's details. + description: A customer's ID. x-codeSamples: - lang: Shell label: cURL 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 a8ca3dda3a..f94a36d7cf 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers.yaml @@ -4149,12 +4149,12 @@ get: title: $or - name: has_account in: query - description: The customer's has account. + description: Filter by whether the customer is registered. required: false schema: type: boolean title: has_account - description: The customer's has account. + description: Filter by whether the customer is registered. security: - api_token: [] - cookie_auth: [] @@ -4245,35 +4245,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -4284,7 +4255,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The customer's details. required: - email - company_name @@ -4318,7 +4289,7 @@ post: type: object description: The customer's metadata. - type: object - description: SUMMARY + description: The customer's details. properties: additional_data: type: object @@ -4326,7 +4297,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The customer's details. x-codeSamples: - lang: Shell label: cURL 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 165da2be24..c24e0823fc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -174,7 +116,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The customer's details. required: - email - company_name @@ -208,7 +150,7 @@ post: type: object description: The customer's metadata. - type: object - description: SUMMARY + description: The customer's details. properties: additional_data: type: object @@ -216,7 +158,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The customer's details. x-codeSamples: - lang: Shell label: cURL 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 b89c8f9b2b..93a823f862 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 @@ -236,8 +236,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostCustomersIdAddresses - summary: Add Addresses to Customer - description: Add a list of addresses to a customer. + summary: Add a Customer Address + x-sidebar-summary: Add Address + description: Add an address to a customer. x-authenticated: true parameters: - name: id @@ -272,35 +273,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -311,7 +283,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The address's details. required: - address_name - company @@ -329,60 +301,64 @@ post: address_name: type: string title: address_name - description: The customer's address name. + description: The name of the address. is_default_shipping: type: boolean title: is_default_shipping - description: The customer's is default shipping. + description: >- + Whether this address is used by default for shipping when + placing an order. is_default_billing: type: boolean title: is_default_billing - description: The customer's is default billing. + description: >- + Whether this address is used by default for billing when + placing an order. company: type: string title: company - description: The customer's company. + description: The address's company. first_name: type: string title: first_name - description: The customer's first name. + description: The address's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The customer's address 1. + description: The address's first line. address_2: type: string title: address_2 - description: The customer's address 2. + description: The address's second line. city: type: string title: city - description: The customer's city. + description: The address's city. country_code: type: string title: country_code - description: The customer's country code. + description: The address's country code. province: type: string title: province - description: The customer's province. + description: The address's province. postal_code: type: string title: postal_code - description: The customer's postal code. + description: The address's postal code. phone: type: string title: phone - description: The customer's phone. + description: The address's phone. metadata: type: object - description: The customer's metadata. + description: The address's metadata. - type: object - description: SUMMARY + description: The address's details. properties: additional_data: type: object @@ -390,7 +366,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The address's details. x-codeSamples: - lang: Shell label: cURL 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 b5328b1e48..758825d498 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_customers_{id}_addresses_{address_id}.yaml @@ -44,35 +44,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -106,8 +77,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostCustomersIdAddressesAddress_id - summary: Add Addresses to Customer - description: Add a list of addresses to a customer. + summary: Update a Customer's Address + x-sidebar-summary: Update Address + description: Update a customer address's details. x-authenticated: true parameters: - name: id @@ -148,35 +120,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -187,7 +130,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The address's details. required: - address_name - company @@ -205,60 +148,64 @@ post: address_name: type: string title: address_name - description: The customer's address name. + description: The name of the address. is_default_shipping: type: boolean title: is_default_shipping - description: The customer's is default shipping. + description: >- + Whether this address is used by default for shipping when + placing an order. is_default_billing: type: boolean title: is_default_billing - description: The customer's is default billing. + description: >- + Whether this address is used by default for billing when + placing an order. company: type: string title: company - description: The customer's company. + description: The address's company. first_name: type: string title: first_name - description: The customer's first name. + description: The address's first name. last_name: type: string title: last_name - description: The customer's last name. + description: The address's last name. address_1: type: string title: address_1 - description: The customer's address 1. + description: The address's first line address_2: type: string title: address_2 - description: The customer's address 2. + description: The address's second line city: type: string title: city - description: The customer's city. + description: The address's city. country_code: type: string title: country_code - description: The customer's country code. + description: The address's country code. province: type: string title: province - description: The customer's province. + description: The address's province. postal_code: type: string title: postal_code - description: The customer's postal code. + description: The address's postal code. phone: type: string title: phone - description: The customer's phone. + description: The address's phone. metadata: type: object - description: The customer's metadata. + description: The address's metadata. - type: object - description: SUMMARY + description: The address's details. properties: additional_data: type: object @@ -266,7 +213,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The address's details. x-codeSamples: - lang: Shell label: cURL @@ -339,35 +286,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3d5dbdc927..7b15807b8a 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 @@ -1165,24 +1165,25 @@ get: title: $or - name: sales_channel_id in: query - description: The draft order's sales channel id. + description: Filter by the associated sales channels to retrieve its draft orders. required: false schema: type: array - description: The draft order's sales channel id. + description: Filter by the associated sales channels to retrieve its draft orders. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: fulfillment_status in: query - description: The draft order's fulfillment status. + description: Filter by the fulfillment status of the draft order. required: false schema: type: array - description: The draft order's fulfillment status. + description: Filter by the fulfillment status of the draft order. items: type: string + title: fulfillment_status description: The fulfillment status's details. enum: - canceled @@ -1195,13 +1196,14 @@ get: - delivered - name: payment_status in: query - description: The draft order's payment status. + description: Filter by the payment status of the draft order. required: false schema: type: array - description: The draft order's payment status. + description: Filter by the payment status of the draft order. items: type: string + title: payment_status description: The payment status's details. enum: - canceled @@ -1216,30 +1218,30 @@ get: - requires_action - name: region_id in: query - description: The draft order's region id. + description: Filter by region IDs to retrieve their associated draft orders. required: false schema: type: array - description: The draft order's region id. + description: Filter by region IDs to retrieve their associated draft orders. items: type: string title: region_id - description: The region id's details. + description: A region's ID. - name: q in: query - description: The draft order's q. + description: Search term to filter the order's searchable properties. required: false schema: type: string title: q - description: The draft order's q. + description: Search term to filter the order's searchable properties. - name: created_at in: query - description: The draft order's created at. + description: Filter by the draft order's creation date. required: false schema: type: object - description: The draft order's created at. + description: Filter by the draft order's creation date. properties: $and: type: array @@ -1263,11 +1265,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -1278,21 +1280,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -1320,50 +1320,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- - Filter by values not matching the conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -1414,9 +1410,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -1425,16 +1419,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -1442,15 +1434,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -1497,32 +1485,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The draft order's updated at. + description: Filter by the draft order's update date. required: false schema: type: object - description: The draft order's updated at. + description: Filter by the draft order's update date. properties: $and: type: array @@ -1546,11 +1534,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -1561,21 +1549,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -1603,50 +1589,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- - Filter by values not matching the conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -1697,9 +1679,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -1708,16 +1688,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -1725,15 +1703,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -1780,21 +1754,21 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -1858,7 +1832,9 @@ get: post: operationId: PostDraftOrders summary: Create Draft Order - description: Create a draft order. + description: >- + Create a draft order. This creates an order with the `is_draft_order` + property enabled. x-authenticated: true parameters: - name: expand @@ -1887,35 +1863,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -1926,7 +1873,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The draft order's details. required: - sales_channel_id - email @@ -1937,25 +1884,27 @@ post: - metadata properties: status: - type: boolean + type: string title: status description: The draft order's status. + enum: + - completed sales_channel_id: type: string title: sales_channel_id - description: The draft order's sales channel id. + description: The ID of the associated sales channel. email: type: string title: email - description: The draft order's email. + description: The email of the draft order's customer. format: email customer_id: type: string title: customer_id - description: The draft order's customer id. + description: The ID of the draft order's customer. billing_address: type: object - description: The draft order's billing address. + description: The billing address's details. required: - first_name - last_name @@ -1988,11 +1937,11 @@ post: address_1: type: string title: address_1 - description: The billing address's address 1. + description: The billing address's first line. address_2: type: string title: address_2 - description: The billing address's address 2. + description: The billing address's second line. city: type: string title: city @@ -2047,11 +1996,11 @@ post: address_1: type: string title: address_1 - description: The shipping address's address 1. + description: The shipping address's first line. address_2: type: string title: address_2 - description: The shipping address's address 2. + description: The shipping address's second line. city: type: string title: city @@ -2076,7 +2025,7 @@ post: description: The draft order's items. items: type: object - description: The item's items. + description: The item's details. required: - title - sku @@ -2093,7 +2042,7 @@ post: sku: type: string title: sku - description: The item's sku. + description: The item's SKU. barcode: type: string title: barcode @@ -2101,7 +2050,7 @@ post: variant_id: type: string title: variant_id - description: The item's variant id. + description: The ID of the associated product variant. unit_price: oneOf: - type: string @@ -2123,25 +2072,25 @@ post: precision: type: number title: precision - description: The unit price's precision. + description: The unit price's rounding precision. quantity: type: number title: quantity - description: The item's quantity. + description: The item's ordered quantity. metadata: type: object description: The item's metadata. region_id: type: string title: region_id - description: The draft order's region id. + description: The ID of the associated region. promo_codes: type: array - description: The draft order's promo codes. + description: The promotion codes applied on the draft order. items: type: string title: promo_codes - description: The promo code's promo codes. + description: A promotion code. currency_code: type: string title: currency_code @@ -2149,16 +2098,14 @@ post: no_notification_order: type: boolean title: no_notification_order - description: The draft order's no notification order. + description: Whether to send the customer notifications on order changes. shipping_methods: type: array description: The draft order's shipping methods. items: type: object - description: The shipping method's shipping methods. + description: The shipping method's details. required: - - shipping_method_id - - order_id - name - option_id - amount @@ -2166,11 +2113,7 @@ post: shipping_method_id: type: string title: shipping_method_id - description: The shipping method's shipping method id. - order_id: - type: string - title: order_id - description: The shipping method's order id. + description: The ID of an existing shipping method. name: type: string title: name @@ -2178,10 +2121,17 @@ post: option_id: type: string title: option_id - description: The shipping method's option id. + description: >- + The ID of the shipping option this method is created + from. data: type: object - description: The shipping method's data. + description: >- + The shipping method's data, useful for fulfillment + providers. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/order/concepts#data-property amount: oneOf: - type: string @@ -2203,12 +2153,12 @@ post: precision: type: number title: precision - description: The amount's precision. + description: The amount's rounding precision. metadata: type: object description: The draft order's metadata. - type: object - description: SUMMARY + description: The draft order's details. properties: additional_data: type: object @@ -2216,7 +2166,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The draft order's details. x-codeSamples: - lang: Shell label: cURL 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 98bd2db0af..8ad927980b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges.yaml @@ -1005,7 +1005,9 @@ get: post: operationId: PostExchanges summary: Create Exchange - description: Create a exchange. + description: >- + Create an exchange request. Its changes aren't applied on the order until + the exchange is confirmed. x-authenticated: true parameters: - name: expand @@ -1034,35 +1036,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 bad903180a..03f70a8737 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml index 7c5739d184..d50c124617 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_cancel.yaml @@ -1,7 +1,7 @@ post: operationId: PostExchangesIdCancel - summary: Add Cancels to Exchange - description: Add a list of cancels to a exchange. + summary: Cancel an Exchange + description: Cancel an exchange and its associated return. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml index e6b225ca38..c3c030cd2c 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items.yaml @@ -1,7 +1,10 @@ post: operationId: PostExchangesIdInboundItems - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Add Inbound Items to an Exchange + x-sidebary-summary: Add Inbound Items + description: >- + Add inbound (or return) items to an exchange. These inbound items will have + the action `RETURN_ITEM`. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml index 6ba2e9d871..c2032f38b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_items_{action_id}.yaml @@ -1,7 +1,15 @@ post: operationId: PostExchangesIdInboundItemsAction_id - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Update an Inbount Item of an Exchange + x-sidebar-summary: Update Inbound Item + description: > + Update an inbound (or return) item from an exchange using the `ID` of the + item's `RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the return item's `RETURN_ITEM` action. required: true schema: type: string @@ -106,35 +114,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml index 99576a4e50..d4fdc470dd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_exchanges_{id}_inbound_shipping-method.yaml @@ -1,7 +1,10 @@ post: operationId: PostExchangesIdInboundShippingMethod - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Add an Inbound Shipping Method to an Exchange + x-sidebar-summary: Add Inbound Shipping + description: >- + Add an inbound (or return) shipping method to an exchange. The inbound + shipping method will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id 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 0f7794902c..f19538a075 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 @@ -1,7 +1,15 @@ post: operationId: PostExchangesIdInboundShippingMethodAction_id - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Update Inbound Shipping Method of an Exchange + x-sidebar-summary: Update Inbound Shipping + description: > + Update the shipping method for returning items in the exchange using the + `ID` of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 f100836304..c964f6a4a5 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 @@ -1,7 +1,9 @@ post: operationId: PostExchangesIdOutboundItems - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Add Outbound Items to Exchange + description: >- + Add outbound (or new) items to an exchange. These outbound items will have + the action `ITEM_ADD`. x-authenticated: true parameters: - name: id @@ -36,35 +38,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 303f0ba2fd..7e1d6bf824 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 @@ -1,7 +1,15 @@ post: operationId: PostExchangesIdOutboundItemsAction_id - summary: Add Items to Exchange - description: Add a list of items to a exchange. + summary: Update Outbound Item of an Exchange + x-sidebar-summary: Update Outbound Item + description: > + Update an outbound (or new) item from an exchange using the `ID` of the + item's `ITEM_ADD` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the new exchange item's `ITEM_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -160,35 +139,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 e3fd392399..fef326d741 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 @@ -1,7 +1,10 @@ post: operationId: PostExchangesIdOutboundShippingMethod - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Add Outbound Shipping Method to Exchange + x-sidebar-summary: Add Outbound Shipping + description: >- + Add an outbound shipping method to an exchange. The outbound shipping method + will have a `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 1816097d13..08584a355a 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 @@ -1,7 +1,15 @@ post: operationId: PostExchangesIdOutboundShippingMethodAction_id - summary: Add Shipping Methods to Exchange - description: Add a list of shipping methods to a exchange. + summary: Update Outbound Shipping Method of Exchange + x-sidebar-summary: Update Outbound Shipping + description: > + Update the shipping method for delivering outbound items in the exchange + using the `ID` of the method's `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The exchange's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -160,35 +139,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 092df7975e..c8af8f8867 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 @@ -1,7 +1,7 @@ post: operationId: PostExchangesIdRequest - summary: Add Requests to Exchange - description: Add a list of requests to a exchange. + summary: Confirm an Exchange + description: Confirm an exchange request, applying its changes on the associated order. x-authenticated: true parameters: - name: id @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 109f6ffc8f..a8ac2c6556 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 @@ -1,7 +1,8 @@ post: operationId: PostFulfillmentSetsIdServiceZones - summary: Add Service Zones to Fulfillment Set - description: Add a list of service zones to a fulfillment set. + summary: Add a Service Zone to a Fulfillment Set + x-sidebar-summary: Add Service Zone + description: Add a service zone to a fulfillment set. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,21 +46,21 @@ post: application/json: schema: type: object - description: SUMMARY + description: The service zone's details. required: - name properties: name: type: string title: name - description: The fulfillment set's name. + description: The service zone's name. geo_zones: type: array - description: The fulfillment set's geo zones. + description: The service zone's geo zones. items: oneOf: - type: object - description: The geo zone's geo zones. + description: A country geo zone. required: - metadata - country_code @@ -105,8 +77,9 @@ post: type: string title: type description: The geo zone's type. + default: country - type: object - description: The geo zone's geo zones. + description: A province geo zone. required: - metadata - country_code @@ -124,12 +97,13 @@ post: type: string title: type description: The geo zone's type. + default: province province_code: type: string title: province_code description: The geo zone's province code. - type: object - description: The geo zone's geo zones. + description: A city geo zone required: - metadata - country_code @@ -148,6 +122,7 @@ post: type: string title: type description: The geo zone's type. + default: city province_code: type: string title: province_code @@ -157,7 +132,7 @@ post: title: city description: The geo zone's city. - type: object - description: The geo zone's geo zones. + description: A ZIP geo zone. required: - metadata - country_code @@ -177,6 +152,7 @@ post: type: string title: type description: The geo zone's type. + default: zip province_code: type: string title: province_code @@ -187,7 +163,7 @@ post: description: The geo zone's city. postal_expression: type: object - description: The geo zone's postal expression. + description: The geo zone's postal expression or ZIP code. x-codeSamples: - lang: Shell label: cURL 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 971dd25627..b3818abc68 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillment-sets_{id}_service-zones_{zone_id}.yaml @@ -43,35 +43,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -105,8 +76,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostFulfillmentSetsIdServiceZonesZone_id - summary: Add Service Zones to Fulfillment Set - description: Add a list of service zones to a fulfillment set. + summary: Update the Service Zone of a Fulfillment Set + x-sidebar-summary: Update Service Zone + description: Update the details of a service zone in a fulfillment set. x-authenticated: true parameters: - name: id @@ -117,7 +89,7 @@ post: type: string - name: zone_id in: path - description: The fulfillment set's zone id. + description: The service zone's ID. required: true schema: type: string @@ -147,35 +119,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -185,21 +128,19 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - name + description: The service zone's details. properties: name: type: string title: name - description: The fulfillment set's name. + description: The service zone's name. geo_zones: type: array - description: The fulfillment set's geo zones. + description: The service zone's associated geo zones. items: oneOf: - type: object - description: The geo zone's geo zones. + description: A country geo zone. required: - type - metadata @@ -209,6 +150,7 @@ post: type: string title: type description: The geo zone's type. + default: country metadata: type: object description: The geo zone's metadata. @@ -219,9 +161,9 @@ post: id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. - type: object - description: The geo zone's geo zones. + description: A province geo zone. required: - type - metadata @@ -232,6 +174,7 @@ post: type: string title: type description: The geo zone's type. + default: province metadata: type: object description: The geo zone's metadata. @@ -246,9 +189,9 @@ post: id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. - type: object - description: The geo zone's geo zones. + description: A city geo zone required: - type - metadata @@ -260,6 +203,7 @@ post: type: string title: type description: The geo zone's type. + default: city metadata: type: object description: The geo zone's metadata. @@ -278,9 +222,9 @@ post: id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. - type: object - description: The geo zone's geo zones. + description: A ZIP geo zone. required: - type - metadata @@ -293,6 +237,7 @@ post: type: string title: type description: The geo zone's type. + default: zip metadata: type: object description: The geo zone's metadata. @@ -310,11 +255,11 @@ post: description: The geo zone's province code. postal_expression: type: object - description: The geo zone's postal expression. + description: The geo zone's postal expression or ZIP code. id: type: string title: id - description: The geo zone's ID. + description: The ID of an existing geo zone. x-codeSamples: - lang: Shell label: cURL 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 8dfe9d481f..cb5f9615af 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_fulfillments.yaml @@ -1,7 +1,7 @@ post: operationId: PostFulfillments summary: Create Fulfillment - description: Create a fulfillment. + description: Create a fulfillment for an order, return, exchange, and more. x-authenticated: true parameters: - name: expand @@ -30,35 +30,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 79321c728a..2e5b1dff1a 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 @@ -1,7 +1,12 @@ post: operationId: PostFulfillmentsIdCancel - summary: Add Cancels to Fulfillment - description: Add a list of cancels to a fulfillment. + summary: Cancel a Fulfillment + description: > + Cancel a fulfillment. The fulfillment can't be shipped or delivered. + + + To cancel the fulfillment, the `cancelFulfillment` method of the associated + fulfillment provider is used. x-authenticated: true parameters: - name: id @@ -36,35 +41,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 aaadf584fe..710685b90c 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 @@ -1,7 +1,10 @@ post: operationId: PostFulfillmentsIdShipment - summary: Add Shipments to Fulfillment - description: Add a list of shipments to a fulfillment. + summary: Create a Shipment for a Fulfillment + x-sidebar-summary: Create Shipment + description: >- + Create a shipment for a fulfillment. The fulfillment must not be shipped or + canceled. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 b60170b40f..4205442b00 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 @@ -496,7 +496,7 @@ get: post: operationId: PostInventoryItems summary: Create Inventory Item - description: Create a inventory item. + description: Create an inventory item. x-authenticated: true parameters: - name: expand @@ -525,35 +525,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 9f12c0f75c..8355133ce8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -99,8 +70,8 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostInventoryItemsId - summary: Update a Inventory Item - description: Update a inventory item's details. + summary: Update an Inventory Item + description: Update an inventory item's details. x-authenticated: true parameters: - name: id @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,30 +115,16 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - sku - - hs_code - - weight - - length - - height - - width - - origin_country - - mid_code - - material - - title - - description - - thumbnail - - metadata + description: The properties to update in the inventory item. properties: sku: type: string title: sku - description: The inventory item's sku. + description: The inventory item's SKU. hs_code: type: string title: hs_code - description: The inventory item's hs code. + description: The inventory item's HS code. weight: type: number title: weight @@ -220,7 +148,7 @@ post: mid_code: type: string title: mid_code - description: The inventory item's mid code. + description: The inventory item's MID code. material: type: string title: material @@ -236,14 +164,19 @@ post: requires_shipping: type: boolean title: requires_shipping - description: The inventory item's requires shipping. + description: Whether the inventory item requires shipping. thumbnail: type: string title: thumbnail - description: The inventory item's thumbnail. + description: >- + The URL of an image to be used as the inventory item's + thumbnail. You can use the Upload API routes to upload an image + and get its URL. metadata: type: object - description: The inventory item's metadata. + description: >- + The inventory item's metadata. Can be custom data in key-value + pairs. x-codeSamples: - lang: Shell label: cURL 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 5dc88150ac..50e14869e0 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 @@ -166,8 +166,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostInventoryItemsIdLocationLevels - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. + summary: Create Inventory Level for Inventory Item + x-sidebar-summary: Create Inventory Level + description: Create an inventory level for an inventory item. x-authenticated: true parameters: - name: id @@ -202,35 +203,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -240,22 +212,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The inventory level's details. required: - location_id properties: location_id: type: string title: location_id - description: The inventory item's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity - description: The inventory item's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The inventory item's incoming quantity. + description: The inventory level's incoming quantity. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml index 88399ca32d..30b7f6d186 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_inventory-items_{id}_location-levels_batch.yaml @@ -1,7 +1,8 @@ post: operationId: PostInventoryItemsIdLocationLevelsBatch - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. + summary: Manage Inventory Levels of Inventory Item + x-sidebar-summary: Manage Inventory Levels + description: Manage the inventory levels of an inventory item to create or delete them. x-authenticated: true parameters: - name: id @@ -19,51 +20,51 @@ post: application/json: schema: type: object - description: SUMMARY + description: The inventory levels to create or delete. properties: create: type: array - description: The inventory item's create. + description: The inventory levels to create. items: type: object - description: The create's details. + description: The inventory level's details. required: - location_id properties: location_id: type: string title: location_id - description: The create's location id. + description: The ID of the associated location. stocked_quantity: type: number title: stocked_quantity - description: The create's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The create's incoming quantity. + description: The inventory level's incoming quantity. update: type: array - description: The inventory item's update. + description: The inventory levels to update. items: type: object - description: The update's details. + description: The inventory level's details. properties: stocked_quantity: type: number title: stocked_quantity - description: The update's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The update's incoming quantity. + description: The inventory level's incoming quantity. delete: type: array - description: The inventory item's delete. + description: The inventory levels to delete. items: type: string title: delete - description: The delete's details. + description: The ID of the inventory level to delete. x-codeSamples: - lang: Shell label: cURL @@ -79,7 +80,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The inventory item's details. required: - inventory_item properties: 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 c03daa2c49..69aaabad70 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 @@ -1,7 +1,10 @@ post: operationId: PostInventoryItemsIdLocationLevelsLocation_id - summary: Add Location Levels to Inventory Item - description: Add a list of location levels to a inventory item. + summary: Update an Inventory Level of an Inventory Item + x-sidebar-summary: Update Inventory Level + description: >- + Updates the details of an inventory item's inventory level using its + associated location ID. x-authenticated: true parameters: - name: id @@ -12,7 +15,7 @@ post: type: string - name: location_id in: path - description: The inventory item's location id. + description: The ID of the location associated with the inventory level. required: true schema: type: string @@ -42,35 +45,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -80,16 +54,16 @@ post: application/json: schema: type: object - description: SUMMARY + description: The properties to update in the inventory level. properties: stocked_quantity: type: number title: stocked_quantity - description: The inventory item's stocked quantity. + description: The inventory level's stocked quantity. incoming_quantity: type: number title: incoming_quantity - description: The inventory item's incoming quantity. + description: The inventory level's incoming quantity. x-codeSamples: - lang: Shell label: cURL @@ -168,35 +142,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 2d78344d22..7ada91ddf1 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites.yaml @@ -625,52 +625,23 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: schema: type: object - description: SUMMARY + description: The invite's details. required: - email properties: email: type: string title: email - description: The invite's email. + description: The email of the user to invite. format: email metadata: type: object - description: The invite's metadata. + description: The invite's metadata. Can be custom data in key-value pairs. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml index b16dd3aacd..8eee8dea6f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_accept.yaml @@ -1,88 +1,34 @@ post: operationId: PostInvitesAccept - summary: Create Invite - description: Create a invite. + summary: Accept Invite + description: > + Accept an invite and create a new user. + + Since the user isn't created yet, the JWT token used in the authorization + header is retrieved from the `/auth/user/emailpass/register` API route (or a + provider other than `emailpass`). The user can then authenticate using the + `/auth/user/emailpass` API route. 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. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: schema: type: object - description: SUMMARY - required: - - email - - first_name - - last_name + description: The details of the user to be created. properties: email: type: string title: email - description: The invite's email. + description: The user's email. format: email first_name: type: string title: first_name - description: The invite's first name. + description: The user's first name. last_name: type: string title: last_name - description: The invite's last name. + description: The user's last name. x-codeSamples: - lang: Shell label: cURL @@ -98,21 +44,21 @@ post: schema: oneOf: - type: object - description: SUMMARY + description: The created user's details. required: - user properties: user: $ref: ../components/schemas/AdminUser.yaml - type: object - description: SUMMARY + description: An error's details. required: - message properties: message: type: string title: message - description: The invite's message. + description: The error message. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml index d565d606da..3607317e41 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_invites_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL 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 52cf947d6b..03a174f039 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 @@ -1,7 +1,7 @@ post: operationId: PostInvitesIdResend - summary: Add Resends to Invite - description: Add a list of resends to a invite. + summary: Refresh Invite Token + description: Refresh the token of an invite. x-authenticated: false parameters: - name: id @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL 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 7e5bdb187c..61d7382295 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_notifications_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml index e899fbcce1..b112a354fc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits.yaml @@ -1,9 +1,8 @@ post: operationId: PostOrderEdits summary: Create Order Edit - description: Create a order edit. + description: Create an order edit. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml index 8cb0690452..e398ce56e4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_confirm.yaml @@ -1,7 +1,7 @@ post: operationId: PostOrderEditsIdConfirm - summary: Add Confirms to Order Edit - description: Add a list of confirms to a order edit. + summary: Confirm Order Edit + description: Confirm an order edit request and apply the changes on the order. x-authenticated: true parameters: - name: id @@ -41,7 +41,3 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: confirmOrderEditRequestWorkflow - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml index faebb09175..fd0e9bcba7 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items.yaml @@ -1,7 +1,8 @@ post: operationId: PostOrderEditsIdItems summary: Add Items to Order Edit - description: Add a list of items to a order edit. + x-sidebar-summary: Add Items + description: Add new items to an order edit. These items will have the action `ITEM_ADD`. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml index 33c006c862..babbf7dd53 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_item_{item_id}.yaml @@ -1,7 +1,8 @@ post: operationId: PostOrderEditsIdItemsItemItem_id - summary: Add Items to Order Edit - description: Add a list of items to a order edit. + summary: Update Order Item Quantity of Order Edit + x-sidebar-summary: Update Item Quantity + description: Update an existing order item's quantity of an order edit. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml index 4ba204ddd5..107a1adf23 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_items_{action_id}.yaml @@ -1,7 +1,15 @@ post: operationId: PostOrderEditsIdItemsAction_id - summary: Add Items to Order Edit - description: Add a list of items to a order edit. + summary: Update an Item in an Order Edit + x-sidebar-summary: Update Item + description: > + Update an added item in the order edit by the ID of the item's `ITEM_ADD` + action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the new item's `ITEM_ADD` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml index 59d10f6234..8e95961ea6 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_request.yaml @@ -1,7 +1,7 @@ post: operationId: PostOrderEditsIdRequest - summary: Add Requests to Order Edit - description: Add a list of requests to a order edit. + summary: Request Order Edit + description: Change the status of an active order edit to requested. x-authenticated: true parameters: - name: id @@ -41,7 +41,3 @@ post: '500': $ref: ../components/responses/500_error.yaml x-workflow: requestOrderEditRequestWorkflow - requestBody: - content: - application/json: - schema: {} diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml index bd056e0fd4..2ddbd5453a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method.yaml @@ -1,7 +1,10 @@ post: operationId: PostOrderEditsIdShippingMethod - summary: Add Shipping Methods to Order Edit - description: Add a list of shipping methods to a order edit. + summary: Add Shipping Method to Order Edit + x-sidebar-summary: Add Shipping Method + description: >- + Add a shipping method to an exchange. The shipping method will have a + `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id diff --git a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml index 05666b927a..ae82ca5f04 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_order-edits_{id}_shipping-method_{action_id}.yaml @@ -1,7 +1,15 @@ post: operationId: PostOrderEditsIdShippingMethodAction_id - summary: Add Shipping Methods to Order Edit - description: Add a list of shipping methods to a order edit. + summary: Update Shipping Method of an Order Edit + x-sidebar-summary: Update Shipping Method + description: > + Update a shipping method in the order edit by the ID of the method's + `SHIPPING_ADD` action. + + + Every shipping method has an `actions` property, whose value is an array of + actions. You can check the action's name using its `action` property, and + use the value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The order edit's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml index d1c7c09849..2c433debbd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders.yaml @@ -119,25 +119,27 @@ get: title: $or - name: sales_channel_id in: query - description: The order's sales channel id. + description: Filter by sales channel IDs to retrieve the orders associated with them. required: false schema: type: array - description: The order's sales channel id. + description: >- + Filter by sales channel IDs to retrieve the orders associated with + them. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: fulfillment_status in: query - description: The order's fulfillment status. + description: Filter by the order's fulfillment status. required: false schema: type: array - description: The order's fulfillment status. + description: Filter by the order's fulfillment status. items: type: string - description: The fulfillment status's details. + description: A fulfillment status. enum: - canceled - not_fulfilled @@ -149,14 +151,14 @@ get: - delivered - name: payment_status in: query - description: The order's payment status. + description: Filter by the order's payment status. required: false schema: type: array - description: The order's payment status. + description: Filter by the order's payment status. items: type: string - description: The payment status's details. + description: A payment status enum: - canceled - not_paid @@ -170,30 +172,30 @@ get: - requires_action - name: region_id in: query - description: The order's region id. + description: Filter by region IDs to retrieve their associated orders. required: false schema: type: array - description: The order's region id. + description: Filter by region IDs to retrieve their associated orders. items: type: string title: region_id - description: The region id's details. + description: A region ID. - name: q in: query - description: The order's q. + description: Search term to filter the order's searchable properties. required: false schema: type: string title: q - description: The order's q. + description: Search term to filter the order's searchable properties. - name: created_at in: query - description: The order's created at. + description: Filter by the order's creation date. required: false schema: type: object - description: The order's created at. + description: Filter by the order's creation date. properties: $and: type: array @@ -217,11 +219,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -232,21 +234,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -274,50 +274,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- - Filter by values not matching the conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -368,9 +364,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -379,16 +373,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -396,15 +388,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -451,32 +439,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The order's updated at. + description: Filter by the order's update date. required: false schema: type: object - description: The order's updated at. + description: Filter by the order's update date. properties: $and: type: array @@ -500,11 +488,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -515,21 +503,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -557,50 +543,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- - Filter by values not matching the conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -651,9 +633,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -662,16 +642,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -679,15 +657,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -734,21 +708,21 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists diff --git a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml index 192e0024f0..3dca89586e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_orders_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -100,8 +71,8 @@ get: x-workflow: getOrderDetailWorkflow post: operationId: PostOrdersId - summary: Update a Order - description: Update a order's details. + summary: Update an Order + description: Update an order's details. x-authenticated: true parameters: - name: id @@ -136,35 +107,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 48cecea993..bb0909904c 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 @@ -1,7 +1,7 @@ post: operationId: PostOrdersIdArchive - summary: Add Archives to Order - description: Add a list of archives to a order. + summary: Archive an Order + description: Change the status of an order to archived. x-authenticated: true parameters: - name: id @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 d3918e424d..4c7b0f915f 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 @@ -1,7 +1,15 @@ post: operationId: PostOrdersIdCancel - summary: Add Cancels to Order - description: Add a list of cancels to a order. + summary: Cancel Order + description: | + Cancel an order. The cancelation fails if: + - The order has captured payments. + + + - The order has refund payments. + + + - The order has fulfillments that aren't canceled. x-authenticated: true parameters: - name: id @@ -36,35 +44,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3b07d685ef..fccf4fad63 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 @@ -47,35 +47,6 @@ get: fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 d8165dc12c..f3b4ae8c45 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 @@ -1,7 +1,7 @@ post: operationId: PostOrdersIdComplete - summary: Add Completes to Order - description: Add a list of completes to a order. + summary: Complete Order + description: Mark an order as completed. x-authenticated: true parameters: - name: id @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -73,26 +44,17 @@ post: content: application/json: schema: - allOf: - - type: object - description: SUMMARY - required: - - order_id - properties: - order_id: - type: string - title: order_id - description: The order's order id. - - type: object - description: SUMMARY - properties: - additional_data: - type: object - description: >- - Pass additional custom data to the API route. This data is - passed to the underlying workflow under the - `additional_data` parameter. - description: SUMMARY + type: object + description: >- + Pass additional custom data to the API route. This data is passed to + the underlying workflow under the `additional_data` parameter. + properties: + additional_data: + type: object + description: >- + Pass additional custom data to the API route. This data is + passed to the underlying workflow under the `additional_data` + parameter. x-codeSamples: - lang: Shell label: cURL 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 e2313491c5..ae1e4b00e6 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 @@ -1,7 +1,10 @@ post: operationId: PostOrdersIdFulfillments - summary: Add Fulfillments to Order - description: Add a list of fulfillments to a order. + summary: Create an Order Fulfillment + x-sidebar-summary: Create Fulfillment + description: >- + Create a fulfillment for an order. The creation fails if the order is + canceled. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -75,7 +49,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The fulfillment's details. required: - items - location_id @@ -83,10 +57,10 @@ post: properties: items: type: array - description: The order's items. + description: The items to fulfill. items: type: object - description: The item's items. + description: An item's details. required: - id - quantity @@ -98,20 +72,25 @@ post: quantity: type: number title: quantity - description: The item's quantity. + description: The item's quantity to fulfill. location_id: type: string title: location_id - description: The order's location id. + description: >- + The ID of the location to fulfill the items from. If not + provided, the location associated with the shipping option + of the order's shipping method is used. no_notification: type: boolean title: no_notification - description: The order's no notification. + description: >- + Whether to send the customer a notification about the + created fulfillment. metadata: type: object - description: The order's metadata. + description: The order's metadata. Can hold custom key-value pairs. - type: object - description: SUMMARY + description: The fulfillment's details. properties: additional_data: type: object @@ -119,7 +98,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The fulfillment's details. x-codeSamples: - lang: Shell label: cURL 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 e628da9a10..2f4c2fc2aa 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 @@ -1,7 +1,9 @@ post: operationId: PostOrdersIdFulfillmentsFulfillment_idCancel - summary: Add Cancels to Order - description: Add a list of cancels to a order. + summary: Cancel Fulfillment + description: >- + Cancel an order's fulfillment. The fulfillment can't be canceled if it's + shipped. x-authenticated: true parameters: - name: id @@ -42,35 +44,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -81,14 +54,16 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The cancelation details. properties: no_notification: type: boolean title: no_notification - description: The order's no notification. + description: >- + Whether the customer should receive a notification about + this change. - type: object - description: SUMMARY + description: The cancelation details. properties: additional_data: type: object @@ -96,7 +71,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The cancelation details. x-codeSamples: - lang: Shell label: cURL 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 f941fcbb26..b53454d5fd 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 @@ -1,7 +1,8 @@ post: operationId: PostOrdersIdFulfillmentsFulfillment_idShipments - summary: Add Shipments to Order - description: Add a list of shipments to a order. + summary: Create Shipment for an Order's Fulfillment + x-sidebar-summary: Create Shipment + description: Create a shipment for an order's fulfillment. x-authenticated: true parameters: - name: id @@ -12,7 +13,7 @@ post: type: string - name: fulfillment_id in: path - description: The order's fulfillment id. + description: The fulfillment's ID. required: true schema: type: string @@ -42,35 +43,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -81,17 +53,17 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The shipment's details. required: - items - metadata properties: items: type: array - description: The order's items. + description: The items to create shipment for. items: type: object - description: The item's items. + description: The details of the item to create shipment for. required: - id - quantity @@ -103,10 +75,10 @@ post: quantity: type: number title: quantity - description: The item's quantity. + description: The item's quantity to ship. labels: type: array - description: The order's labels. + description: The labels to create for the shipment. items: type: object description: The label's labels. @@ -126,16 +98,18 @@ post: label_url: type: string title: label_url - description: The label's label url. + description: The label's url. no_notification: type: boolean title: no_notification - description: The order's no notification. + description: >- + Whether to send the customer a notification about the + created shipment. metadata: type: object - description: The order's metadata. + description: The shipment's metadata. Can hold custom key-value pairs. - type: object - description: SUMMARY + description: The shipment's details. properties: additional_data: type: object @@ -143,7 +117,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The shipment's details. x-codeSamples: - lang: Shell label: cURL 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 d3aaf33d7a..399a10837b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payment-collections.yaml @@ -30,35 +30,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -68,7 +39,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The payment collection's details. required: - order_id - amount @@ -76,11 +47,11 @@ post: order_id: type: string title: order_id - description: The payment collection's order id. + description: The ID of the associated order. amount: type: number title: amount - description: The payment collection's amount. + description: The amount to be paid. x-codeSamples: - lang: Shell label: cURL 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 c8aff72572..3341da699e 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 @@ -1,7 +1,10 @@ post: operationId: PostPaymentCollectionsIdMarkAsPaid - summary: Add Mark As Paids to Payment Collection - description: Add a list of mark as paids to a payment collection. + summary: Mark a Payment Collection as Paid + x-sidebar-summary: Mark as Paid + description: >- + Mark a payment collection as paid. This creates and authorizes a payment + session, then capture its payment, using the manual payment provider. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,14 +48,14 @@ post: application/json: schema: type: object - description: SUMMARY + description: The payment details. required: - order_id properties: order_id: type: string title: order_id - description: The payment collection's order id. + description: The ID of the order associated with the payment collection. x-codeSamples: - lang: Shell label: cURL 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 db0da5e9d6..8db16e1342 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_payments_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 03bcd9accd..f0416be21c 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 @@ -1,7 +1,9 @@ post: operationId: PostPaymentsIdCapture - summary: Add Captures to Payment - description: Add a list of captures to a payment. + summary: Capture Payment + description: >- + Capture an amount of a payment. This uses the `capturePayment` method of the + payment provider associated with the payment's collection. x-authenticated: true parameters: - name: id @@ -36,35 +38,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,12 +47,12 @@ post: application/json: schema: type: object - description: SUMMARY + description: The payment's details. properties: amount: type: number title: amount - description: The payment's amount. + description: The amount to capture. x-codeSamples: - lang: Shell label: cURL 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 cd87b7c6eb..cd8dbfde7d 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 @@ -1,7 +1,9 @@ post: operationId: PostPaymentsIdRefund - summary: Add Refunds to Payment - description: Add a list of refunds to a payment. + summary: Refund Payment + description: >- + Refund an amount of a payment. This uses the `refundPayment` method of the + payment provider associated with the payment's collection. x-authenticated: true parameters: - name: id @@ -36,35 +38,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,20 +47,20 @@ post: application/json: schema: type: object - description: SUMMARY + description: The refund's details. properties: amount: type: number title: amount - description: The payment's amount. + description: The amount to refund. refund_reason_id: type: string title: refund_reason_id - description: The payment's refund reason id. + description: The ID of a refund reason. note: type: string title: note - description: The payment's note. + description: A note to attach to the refund. x-codeSamples: - lang: Shell label: cURL 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 078a7ed64f..87b15b482f 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 @@ -475,35 +475,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 51104dc970..aab1d0e6a3 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml index 5942624903..ef71b0b817 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-lists_{id}_prices_batch.yaml @@ -1,7 +1,8 @@ post: operationId: PostPriceListsIdPricesBatch - summary: Add Prices to Price List - description: Add a list of prices to a price list. + summary: Manage Prices in Price List + x-sidebar-summary: Manage Prices + description: Manage the prices of a price list to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -19,90 +20,100 @@ post: application/json: schema: type: object - description: SUMMARY + description: The prices to create, update, or delete. properties: create: type: array - description: The price list's create. + description: The prices to create. items: type: object - description: The create's details. + description: A price's details. required: - currency_code - amount - variant_id - - min_quantity - - max_quantity properties: currency_code: type: string title: currency_code - description: The create's currency code. + description: The price's currency code. amount: type: number title: amount - description: The create's amount. + description: The price's amount. variant_id: type: string title: variant_id - description: The create's variant id. + description: The ID of the variant this price is for. min_quantity: type: number title: min_quantity - description: The create's min quantity. + description: >- + The minimum quantity that must be available of the + associated variant in the cart for this price to apply. max_quantity: type: number title: max_quantity - description: The create's max quantity. + description: >- + The maximum quantity that must be available of the + associated variant in the cart for this price list to + apply. rules: type: object - description: The create's rules. + description: Key-value pair rules to apply on the price. + example: + region_id: 123 update: type: array - description: The price list's update. + description: The prices to update. items: type: object - description: The update's details. + description: The properties to update in a price. required: - id - variant_id - - min_quantity - - max_quantity properties: id: type: string title: id - description: The update's ID. + description: The price's ID. currency_code: type: string title: currency_code - description: The update's currency code. + description: The price's currency code. amount: type: number title: amount - description: The update's amount. + description: The price's amount. variant_id: type: string title: variant_id - description: The update's variant id. + description: The ID of the variant this price is for. min_quantity: type: number title: min_quantity - description: The update's min quantity. + description: >- + The minimum quantity that must be available of the + associated variant in the cart for this price to apply. max_quantity: type: number title: max_quantity - description: The update's max quantity. + description: >- + The maximum quantity that must be available of the + associated variant in the cart for this price list to + apply. rules: type: object - description: The update's rules. + description: Key-value pair rules to apply on the price. + example: + region_id: 123 delete: type: array - description: The price list's delete. + description: The prices to delete. items: type: string title: delete - description: The delete's details. + description: A price's ID. x-codeSamples: - lang: Shell label: cURL 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 9bb3848e4f..208c7f58e6 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 @@ -1,7 +1,7 @@ post: operationId: PostPriceListsIdProducts - summary: Add Products to Price List - description: Add a list of products to a price list. + summary: Remove Products from Price List + description: Remove products from a price list. x-authenticated: true parameters: - name: id @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -73,23 +44,7 @@ post: content: application/json: schema: - type: object - description: SUMMARY - properties: - add: - type: array - description: The price list's add. - items: - type: string - title: add - description: The add's details. - remove: - type: array - description: The price list's remove. - items: - type: string - title: remove - description: The remove's details. + $ref: ../components/schemas/AdminLinkPriceListProducts.yaml x-codeSamples: - lang: Shell label: cURL 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 4b0a976e20..e40cecea5c 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 @@ -202,35 +202,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 a78da610b0..320f4fd56b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_price-preferences_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 9522c0efa4..63d15f4a03 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 @@ -689,35 +689,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 6b103662b1..9cc82ddf45 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-categories_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - name: include_ancestors_tree in: query description: >- @@ -159,35 +130,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -197,10 +139,7 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - parent_category_id - - metadata + description: The properties to update in the product category. properties: name: type: string @@ -213,26 +152,30 @@ post: handle: type: string title: handle - description: The product category's handle. + description: The product category's handle. Must be a unique value. is_internal: type: boolean title: is_internal - description: The product category's is internal. + description: >- + Whether the product category is only used for internal purposes + and shouldn't be shown the customer. is_active: type: boolean title: is_active - description: The product category's is active. + description: Whether the product category is active. parent_category_id: type: string title: parent_category_id - description: The product category's parent category id. + description: The ID of a parent category. metadata: type: object - description: The product category's metadata. + description: >- + The product category's metadata. Can hold custom key-value + pairs. rank: type: number title: rank - description: The product category's rank. + description: The product category's rank among other categories. x-codeSamples: - lang: Shell label: cURL 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 3b4b24a868..d2742e7f43 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 @@ -1,7 +1,8 @@ post: operationId: PostProductCategoriesIdProducts - summary: Add Products to Product Category - description: Add a list of products to a product category. + summary: Manage Products in Product Category + x-sidebar-summary: Manage Products + description: Manage products of a category to add or remove them. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +46,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The products to add or remove from the category. properties: add: type: array - description: The product category's add. + description: The products to add. items: type: string title: add - description: The add's details. + description: A product ID. remove: type: array - description: The product category's remove. + description: The product to remove. items: type: string title: remove - description: The remove's details. + description: A product ID. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-tags.yaml index ee6e431631..9a95a6b97f 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 @@ -598,35 +598,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 0b9d31cb82..171b7050e2 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-tags_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,9 +115,7 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The properties to update in the product tag. properties: value: type: string @@ -183,7 +123,7 @@ post: description: The product tag's value. metadata: type: object - description: The product tag's metadata. + description: The product tag's metadata. Can hold custom key-value pairs. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml b/www/apps/api-reference/specs/admin/paths/admin_product-types.yaml index 6eb5de96d6..381f310e1f 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 @@ -598,35 +598,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 cc43d777ba..d3b6031ab5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_product-types_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,9 +115,7 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The properties to update in the product type. properties: value: type: string @@ -183,7 +123,7 @@ post: description: The product type's value. metadata: type: object - description: The product type's metadata. + description: The product type's metadata. Can hold custom key-value pairs. x-codeSamples: - lang: Shell label: cURL 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 ada1149a1c..f0a098bb85 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products.yaml @@ -766,35 +766,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -806,7 +777,7 @@ post: allOf: - $ref: ../components/schemas/AdminCreateProduct.yaml - type: object - description: SUMMARY + description: The product's details. properties: additional_data: type: object @@ -814,7 +785,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The product's details. x-codeSamples: - lang: Shell label: cURL 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 9f87fcf6ec..fd104b4b4c 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 @@ -1,7 +1,7 @@ post: operationId: PostProductsBatch - summary: Create Product - description: Create a product. + summary: Manage Products + description: Manage products to create, update, or delete them. x-authenticated: true parameters: - name: expand @@ -30,35 +30,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3c12122204..0ed15984ba 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 @@ -1,7 +1,17 @@ post: operationId: PostProductsExport - summary: Create Product - description: Create a product. + summary: Export Products + description: > + Start a product export process to retrieve a CSV of exported products. + + + You'll receive in the response the transaction ID of the workflow generating + the CSV file. To check the status of the execution, send a GET request to + `/admin/workflows-executions/export-products/:transaction-id`. + + 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 @@ -30,35 +40,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml index 2a53548263..719f91f872 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import.yaml @@ -1,9 +1,11 @@ post: operationId: PostProductsImport - summary: Create Product - description: Create a product. + summary: Create Product Import + description: >- + Create a new product import process. The products aren't imported until the + import is confirmed with the `/admin/products/:transaction-id/import` API + route. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml index f9f1b35151..b461de4b15 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_import_{transaction_id}_confirm.yaml @@ -1,12 +1,14 @@ post: operationId: PostProductsImportTransaction_idConfirm - summary: Add Confirms to Product - description: Add a list of confirms to a product. + summary: Confirm Product Import + description: >- + Confirm that a created product import should start importing the products + into Medusa. x-authenticated: true parameters: - name: transaction_id in: path - description: The product's transaction id. + description: The ID of the transaction returned when the product import was created. required: true schema: type: string @@ -35,8 +37,4 @@ post: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml - requestBody: - content: - application/json: - schema: {} x-workflow: importProductsWorkflowId 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 db8086d3fe..7de396a05b 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -175,7 +117,7 @@ post: allOf: - $ref: ../components/schemas/AdminUpdateProduct.yaml - type: object - description: SUMMARY + description: The properties to update in a product. properties: additional_data: type: object @@ -183,7 +125,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in a product. x-codeSamples: - lang: Shell label: cURL 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 53d66042d5..67b6b9a439 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 @@ -193,8 +193,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostProductsIdOptions - summary: Add Options to Product - description: Add a list of options to a product. + summary: Create a Product Option + x-sidebar-summary: Create Option + description: Create an option for a product. x-authenticated: true parameters: - name: id @@ -229,35 +230,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -269,7 +241,7 @@ post: allOf: - $ref: ../components/schemas/AdminCreateProductOption.yaml - type: object - description: SUMMARY + description: The product option's details. properties: additional_data: type: object @@ -277,7 +249,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The product option's details. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml index 499e1fcacb..a20c09545a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_options_{option_id}.yaml @@ -43,35 +43,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,8 +75,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostProductsIdOptionsOption_id - summary: Add Options to Product - description: Add a list of options to a product. + summary: Update a Product's Option + x-sidebar-summary: Update Option + description: Update the details of a product option. x-authenticated: true parameters: - name: id @@ -116,7 +88,7 @@ post: type: string - name: option_id in: path - description: The product's option id. + description: The option's ID. required: true schema: type: string @@ -146,35 +118,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -186,7 +129,7 @@ post: allOf: - $ref: ../components/schemas/AdminUpdateProductOption.yaml - type: object - description: SUMMARY + description: The properties to update in the product option. properties: additional_data: type: object @@ -194,7 +137,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in the product option. x-codeSamples: - lang: Shell label: cURL @@ -270,35 +213,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 c8dcf85577..763569a35b 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 @@ -612,8 +612,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostProductsIdVariants - summary: Add Variants to Product - description: Add a list of variants to a product. + summary: Create a Product Variant + x-sidebar-summary: Create Variant + description: Create a variant for a product. x-authenticated: true parameters: - name: id @@ -648,35 +649,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -688,7 +660,7 @@ post: allOf: - $ref: ../components/schemas/AdminCreateProductVariant.yaml - type: object - description: SUMMARY + description: The product variant's details. properties: additional_data: type: object @@ -696,7 +668,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The product variant's details. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_batch.yaml index 0085279c02..3b4cca0b7f 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 @@ -1,7 +1,8 @@ post: operationId: PostProductsIdVariantsBatch - summary: Add Variants to Product - description: Add a list of variants to a product. + summary: Manage Variants in a Product + x-sidebary-summary: Manage Variants + description: Manage variants in a product to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml index f8152e5d3f..c989c00f32 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_inventory-items_batch.yaml @@ -1,7 +1,11 @@ post: operationId: PostProductsIdVariantsInventoryItemsBatch - summary: Add Inventory Items to Product - description: Add a list of inventory items to a product. + summary: Manage Variants Inventory in a Product + x-sidebar-summary: Manage Variants Inventory + description: >- + Manage a product's variant's inventoris to associate them with inventory + items, update their inventory items, or delete their association with + inventory items. x-authenticated: true parameters: - name: id @@ -19,14 +23,18 @@ post: application/json: schema: type: object - description: SUMMARY + description: The product variant inventories to manage. properties: create: type: array - description: The product's create. + description: >- + The The associations to create between product variants and + inventory items. items: type: object - description: The create's details. + description: >- + The associations to create between a product variant and an + inventory item. required: - required_quantity - inventory_item_id @@ -35,21 +43,25 @@ post: required_quantity: type: number title: required_quantity - description: The create's required quantity. + description: The variant's quantity. inventory_item_id: type: string title: inventory_item_id - description: The create's inventory item id. + description: >- + The ID of the inventory item to associate the variant + with. variant_id: type: string title: variant_id - description: The create's variant id. + description: The ID of the variant. update: type: array - description: The product's update. + description: >- + The product variants to update their association with inventory + items. items: type: object - description: The update's details. + description: Update a product variant's association with an inventory item. required: - required_quantity - inventory_item_id @@ -58,21 +70,25 @@ post: required_quantity: type: number title: required_quantity - description: The update's required quantity. + description: The variant's quantity. inventory_item_id: type: string title: inventory_item_id - description: The update's inventory item id. + description: >- + The ID of the inventory item the variant is associated + with. variant_id: type: string title: variant_id - description: The update's variant id. + description: The ID of the variant. delete: type: array - description: The product's delete. + description: >- + The product variants to delete their association with inventory + items. items: type: object - description: The delete's details. + description: Delete a product variant's association with an inventory item. required: - inventory_item_id - variant_id @@ -80,11 +96,11 @@ post: inventory_item_id: type: string title: inventory_item_id - description: The delete's inventory item id. + description: The ID of the inventory item associated with the variant. variant_id: type: string title: variant_id - description: The delete's variant id. + description: The ID of the variant. x-codeSamples: - lang: Shell label: cURL 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 c577e6cd86..d5016ce4b4 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_products_{id}_variants_{variant_id}.yaml @@ -43,35 +43,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -104,8 +75,9 @@ get: $ref: ../components/responses/500_error.yaml post: operationId: PostProductsIdVariantsVariant_id - summary: Add Variants to Product - description: Add a list of variants to a product. + summary: Update a Product Variant + x-sidebar-summary: Update Variant + description: Update a variant's details. x-authenticated: true parameters: - name: id @@ -146,35 +118,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -186,7 +129,7 @@ post: allOf: - $ref: ../components/schemas/AdminUpdateProductVariant.yaml - type: object - description: SUMMARY + description: The properties to update in the variant. properties: additional_data: type: object @@ -194,7 +137,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in the variant. x-codeSamples: - lang: Shell label: cURL @@ -268,35 +211,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 876e009554..12e691370d 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 @@ -1,7 +1,10 @@ post: operationId: PostProductsIdVariantsVariant_idInventoryItems - summary: Add Inventory Items to Product - description: Add a list of inventory items to a product. + summary: Associate Variant with Inventory Item + x-sidebar-summary: Associate Variant's Inventory + description: >- + Associate with a product variant an inventory item that manages its + inventory details. x-authenticated: true parameters: - name: id @@ -12,7 +15,7 @@ post: type: string - name: variant_id in: path - description: The product's variant id. + description: The variant's ID. required: true schema: type: string @@ -42,35 +45,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 5cb1c3a0c8..a009c5037f 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 @@ -1,7 +1,10 @@ post: operationId: PostProductsIdVariantsVariant_idInventoryItemsInventory_item_id - summary: Add Inventory Items to Product - description: Add a list of inventory items to a product. + summary: Update Product Variant's Inventory Details + x-sidebary-summary: Update Variant Inventory + description: >- + Update the inventory item that manages the inventory details of a product + variant. x-authenticated: true parameters: - name: id @@ -12,13 +15,13 @@ post: type: string - name: variant_id in: path - description: The product's variant id. + description: The variant's ID. required: true schema: type: string - name: inventory_item_id in: path - description: The product's inventory item id. + description: The inventory item's ID. required: true schema: type: string @@ -48,35 +51,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -165,35 +139,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 a95125393c..e1563247be 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions.yaml @@ -652,35 +652,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -691,7 +662,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The promotion's details. required: - code - type @@ -705,19 +676,25 @@ post: is_automatic: type: boolean title: is_automatic - description: The promotion's is automatic. + description: Whether the promotion is applied automatically. type: type: string + description: The promotion's type. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion enum: - standard - buyget campaign_id: type: string title: campaign_id - description: The promotion's campaign id. + description: The ID of the campaign that the promotion belongs to. campaign: type: object - description: The promotion's campaign. + description: >- + The details of a campaign to create and add the promotion to + it. required: - name - campaign_identifier @@ -733,14 +710,16 @@ post: campaign_identifier: type: string title: campaign_identifier - description: The campaign's campaign identifier. + description: The campaign's identifier. description: type: string title: description description: The campaign's description. budget: type: object - description: The campaign's budget. + description: >- + The campaign's budget which, when crossed, ends the + campaign. required: - type - limit @@ -748,6 +727,12 @@ post: properties: type: type: string + description: > + The budget's type. This can't be edited later. Use + `spend` to set a limit on the total amount + discounted by the campaign's promotions. Use `usage` + to set a limit on the total number of times the + campaign's promotions can be used. enum: - spend - usage @@ -758,30 +743,19 @@ post: currency_code: type: string title: currency_code - description: The budget's currency code. + description: >- + The campaign budget's currency code. This can't be + edited later. starts_at: type: string title: starts_at - description: The campaign's starts at. + description: The campaign's start date. format: date-time ends_at: type: string title: ends_at - description: The campaign's ends at. + description: The campaign's end date. format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. application_method: type: object description: The promotion's application method. @@ -802,7 +776,9 @@ post: value: type: number title: value - description: The application method's value. + description: >- + The discounted amount applied by the associated + promotion based on the `type`. currency_code: type: string title: currency_code @@ -810,20 +786,33 @@ post: max_quantity: type: number title: max_quantity - description: The application method's max quantity. + description: >- + The max quantity allowed in the cart for the associated + promotion to be applied. type: type: string + description: >- + The type of the application method indicating how the + associated promotion is applied. enum: - fixed - percentage target_type: type: string + description: >- + The target type of the application method indicating + whether the associated promotion is applied to the + cart's items, shipping methods, or the whole order. enum: - order - shipping_methods - items allocation: type: string + description: >- + The allocation value that indicates whether the + associated promotion is applied on each item in a cart + or split between the items in the cart. enum: - each - across @@ -832,7 +821,7 @@ post: description: The application method's target rules. items: type: object - description: The target rule's target rules. + description: A target rule's details. required: - operator - description @@ -841,6 +830,11 @@ post: properties: operator: type: string + description: >- + The operator used to check whether the target rule + applies on a cart. For example, `eq` means that + the cart's value for the specified attribute must + match the specified value. enum: - gte - lte @@ -856,24 +850,29 @@ post: attribute: type: string title: attribute - description: The target rule's attribute. + description: >- + The attribute to compare against when checking + whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The target rule's values. + description: The attribute's value. + example: prod_123 - type: array - description: The target rule's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 buy_rules: type: array description: The application method's buy rules. items: type: object - description: The buy rule's buy rules. + description: A buy rule's details. required: - operator - description @@ -882,6 +881,11 @@ post: properties: operator: type: string + description: >- + The operator used to check whether the buy rule + applies on a cart. For example, `eq` means that + the cart's value for the specified attribute must + match the specified value. enum: - gte - lte @@ -897,32 +901,44 @@ post: attribute: type: string title: attribute - description: The buy rule's attribute. + description: >- + The attribute to compare against when checking + whether a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The buy rule's values. + description: The attribute's value. + example: prod_123 - type: array - description: The buy rule's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 apply_to_quantity: type: number title: apply_to_quantity - description: The application method's apply to quantity. + description: >- + The quantity that results from matching the `buyget` + promotion's condition. For example, if the promotion is + a "Buy 2 shirts get 1 free", the value f this attribute + is `1`. buy_rules_min_quantity: type: number title: buy_rules_min_quantity - description: The application method's buy rules min quantity. + description: >- + The minimum quantity required for a `buyget` promotion + to be applied. For example, if the promotion is a "Buy 2 + shirts get 1 free", the value of this attribute is `2`. rules: type: array description: The promotion's rules. items: type: object - description: The rule's rules. + description: A rule's details. required: - operator - description @@ -931,6 +947,11 @@ post: properties: operator: type: string + description: >- + The operator used to check whether the buy rule + applies on a cart. For example, `eq` means that the + cart's value for the specified attribute must match + the specified value. enum: - gte - lte @@ -946,20 +967,25 @@ post: attribute: type: string title: attribute - description: The rule's attribute. + description: >- + The attribute to compare against when checking whether + a promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The rule's values. + description: The attribute's value. + example: prod_123 - type: array - description: The rule's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 - type: object - description: SUMMARY + description: The promotion's details. properties: additional_data: type: object @@ -967,7 +993,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The promotion's details. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml index f2ddf82ca5..c89f2dd132 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-attribute-options_{rule_type}.yaml @@ -10,10 +10,12 @@ get: retrieved: - If `rule_type` is `rules`, the attributes of the promotion's type are - retrieved. - If `rule_type` is `target-rules`, the target rules' attributes - of the application method's type are retrieved. - If `rule_type` is - `buy-rules`, the buy rules' attributes of the application method's type are retrieved. + + + - If `rule_type` is `target-rules`, the target rules' attributes of the + application method's type are retrieved. - If `rule_type` is `buy-rules`, + the buy rules' attributes of the application method's type are retrieved. x-authenticated: true parameters: - name: rule_type diff --git a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml index a16bbc60b3..75c2e6bd64 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_rule-value-options_{rule_type}_{rule_attribute_id}.yaml @@ -27,32 +27,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: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - name: offset in: query description: The number of items to skip when retrieving a list. 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 70de8fc96c..d0888f62bd 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_promotions_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -174,7 +116,7 @@ post: schema: allOf: - type: object - description: SUMMARY + description: The properties to update in a promotion. required: - campaign_id properties: @@ -185,93 +127,35 @@ post: is_automatic: type: boolean title: is_automatic - description: The promotion's is automatic. + description: Whether the promotion is applied automatically. type: type: string + description: The promotion's type. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/promotion/concepts#what-is-a-promotion enum: - standard - buyget campaign_id: type: string title: campaign_id - description: The promotion's campaign id. - campaign: - type: object - description: The promotion's campaign. - required: - - name - - campaign_identifier - - description - - budget - - starts_at - - ends_at - properties: - name: - type: string - title: name - description: The campaign's name. - campaign_identifier: - type: string - title: campaign_identifier - description: The campaign's campaign identifier. - description: - type: string - title: description - description: The campaign's description. - budget: - type: object - description: The campaign's budget. - required: - - type - - limit - - currency_code - properties: - type: - type: string - enum: - - spend - - usage - limit: - type: number - title: limit - description: The budget's limit. - currency_code: - type: string - title: currency_code - description: The budget's currency code. - starts_at: - type: string - title: starts_at - description: The campaign's starts at. - format: date-time - ends_at: - type: string - title: ends_at - description: The campaign's ends at. - format: date-time - promotions: - type: array - description: The campaign's promotions. - items: - type: object - description: The promotion's promotions. - required: - - id - properties: - id: - type: string - title: id - description: The promotion's ID. + description: The ID of the campaign that the promotion belongs to. application_method: type: object - description: The promotion's application method. + description: The properties to update in the application method. required: + - id - description - max_quantity - currency_code - apply_to_quantity - buy_rules_min_quantity properties: + id: + type: string + title: id + description: The application method's ID. description: type: string title: description @@ -279,164 +163,63 @@ post: value: type: number title: value - description: The application method's value. + description: >- + The discounted amount applied by the associated + promotion based on the `type`. max_quantity: type: number title: max_quantity - description: The application method's max quantity. + description: >- + The max quantity allowed in the cart for the associated + promotion to be applied. currency_code: type: string title: currency_code description: The application method's currency code. type: type: string + description: >- + The type of the application method indicating how the + associated promotion is applied. enum: - fixed - percentage target_type: type: string + description: >- + The target type of the application method indicating + whether the associated promotion is applied to the + cart's items, shipping methods, or the whole order. enum: - order - shipping_methods - items allocation: type: string + description: >- + The allocation value that indicates whether the + associated promotion is applied on each item in a cart + or split between the items in the cart. enum: - each - across - target_rules: - type: array - description: The application method's target rules. - items: - type: object - description: The target rule's target rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The target rule's description. - attribute: - type: string - title: attribute - description: The target rule's attribute. - values: - oneOf: - - type: string - title: values - description: The target rule's values. - - type: array - description: The target rule's values. - items: - type: string - title: values - description: The value's values. - buy_rules: - type: array - description: The application method's buy rules. - items: - type: object - description: The buy rule's buy rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The buy rule's description. - attribute: - type: string - title: attribute - description: The buy rule's attribute. - values: - oneOf: - - type: string - title: values - description: The buy rule's values. - - type: array - description: The buy rule's values. - items: - type: string - title: values - description: The value's values. apply_to_quantity: type: number title: apply_to_quantity - description: The application method's apply to quantity. + description: >- + The quantity that results from matching the `buyget` + promotion's condition. For example, if the promotion is + a "Buy 2 shirts get 1 free", the value f this attribute + is `1`. buy_rules_min_quantity: type: number title: buy_rules_min_quantity - description: The application method's buy rules min quantity. - rules: - type: array - description: The promotion's rules. - items: - type: object - description: The rule's rules. - required: - - operator - - description - - attribute - - values - properties: - operator: - type: string - enum: - - gte - - lte - - gt - - lt - - eq - - ne - - in - description: - type: string - title: description - description: The rule's description. - attribute: - type: string - title: attribute - description: The rule's attribute. - values: - oneOf: - - type: string - title: values - description: The rule's values. - - type: array - description: The rule's values. - items: - type: string - title: values - description: The value's values. + description: >- + The minimum quantity required for a `buyget` promotion + to be applied. For example, if the promotion is a "Buy 2 + shirts get 1 free", the value of this attribute is `2`. - type: object - description: SUMMARY + description: The properties to update in a promotion. properties: additional_data: type: object @@ -444,7 +227,7 @@ post: Pass additional custom data to the API route. This data is passed to the underlying workflow under the `additional_data` parameter. - description: SUMMARY + description: The properties to update in a promotion. x-codeSamples: - lang: Shell label: cURL 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 50cc535c02..6a69a1a091 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 @@ -1,7 +1,10 @@ post: operationId: PostPromotionsIdBuyRulesBatch - summary: Add Buy Rules to Promotion - description: Add a list of buy rules to a promotion. + summary: Manage the Buy Rules of a Promotion + x-sidebar-summary: Manage Buy Rules + description: >- + Manage the buy rules of a `buyget` promotion to create, update, or delete + them. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +48,25 @@ post: application/json: schema: type: object - description: SUMMARY + description: The buy rules to create, update, or delete. properties: create: type: array - description: The promotion's create. + description: The buy rules to create. items: type: object - description: The create's details. + description: A buy rule's details. required: - operator - - description - attribute - values properties: operator: type: string + description: >- + The operator used to check whether the buy rule applies on + a cart. For example, `eq` means that the cart's value for + the specified attribute must match the specified value. enum: - gte - lte @@ -101,39 +78,47 @@ post: description: type: string title: description - description: The create's description. + description: The buy rule's description. attribute: type: string title: attribute - description: The create's attribute. + description: >- + The attribute to compare against when checking whether a + promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The create's values. + description: The attribute's value. + example: prod_123 - type: array - description: The create's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 update: type: array - description: The promotion's update. + description: The buy rules to update. items: type: object - description: The update's details. + description: The properties to update in a buy rule. required: - id - - description - values properties: id: type: string title: id - description: The update's ID. + description: The buy rule's ID. operator: type: string + description: >- + The operator used to check whether the buy rule applies on + a cart. For example, `eq` means that the cart's value for + the specified attribute must match the specified value. enum: - gte - lte @@ -145,29 +130,34 @@ post: description: type: string title: description - description: The update's description. + description: The buy rule's description. attribute: type: string title: attribute - description: The update's attribute. + description: >- + The attribute to compare against when checking whether a + promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The update's values. + description: The attribute's value. + example: prod_123 - type: array - description: The update's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 delete: type: array - description: The promotion's delete. + description: The buy rules to delete. items: type: string title: delete - description: The delete's details. + description: A buy rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -182,7 +172,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The result of the batch operations. required: - created - updated @@ -190,17 +180,17 @@ post: properties: created: type: array - description: The promotion's created. + description: The created buy rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml updated: type: array - description: The promotion's updated. + description: The updated buy rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml deleted: type: object - description: The promotion's deleted. + description: The details of the deleted buy rules. required: - ids - object @@ -208,19 +198,20 @@ post: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the buy rules that were deleted. items: type: string title: ids - description: The id's ids. + description: A buy rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the object that was deleted. + default: promotion-rule deleted: type: boolean title: deleted - description: The deleted's details. + description: Whether the buy rules were deleted. '400': $ref: ../components/responses/400_error.yaml '401': 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 13be0fad44..d44381ccec 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 @@ -1,7 +1,8 @@ post: operationId: PostPromotionsIdRulesBatch - summary: Add Rules to Promotion - description: Add a list of rules to a promotion. + summary: Manage a Promotion's Rules + x-sidebar-summary: Manage Rules + description: Manage the rules of a promotion to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +46,25 @@ post: application/json: schema: type: object - description: SUMMARY + description: The rules to create, update, or delete. properties: create: type: array - description: The promotion's create. + description: The rules to create. items: type: object - description: The create's details. + description: A rule's details. required: - operator - - description - attribute - values properties: operator: type: string + description: >- + The operator used to check whether the rule applies on a + cart. For example, `eq` means that the cart's value for + the specified attribute must match the specified value. enum: - gte - lte @@ -101,39 +76,47 @@ post: description: type: string title: description - description: The create's description. + description: The rule's description. attribute: type: string title: attribute - description: The create's attribute. + description: >- + The attribute to compare against when checking whether a + promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The create's values. + description: The attribute's value. + example: prod_123 - type: array - description: The create's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 update: type: array - description: The promotion's update. + description: The rules to update. items: type: object - description: The update's details. + description: The properties to update in a rule. required: - id - - description - values properties: id: type: string title: id - description: The update's ID. + description: The rule's ID. operator: type: string + description: >- + The operator used to check whether the rule applies on a + cart. For example, `eq` means that the cart's value for + the specified attribute must match the specified value. enum: - gte - lte @@ -145,29 +128,34 @@ post: description: type: string title: description - description: The update's description. + description: The rule's description. attribute: type: string title: attribute - description: The update's attribute. + description: >- + The attribute to compare against when checking whether a + promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The update's values. + description: The attribute's value. + example: prod_123 - type: array - description: The update's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 delete: type: array - description: The promotion's delete. + description: The rules to delete. items: type: string title: delete - description: The delete's details. + description: A rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -182,7 +170,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The result of the batch operations. required: - created - updated @@ -190,17 +178,17 @@ post: properties: created: type: array - description: The promotion's created. + description: The created rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml updated: type: array - description: The promotion's updated. + description: The updated rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml deleted: type: object - description: The promotion's deleted. + description: The details of the deleted buy rules. required: - ids - object @@ -208,19 +196,20 @@ post: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted rules. items: type: string title: ids - description: The id's ids. + description: A rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the object that was deleted. + default: promotion-rule deleted: type: boolean title: deleted - description: The deleted's details. + description: Whether the rules were deleted. '400': $ref: ../components/responses/400_error.yaml '401': 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 980977b0b4..5b3ce4053d 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 @@ -1,7 +1,8 @@ post: operationId: PostPromotionsIdTargetRulesBatch - summary: Add Target Rules to Promotion - description: Add a list of target rules to a promotion. + summary: Manage Target Rules of a Promotion + x-sidebar-summary: Manage Target Rules + description: Manage the target rules of a promotion to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +46,26 @@ post: application/json: schema: type: object - description: SUMMARY + description: The target rules to create, update, or delete. properties: create: type: array - description: The promotion's create. + description: The target rules to create. items: type: object - description: The create's details. + description: A target rule's details. required: - operator - - description - attribute - values properties: operator: type: string + description: >- + The operator used to check whether the target rule applies + on a cart. For example, `eq` means that the cart's value + for the specified attribute must match the specified + value. enum: - gte - lte @@ -101,39 +77,48 @@ post: description: type: string title: description - description: The create's description. + description: The target rule's description. attribute: type: string title: attribute - description: The create's attribute. + description: >- + The attribute to compare against when checking whether a + promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The create's values. + description: The attribute's value. + example: prod_123 - type: array - description: The create's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 update: type: array - description: The promotion's update. + description: The target rules to update. items: type: object - description: The update's details. + description: The properties to update in a target rule. required: - id - - description - values properties: id: type: string title: id - description: The update's ID. + description: The target rule's ID. operator: type: string + description: >- + The operator used to check whether the target rule applies + on a cart. For example, `eq` means that the cart's value + for the specified attribute must match the specified + value. enum: - gte - lte @@ -145,29 +130,34 @@ post: description: type: string title: description - description: The update's description. + description: The target rule's description. attribute: type: string title: attribute - description: The update's attribute. + description: >- + The attribute to compare against when checking whether a + promotion can be applied on a cart. + example: items.product.id values: oneOf: - type: string title: values - description: The update's values. + description: The attribute's value. + example: prod_123 - type: array - description: The update's values. + description: The allowed attribute values. items: type: string title: values - description: The value's values. + description: An attribute value. + example: prod_123 delete: type: array - description: The promotion's delete. + description: The target rules to delete. items: type: string title: delete - description: The delete's details. + description: A target rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -182,7 +172,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The result of the batch operations. required: - created - updated @@ -190,17 +180,17 @@ post: properties: created: type: array - description: The promotion's created. + description: The created target rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml updated: type: array - description: The promotion's updated. + description: The updated target rules. items: $ref: ../components/schemas/AdminPromotionRule.yaml deleted: type: object - description: The promotion's deleted. + description: The details of the deleted target rules. required: - ids - object @@ -208,19 +198,20 @@ post: properties: ids: type: array - description: The deleted's ids. + description: The IDs of deleted target rules. items: type: string title: ids - description: The id's ids. + description: A target rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the object that was deleted. + default: promotion-rule deleted: type: boolean title: deleted - description: The deleted's details. + description: Whether the target rules were deleted. '400': $ref: ../components/responses/400_error.yaml '401': 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 613807fcee..9a352b1e9e 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 @@ -8,8 +8,11 @@ get: - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's - application method are retrieved. - If `rule_type` is `buy-rules`, the buy - rules of the promotion's application method are retrieved. + application method are retrieved. + + + - If `rule_type` is `buy-rules`, the buy rules of the promotion's + application method are retrieved. x-authenticated: true parameters: - name: id @@ -54,35 +57,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 4c4f513bd8..394eb15694 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 @@ -202,35 +202,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 259e197ef5..77f2837a6d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_refund-reasons_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,9 +115,7 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - description + description: The properties to update in the refund reason. properties: label: type: string 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 8e21c26cd1..690746812d 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions.yaml @@ -83,20 +83,6 @@ get: type: string title: id description: A region's ID. - - name: code - in: query - required: false - schema: - oneOf: - - type: string - title: code - description: Filter by a currency code. - - type: array - description: Filter by currency codes. - items: - type: string - title: code - description: A currency code. - name: name in: query required: false @@ -550,6 +536,20 @@ get: items: type: object title: $or + - name: currency_code + in: query + required: false + schema: + oneOf: + - type: string + title: currency_code + description: The region's currency code. + - type: array + description: The region's currency code. + items: + type: string + title: currency_code + description: The currency code's details. security: - api_token: [] - cookie_auth: [] @@ -643,35 +643,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 740cbf772d..b4abe775dc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_regions_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,9 +115,7 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The propeties to update in the region. properties: name: type: string @@ -191,25 +131,27 @@ post: items: type: string title: countries - description: The country's countries. + description: A country code. automatic_taxes: type: boolean title: automatic_taxes - description: The region's automatic taxes. + description: >- + Whether taxes are calculated automatically for carts in the + region. payment_providers: type: array - description: The region's payment providers. + description: The payment providers enabled in the region. items: type: string title: payment_providers - description: The payment provider's payment providers. + description: A payment provider's ID. metadata: type: object - description: The region's metadata. + description: The region's metadata. Can hold custom key-value pairs. is_tax_inclusive: type: boolean title: is_tax_inclusive - description: The region's is tax inclusive. + description: Whether the prices in the region are tax inclusive. x-codeSamples: - lang: Shell label: cURL 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 0edcb0be1b..b43eb4502a 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations.yaml @@ -703,35 +703,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 6c8b2b484d..d04362a2bb 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_reservations_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,26 +115,23 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - description - - metadata + description: The properties to update in the reservation. properties: location_id: type: string title: location_id - description: The reservation's location id. + description: The ID of the associated location. quantity: type: number title: quantity - description: The reservation's quantity. + description: The reserved quantity. description: type: string title: description description: The reservation's description. metadata: type: object - description: The reservation's metadata. + description: The reservation's metadata. Can hold custom key-value pairs. x-codeSamples: - lang: Shell label: cURL 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 a618a6b137..d8a5bb3dc8 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 @@ -656,35 +656,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 a164fc8d1e..f62004d79e 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_return-reasons_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 5d14ccd833..34604b2318 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns.yaml @@ -119,25 +119,25 @@ get: title: $or - name: sales_channel_id in: query - description: The return's sales channel id. + description: Filter by sales channel IDs to retrieve their associated returns. required: false schema: type: array - description: The return's sales channel id. + description: Filter by sales channel IDs to retrieve their associated returns. items: type: string title: sales_channel_id - description: The sales channel id's details. + description: A sales channel's ID. - name: fulfillment_status in: query - description: The return's fulfillment status. + description: Filter by fulfillment statuses. required: false schema: type: array - description: The return's fulfillment status. + description: Filter by fulfillment statuses. items: type: string - description: The fulfillment status's details. + description: A fulfillment status. enum: - canceled - not_fulfilled @@ -149,14 +149,14 @@ get: - delivered - name: payment_status in: query - description: The return's payment status. + description: Filter by payment statuses. required: false schema: type: array - description: The return's payment status. + description: Filter by payment statuses. items: type: string - description: The payment status's details. + description: A payment status. enum: - canceled - not_paid @@ -170,30 +170,30 @@ get: - requires_action - name: region_id in: query - description: The return's region id. + description: Filter by region IDs to retrieve their associated returns. required: false schema: type: array - description: The return's region id. + description: Filter by region IDs to retrieve their associated returns. items: type: string title: region_id description: The region id's details. - name: q in: query - description: The return's q. + description: Search term to filter the return's searchable properties. required: false schema: type: string title: q - description: The return's q. + description: Search term to filter the return's searchable properties. - name: created_at in: query - description: The return's created at. + description: Filter by the return's creation date. required: false schema: type: object - description: The return's created at. + description: Filter by the return's creation date. properties: $and: type: array @@ -217,11 +217,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -232,21 +232,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -274,50 +272,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- - Filter by values not matching the conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -368,9 +362,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -379,16 +371,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -396,15 +386,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -451,32 +437,32 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists description: Filter by whether a value for this parameter exists (not `null`). - name: updated_at in: query - description: The return's updated at. + description: Filter by the return's update date. required: false schema: type: object - description: The return's updated at. + description: Filter by the return's update date. properties: $and: type: array @@ -500,11 +486,11 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: An exact match. $ne: type: string title: $ne @@ -515,21 +501,19 @@ get: items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value not to match. $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter. - type: object description: >- Filter by values not matching the conditions in this @@ -557,50 +541,46 @@ get: title: $eq description: Filter by an exact match. - type: array - description: Filter by an exact match. + description: Filter by multiple exact matches. items: type: string title: $eq - description: Filter by an exact match. + description: The value to match. $ne: type: string title: $ne - description: Filter by values not equal to this parameter. + description: Filter by values not matching this parameter. $in: type: array description: Filter by values in this array. items: type: string title: $in - description: Filter by values in this array. + description: The value to match. $nin: type: array description: Filter by values not in this array. items: type: string title: $nin - description: Filter by values not in this array. + description: The value to not match $not: oneOf: - type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching this parameter - type: object description: >- Filter by values not matching the conditions in this parameter. - type: array description: >- - Filter by values not matching the conditions in this + Filter by values not matching the values of this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -651,9 +631,7 @@ get: items: type: string title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. + description: The value to match. $contains: type: array description: >- @@ -662,16 +640,14 @@ get: items: type: string title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -679,15 +655,11 @@ get: Filter by whether a value for this parameter exists (not `null`). - type: array - description: >- - Filter by values not matching the conditions in this - parameter. + description: Filter by values not matching those in this parameter. items: type: string title: $not - description: >- - Filter by values not matching the conditions in this - parameter. + description: The values to not match. $gt: type: string title: $gt @@ -734,21 +706,21 @@ get: items: type: string title: $overlap - description: Filter arrays that have overlapping values with this parameter. + description: The values to match. $contains: type: array description: Filter arrays that contain some of the values of this parameter. items: type: string title: $contains - description: Filter arrays that contain some of the values of this parameter. + description: The values to match. $contained: type: array description: Filter arrays that contain all values of this parameter. items: type: string title: $contained - description: Filter arrays that contain all values of this parameter. + description: The values to match. $exists: type: boolean title: $exists @@ -815,7 +787,7 @@ get: post: operationId: PostReturns summary: Create Return - description: Create a return. + description: Create a return. The return can later be requested or confirmed. x-authenticated: true parameters: - name: expand @@ -844,35 +816,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 9277475ea7..310ff7f9cc 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml index c6d72608d4..8902f29c16 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_cancel.yaml @@ -1,7 +1,7 @@ post: operationId: PostReturnsIdCancel - summary: Add Cancels to Return - description: Add a list of cancels to a return. + summary: Cancel a return. + description: Cancel a return. x-authenticated: true parameters: - name: id 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 e2133145e8..ca51db616c 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 @@ -1,7 +1,10 @@ post: operationId: PostReturnsIdDismissItems - summary: Add Dismiss Items to Return - description: Add a list of dismiss items to a return. + summary: Add Damaged Items to Return + x-sidebar-summary: Add Damaged Items + description: >- + Add damaged items, whose quantity is to be dismissed, to a return. These + items will have the action `RECEIVE_DAMAGED_RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 5248bdaf4a..00b89a318b 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 @@ -1,7 +1,15 @@ post: operationId: PostReturnsIdDismissItemsAction_id - summary: Add Dismiss Items to Return - description: Add a list of dismiss items to a return. + summary: Update Damaged Item of Return + x-sidebar-summary: Update Damaged Item + description: > + Update a damaged item, whose quantity is to be dismissed, in the return by + the ID of the item's `RECEIVE_DAMAGED_RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. return. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the damaged item's `RECEIVE_DAMAGED_RETURN_ITEM` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -161,35 +140,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 8d706eb5c9..fa0ec7b8f7 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 @@ -1,7 +1,10 @@ post: operationId: PostReturnsIdReceiveItems - summary: Add Receive Items to Return - description: Add a list of receive items to a return. + summary: Add Received Items to Return + x-sidebar-summary: Add Received Items + description: >- + Add received items in a return. These items will have the action + `RECEIVE_RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 50f3cc6dfe..525fa503e0 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 @@ -1,120 +1,9 @@ post: operationId: PostReturnsIdReceiveItemsAction_id - summary: Add Receive Items to Return - description: Add a list of receive items to a return. - x-authenticated: true - parameters: - - name: id - in: path - description: The return's ID. - required: true - schema: - type: string - - name: action_id - in: path - description: The return's action id. - required: true - schema: - type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh - tags: - - Returns - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: ../components/schemas/AdminReturnPreviewResponse.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: updateReceiveItemReturnRequestWorkflow -delete: - operationId: DeleteReturnsIdReceiveItemsAction_id - summary: Remove a Received Item from Return - x-sidebar-summary: Remove Received Item + summary: Update a Received Item in a Return + x-sidebar-summary: Update Received Item description: > - Remove an item marked as received in the return by the ID of the item's + Update a received item in the return by the ID of the item's `RECEIVE_RETURN_ITEM` action. @@ -161,35 +50,96 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostReturnsReceiveItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_returns_{id}_receive-items_{action_id}/post.sh + tags: + - Returns + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.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: updateReceiveItemReturnRequestWorkflow +delete: + operationId: DeleteReturnsIdReceiveItemsAction_id + summary: Remove a Received Item from Return + x-sidebar-summary: Remove Received Item + description: > + Remove a received item in the return by the ID of the item's + `RECEIVE_RETURN_ITEM` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false + type: string + - name: action_id + in: path + description: The ID of the received item's `RECEIVE_RETURN_ITEM` action. + required: true schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order + type: string + - name: expand 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 `-`. + description: Comma-separated relations that should be expanded in the returned data. required: false schema: type: string - title: order + title: expand description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. + required: false + schema: + type: string + title: fields + description: >- + Comma-separated fields that should be included in the returned data. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_receive.yaml index 1000aa992d..7c0b8ae15c 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 @@ -1,7 +1,9 @@ post: operationId: PostReturnsIdReceive - summary: Add Receives to Return - description: Add a list of receives to a return. + summary: Start Return Receival + description: >- + Start a return receival process to be later confirmed using the + `/admin/returns/:id/receive/confirm` API route. x-authenticated: true parameters: - name: id @@ -36,35 +38,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 4032342b48..5a56d41741 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 @@ -1,7 +1,9 @@ post: operationId: PostReturnsIdReceiveConfirm - summary: Add Confirms to Return - description: Add a list of confirms to a return. + summary: Confirm Return Receival + description: > + Confirm that a return has been received. This updates the quantity of the + items received, if not damaged, and reflects the changes on the order. x-authenticated: true parameters: - name: id @@ -36,35 +38,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 37ff3bd1cb..5a8ae2de66 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 @@ -1,7 +1,10 @@ post: operationId: PostReturnsIdRequestItems - summary: Add Request Items to Return - description: Add a list of request items to a return. + summary: Add Requested Items to Return + x-sidebar-summary: Add Items + description: >- + Add items that are requested to be returned. These items will have the + action `RETURN_ITEM`. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3f527ba2da..b6911a875c 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 @@ -1,120 +1,10 @@ post: operationId: PostReturnsIdRequestItemsAction_id - summary: Add Request Items to Return - description: Add a list of request items to a return. - x-authenticated: true - parameters: - - name: id - in: path - description: The return's ID. - required: true - schema: - type: string - - name: action_id - in: path - description: The return's action id. - required: true - schema: - type: string - - name: expand - in: query - description: Comma-separated relations that should be expanded in the returned data. - required: false - schema: - type: string - title: expand - description: >- - Comma-separated relations that should be expanded in the returned - data. - - name: fields - in: query - description: >- - Comma-separated fields that should be included in the returned data. if - a field is prefixed with `+` it will be added to the default fields, - using `-` will remove it from the default fields. without prefix it will - replace the entire default fields. - required: false - schema: - type: string - title: fields - description: >- - Comma-separated fields that should be included in the returned data. - if a field is prefixed with `+` it will be added to the default - fields, using `-` will remove it from the default fields. without - prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - security: - - api_token: [] - - cookie_auth: [] - - jwt_token: [] - requestBody: - content: - application/json: - schema: - $ref: >- - ../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml - x-codeSamples: - - lang: Shell - label: cURL - source: - $ref: >- - ../code_samples/Shell/admin_returns_{id}_request-items_{action_id}/post.sh - tags: - - Returns - responses: - '200': - description: OK - content: - application/json: - schema: - $ref: ../components/schemas/AdminReturnPreviewResponse.yaml - '400': - $ref: ../components/responses/400_error.yaml - '401': - $ref: ../components/responses/unauthorized.yaml - '404': - $ref: ../components/responses/not_found_error.yaml - '409': - $ref: ../components/responses/invalid_state_error.yaml - '422': - $ref: ../components/responses/invalid_request_error.yaml - '500': - $ref: ../components/responses/500_error.yaml - x-workflow: updateRequestItemReturnWorkflow -delete: - operationId: DeleteReturnsIdRequestItemsAction_id - summary: Remove Item from Return - x-sidebar-summary: Remove Item + summary: Update Requested Item in Return + x-sidebar-summary: Update Requested Item description: > - Remove an item in the return by the ID of the item's `RETURN_ITEM` action. + Update a requested item to be returned by the ID of the item's + `RETURN_ITEM` action. Every item has an `actions` property, whose value is an array of actions. @@ -160,35 +50,96 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false + security: + - api_token: [] + - cookie_auth: [] + - jwt_token: [] + requestBody: + content: + application/json: + schema: + $ref: >- + ../components/schemas/AdminPostReturnsRequestItemsActionReqSchema.yaml + x-codeSamples: + - lang: Shell + label: cURL + source: + $ref: >- + ../code_samples/Shell/admin_returns_{id}_request-items_{action_id}/post.sh + tags: + - Returns + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: ../components/schemas/AdminReturnPreviewResponse.yaml + '400': + $ref: ../components/responses/400_error.yaml + '401': + $ref: ../components/responses/unauthorized.yaml + '404': + $ref: ../components/responses/not_found_error.yaml + '409': + $ref: ../components/responses/invalid_state_error.yaml + '422': + $ref: ../components/responses/invalid_request_error.yaml + '500': + $ref: ../components/responses/500_error.yaml + x-workflow: updateRequestItemReturnWorkflow +delete: + operationId: DeleteReturnsIdRequestItemsAction_id + summary: Remove Item from Return + x-sidebar-summary: Remove Item + description: > + Remove a requested item to be returned by the ID of the item's `RETURN_ITEM` + action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. return. + x-authenticated: true + parameters: + - name: id + in: path + description: The return's ID. + required: true schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false + type: string + - name: action_id + in: path + description: The ID of the item's `RETURN_ITEM` action. + required: true schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order + type: string + - name: expand 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 `-`. + description: Comma-separated relations that should be expanded in the returned data. required: false schema: type: string - title: order + title: expand description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. + Comma-separated relations that should be expanded in the returned + data. + - name: fields + in: query + description: >- + Comma-separated fields that should be included in the returned data. if + a field is prefixed with `+` it will be added to the default fields, + using `-` will remove it from the default fields. without prefix it will + replace the entire default fields. + required: false + schema: + type: string + title: fields + description: >- + Comma-separated fields that should be included in the returned data. + if a field is prefixed with `+` it will be added to the default + fields, using `-` will remove it from the default fields. without + prefix it will replace the entire default fields. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml b/www/apps/api-reference/specs/admin/paths/admin_returns_{id}_request.yaml index 2948468390..b9ebd7e210 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 @@ -1,7 +1,10 @@ post: operationId: PostReturnsIdRequest - summary: Add Requests to Return - description: Add a list of requests to a return. + summary: Confirm Return Request + description: > + Confirm a requested return. The changes are applied on the inventory + quantity and the order only after the return has been confirmed as received + using the `/admin/returns/:id/received/confirm`. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 c5f67f76fc..cd0b03af8c 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 @@ -1,7 +1,10 @@ post: operationId: PostReturnsIdShippingMethod - summary: Add Shipping Methods to Return - description: Add a list of shipping methods to a return. + summary: Add a Shipping Method to a Return + x-sidebar-summary: Add Shipping Method + description: >- + Add a shipping method to a return. The shipping method will have a + `SHIPPING_ADD` action. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 bbd82a7752..097fd715ad 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 @@ -1,7 +1,15 @@ post: operationId: PostReturnsIdShippingMethodAction_id - summary: Add Shipping Methods to Return - description: Add a list of shipping methods to a return. + summary: Update a Shipping Method of a Return + x-sidebar-summary: Update Shipping Method + description: > + Update a shipping method of the return by the ID of the item's + `SHIPPING_ADD` action. + + + Every item has an `actions` property, whose value is an array of actions. + You can check the action's name using its `action` property, and use the + value of the `id` property. x-authenticated: true parameters: - name: id @@ -12,7 +20,7 @@ post: type: string - name: action_id in: path - description: The return's action id. + description: The ID of the shipping method's `SHIPPING_ADD` action. required: true schema: type: string @@ -42,35 +50,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -160,35 +139,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 9ef05b87d0..e00afd0bda 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 @@ -681,35 +681,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3522451fc8..3431c8ff42 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_sales-channels_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 c55279186d..6f03d37217 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 @@ -1,7 +1,8 @@ post: operationId: PostSalesChannelsIdProducts - summary: Add Products to Sales Channel - description: Add a list of products to a sales channel. + summary: Manage Products in Sales Channel + x-sidebar-summary: Manage Products + description: Manage products in a sales channel to add or remove them from the channel. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +46,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The products to add or remove from the channel. properties: add: type: array - description: The sales channel's add. + description: The products to add to the sales channel. items: type: string title: add - description: The add's details. + description: A product's ID. remove: type: array - description: The sales channel's remove. + description: The products to remove from the sales channel. items: type: string title: remove - description: The remove's details. + description: A product's ID. x-codeSamples: - lang: Shell label: cURL 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 a9f3e79a28..5b8a8a51ac 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 @@ -592,20 +592,20 @@ get: description: A stock location's ID. - name: is_return in: query - description: The shipping option's is return. + description: Filter by whether the shipping option is used for returns. required: false schema: type: boolean title: is_return - description: The shipping option's is return. + description: Filter by whether the shipping option is used for returns. - name: admin_only in: query - description: The shipping option's admin only. + description: Filter by whether the shipping option is used by admin users only. required: false schema: type: boolean title: admin_only - description: The shipping option's admin only. + description: Filter by whether the shipping option is used by admin users only. security: - api_token: [] - cookie_auth: [] @@ -699,35 +699,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 62bbbfefd8..3405df4b55 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,7 +45,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The properties to update in the shipping option. properties: name: type: string @@ -82,20 +53,32 @@ post: description: The shipping option's name. data: type: object - description: The shipping option's data. + description: >- + The shipping option's data that is useful for third-party + providers. + externalDocs: + url: >- + https://docs.medusajs.com/v2/resources/commerce-modules/fulfillment/shipping-option#data-property price_type: type: string + description: > + The type of the shipping option's price. If `calculated`, its + price is retrieved by the associated fulfillment provider + during checkout. If `flat`, its price is set in the `prices` + property. enum: - calculated - flat provider_id: type: string title: provider_id - description: The shipping option's provider id. + description: >- + The ID of the associated fulfillment provider that is used to + process the option. shipping_profile_id: type: string title: shipping_profile_id - description: The shipping option's shipping profile id. + description: The ID of the shipping profile this shipping option belongs to. type: type: object description: The shipping option's type. @@ -118,16 +101,18 @@ post: description: The type's code. prices: type: array - description: The shipping option's prices. + description: >- + The shipping option's prices. If the `price_type` is + `calculated`, pass an empty array. items: oneOf: - type: object - description: The price's prices. + description: The shipping option's price for a currency code. properties: id: type: string title: id - description: The price's ID. + description: The ID of an existing price. currency_code: type: string title: currency_code @@ -137,16 +122,16 @@ post: title: amount description: The price's amount. - type: object - description: The price's prices. + description: The shipping option's price for a region. properties: id: type: string title: id - description: The price's ID. + description: The ID of an existing price. region_id: type: string title: region_id - description: The price's region id. + description: The ID of the associated region. amount: type: number title: amount @@ -157,7 +142,7 @@ post: items: oneOf: - type: object - description: The rule's rules. + description: The details of a new shipping option rule. required: - operator - attribute @@ -165,6 +150,7 @@ post: properties: operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -177,20 +163,25 @@ post: attribute: type: string title: attribute - description: The rule's attribute. + description: >- + The name of a property or table that the rule applies + to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: object - description: The rule's rules. + description: Update the properties of an existing rule. required: - id - operator @@ -203,6 +194,7 @@ post: description: The rule's ID. operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -215,18 +207,23 @@ post: attribute: type: string title: attribute - description: The rule's attribute. + description: >- + The name of a property or table that the rule applies + to. + example: customer_group value: oneOf: - type: string title: value - description: The rule's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The rule's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 x-codeSamples: - lang: Shell label: cURL 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 93babcb092..c1ac56daf2 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 @@ -1,7 +1,8 @@ post: operationId: PostShippingOptionsIdRulesBatch - summary: Add Rules to Shipping Option - description: Add a list of rules to a shipping option. + summary: Manage the Rules of a Shipping Option + x-sidebar-summary: Manage Rules + description: Manage the rules of a shipping option to create, update, or delete them. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,14 +46,14 @@ post: application/json: schema: type: object - description: SUMMARY + description: The rules to create, update, or delete. properties: create: type: array - description: The shipping option's create. + description: The shipping option rules to create. items: type: object - description: The create's details. + description: A shipping option's details. required: - operator - attribute @@ -89,6 +61,7 @@ post: properties: operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -101,24 +74,27 @@ post: attribute: type: string title: attribute - description: The create's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The create's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The create's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 update: type: array - description: The shipping option's update. + description: The shipping option rules to update. items: type: object - description: The update's details. + description: The properties to update in the shipping option rule. required: - id - operator @@ -128,9 +104,10 @@ post: id: type: string title: id - description: The update's ID. + description: The rule's ID. operator: type: string + description: The operator used to check whether a rule applies. enum: - in - eq @@ -143,25 +120,28 @@ post: attribute: type: string title: attribute - description: The update's attribute. + description: The name of a property or table that the rule applies to. + example: customer_group value: oneOf: - type: string title: value - description: The update's value. + description: A value of the attribute that enables this rule. + example: cusgroup_123 - type: array - description: The update's value. + description: Values of the attribute that enable this rule. items: type: string title: value - description: The value's details. + description: A value of the attribute that enables this rule. + example: cusgroup_123 delete: type: array - description: The shipping option's delete. + description: The shipping option rules to delete. items: type: string title: delete - description: The delete's details. + description: A rule's ID. x-codeSamples: - lang: Shell label: cURL @@ -176,7 +156,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The batch operation's result. required: - created - updated @@ -184,17 +164,17 @@ post: properties: created: type: array - description: The shipping option's created. + description: The created shipping option rules. items: $ref: ../components/schemas/AdminShippingOptionRule.yaml updated: type: array - description: The shipping option's updated. + description: The updated shipping option rules. items: $ref: ../components/schemas/AdminShippingOptionRule.yaml deleted: type: object - description: The shipping option's deleted. + description: The details of the deleted shipping option rules. required: - ids - object @@ -202,15 +182,16 @@ post: properties: ids: type: array - description: The deleted's ids. + description: The IDs of the deleted shipping option rules. items: type: string title: ids - description: The id's ids. + description: A shipping option rule's ID. object: type: string title: object - description: The deleted's object. + description: The name of the deleted object. + default: shipping_option_rule deleted: type: boolean title: deleted 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 659cbeaa1b..60c63fd4ac 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 @@ -632,35 +632,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 a35d68aa76..27c24877e5 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_shipping-profiles_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -173,9 +115,7 @@ post: application/json: schema: type: object - description: SUMMARY - required: - - metadata + description: The properties to update in the shipping profile. properties: name: type: string 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 b997c8b759..395387e451 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 @@ -628,35 +628,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3a9e84bdbf..fd6be91a01 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stock-locations_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 c211910651..7f2ca773f3 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 @@ -1,7 +1,10 @@ post: operationId: PostStockLocationsIdFulfillmentProviders - summary: Add Fulfillment Providers to Stock Location - description: Add a list of fulfillment providers to a stock location. + summary: Manage Fulfillment Providers of a Stock Location + x-sidebar-summary: Manage Fulfillment Providers + description: >- + Manage the fulfillment providers to add or remove them from a stock + location. x-authenticated: true parameters: - name: id @@ -36,35 +39,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +48,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The fulfillment providers to add or remove from the stock location. properties: add: type: array - description: The stock location's add. + description: The fulfillment providers to add to the stock location. items: type: string title: add - description: The add's details. + description: A fulfillment provider's ID. remove: type: array - description: The stock location's remove. + description: The fulfillment providers to remove from the stock location. items: type: string title: remove - description: The remove's details. + description: A fulfillment provider's ID. x-codeSamples: - lang: Shell label: cURL 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 6d641eab67..06f52381f2 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 @@ -1,7 +1,8 @@ post: operationId: PostStockLocationsIdFulfillmentSets - summary: Add Fulfillment Sets to Stock Location - description: Add a list of fulfillment sets to a stock location. + summary: Add Fulfillment Set to Stock Location + x-sidebar-summary: Add Fulfillment Set + description: Create and add a fulfillment set to a stock location. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,7 +46,7 @@ post: application/json: schema: type: object - description: SUMMARY + description: The fulfillment set to create. required: - name - type @@ -82,11 +54,11 @@ post: name: type: string title: name - description: The stock location's name. + description: The fulfillment set's name. type: type: string title: type - description: The stock location's type. + description: The fulfillment set's type. x-codeSamples: - lang: Shell label: cURL 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 4c61790593..4214bee893 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 @@ -1,7 +1,8 @@ post: operationId: PostStockLocationsIdSalesChannels - summary: Add Sales Channels to Stock Location - description: Add a list of sales channels to a stock location. + summary: Manage Sales Channels of a Stock Location + x-sidebar-summary: Manage Sales Channels + description: Manage the sales channels in a stock location by adding or removing them. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -74,22 +46,22 @@ post: application/json: schema: type: object - description: SUMMARY + description: The sales channels to add or remove. properties: add: type: array - description: The stock location's add. + description: The sales channels to add. items: type: string title: add - description: The add's details. + description: A sales channel's ID. remove: type: array - description: The stock location's remove. + description: The sales channels to remove. items: type: string title: remove - description: The remove's details. + description: A sales channel's ID. x-codeSamples: - lang: Shell label: cURL 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 65dff755c7..bde1e1c649 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_stores_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 1b57b45b87..ba36270fe5 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 @@ -725,35 +725,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 62495a4a61..fbbeb5fc98 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] @@ -135,35 +106,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 c7ac809c8c..08492f371a 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 @@ -1,7 +1,8 @@ post: operationId: PostTaxRatesIdRules - summary: Add Rules to Tax Rate - description: Add a list of rules to a tax rate. + summary: Create Tax Rule for a Rate + x-sidebar-summary: Create Tax Rule + description: Create a tax rule for a rate. x-authenticated: true parameters: - name: id @@ -36,35 +37,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 2b52812692..e9f6ac95a0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-rates_{id}_rules_{rule_id}.yaml @@ -43,35 +43,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 dc3bc61ff0..5cd91fe59e 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 @@ -326,9 +326,9 @@ get: oneOf: - type: string title: created_at - description: The tax region's created at. + description: Filter by a tax region's creation date. - type: object - description: The tax region's created at. + description: Apply filters on the tax region's creation date. properties: $and: type: array @@ -631,9 +631,9 @@ get: oneOf: - type: string title: updated_at - description: The tax region's updated at. + description: Filter by a tax region's update date. - type: object - description: The tax region's updated at. + description: Apply filters on the tax region's update date. properties: $and: type: array @@ -936,9 +936,9 @@ get: oneOf: - type: string title: deleted_at - description: The tax region's deleted at. + description: Filter by a tax region's deletion date. - type: object - description: The tax region's deleted at. + description: Apply filters on the tax region's deletion date. properties: $and: type: array @@ -1348,35 +1348,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 704706ae66..4665375a12 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_tax-regions_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml index f64a477959..5b95840d16 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml @@ -1,9 +1,8 @@ post: operationId: PostUploads - summary: Create Upload - description: Create a upload. + summary: Upload Files + description: Upload files to the configured File Module Provider. x-authenticated: true - parameters: [] security: - api_token: [] - cookie_auth: [] @@ -14,17 +13,17 @@ post: schema: oneOf: - type: object - description: SUMMARY + description: The files to upload. required: - files properties: files: type: array - description: The upload's files. + description: The files to upload. items: oneOf: - type: object - description: The file's files. + description: A file's details. required: - name - content @@ -36,10 +35,10 @@ post: content: type: string title: content - description: The file's content. + description: The file's base64 content. - $ref: ../components/schemas/File.yaml - $ref: ../components/schemas/FileList.yaml - description: SUMMARY + description: The files to upload. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml index dde1664ffc..da16d8793f 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_uploads_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] 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 3afc2c6905..961feeb3b0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_me.yaml @@ -30,35 +30,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml index 2ff9af9bd6..b51d726fe0 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_users_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL @@ -131,35 +102,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: 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 bc9e2f3427..8b152cec49 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml index 70e502e797..a95e0cc9ba 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_run.yaml @@ -1,12 +1,12 @@ post: operationId: PostWorkflowsExecutionsWorkflow_idRun - summary: Add Runs to Workflows Execution - description: Add a list of runs to a workflows execution. + summary: Execute a Workflow + description: Execute a workflow by its ID. x-authenticated: true parameters: - name: workflow_id in: path - description: The workflows execution's workflow id. + description: The workflow's ID. required: true schema: type: string @@ -34,11 +34,28 @@ post: application/json: schema: type: object - description: SUMMARY + description: The execution's details. required: - acknowledgement properties: - acknowledgement: {} + acknowledgement: + type: object + description: The workflow's details + required: + - workflowId + - transactionId + properties: + workflowId: + type: string + description: The ID of the executed workflow. + title: workflowId + transactionId: + type: string + description: >- + The ID of the workflow exection's transaction. Use this + later to track the workflow execution's progress or + succeed / fail its steps. + title: transactionId '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml index 4f6dbdb548..fb9a2e3ee8 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_failure.yaml @@ -1,7 +1,10 @@ post: operationId: PostWorkflowsExecutionsWorkflow_idStepsFailure - summary: Add Failures to Workflows Execution - description: Add a list of failures to a workflows execution. + summary: Fail a Step in a Workflow's Execution + x-sidebar-summary: Fail a Step + description: >- + Set the status of a step in a workflow's execution as failed. This is useful + for long-running workflows. x-authenticated: true parameters: - name: workflow_id @@ -34,14 +37,14 @@ post: application/json: schema: type: object - description: SUMMARY + description: The details of failing the workflow step. required: - success properties: success: type: boolean title: success - description: The workflows execution's success. + description: Whether the workflow step has failed successfully. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml index d310282506..8b7b768e62 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_steps_success.yaml @@ -1,7 +1,10 @@ post: operationId: PostWorkflowsExecutionsWorkflow_idStepsSuccess - summary: Add Successes to Workflows Execution - description: Add a list of successes to a workflows execution. + summary: Succeed a Step in a Workflow's Execution + x-sidebar-summary: Succed a Step + description: >- + Set the status of a step in a workflow's execution as successful. This is + useful for long-running workflows. x-authenticated: true parameters: - name: workflow_id @@ -34,14 +37,14 @@ post: application/json: schema: type: object - description: SUMMARY + description: The details of succeeding the workflow step. required: - success properties: success: type: boolean title: success - description: The workflows execution's success. + description: Whether the workflow step was succeeded. '400': $ref: ../components/responses/400_error.yaml '401': diff --git a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml index 5f6d620e7d..af9c014b68 100644 --- a/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml +++ b/www/apps/api-reference/specs/admin/paths/admin_workflows-executions_{workflow_id}_{transaction_id}.yaml @@ -43,35 +43,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - api_token: [] - cookie_auth: [] diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml index 2a9161c132..cb4739e001 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCollection.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateCollection required: - title - - metadata properties: title: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml index 411237b91f..bd8d34314b 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateCustomerGroup.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminCreateCustomerGroup required: - name - - metadata properties: name: type: string 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 7d1debb06d..8a6e547262 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateFulfillment.yaml @@ -9,12 +9,7 @@ required: - labels - order - order_id - - shipping_option_id - data - - packed_at - - shipped_at - - delivered_at - - canceled_at - metadata properties: location_id: @@ -28,18 +23,6 @@ properties: delivery_address: type: object description: The fulfillment's delivery address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata properties: first_name: type: string @@ -95,8 +78,6 @@ properties: - sku - quantity - barcode - - line_item_id - - inventory_item_id properties: title: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml index a8e62f3999..f360a50004 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreatePriceList.yaml @@ -4,8 +4,6 @@ x-schemaName: AdminCreatePriceList required: - title - description - - starts_at - - ends_at properties: title: type: string @@ -48,8 +46,6 @@ properties: - currency_code - amount - variant_id - - min_quantity - - max_quantity properties: currency_code: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml index 221e02bf81..94a4933a1e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminCreateShippingProfile.yaml @@ -1,5 +1,6 @@ type: object description: SUMMARY +x-schemaName: AdminCreateShippingProfile required: - name - type @@ -15,4 +16,3 @@ properties: metadata: type: object description: The shipping profile's metadata. -x-schemaName: AdminCreateShippingProfile diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminLinkPriceListProducts.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminLinkPriceListProducts.yaml new file mode 100644 index 0000000000..5e8a008bc4 --- /dev/null +++ b/www/apps/api-reference/specs/store/components/schemas/AdminLinkPriceListProducts.yaml @@ -0,0 +1,11 @@ +type: object +description: The removal details. +properties: + remove: + type: array + description: The products to remove from the price list. + items: + type: string + title: remove + description: The ID of a product. +x-schemaName: AdminLinkPriceListProducts 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 c2149ed29a..b031d34d77 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminOrderPreview.yaml @@ -5,8 +5,8 @@ required: - return_requested_total - order_change - currency_code - - id - version + - id - region_id - customer_id - sales_channel_id @@ -465,14 +465,14 @@ properties: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml index b3b1589daa..6ab38aa512 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsItemsActionReqSchema.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema -required: - - reason_id properties: quantity: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml index f7c3f3c219..3741c54e3d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostClaimsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml index ba1745276f..395e129bdd 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostClaimsShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The claim's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml index c473ba6e3a..68fc3d9b3e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostExchangesShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml index 6af8ce407a..aee62b6a99 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostExchangesShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml index 0a3dcc4f9c..9daa00cb61 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderClaimsReqSchema.yaml @@ -4,8 +4,6 @@ x-schemaName: AdminPostOrderClaimsReqSchema required: - type - order_id - - reason_id - - metadata properties: type: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml index 592ffc30b3..c6946ef6fe 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsReqSchema.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminPostOrderEditsReqSchema required: - order_id - - metadata properties: order_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml index ce424d8297..2e36a37f64 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml index 91e223dc84..cd81378dd5 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderEditsShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The order edit's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml index 60f49ba39f..05e3ed3e54 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostOrderExchangesReqSchema.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id - - metadata properties: order_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml index 5369559d9e..ea798aa3c3 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReceiveReturnsReqSchema.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminPostReceiveReturnsReqSchema -required: - - metadata properties: internal_note: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml index 8d64cb70c0..68be6f5dcc 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReqSchema.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: AdminPostReturnsReqSchema required: - order_id - - metadata properties: order_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml index e752425d9b..3d5c38d44d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsReturnReqSchema.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminPostReturnsReturnReqSchema -required: - - metadata properties: location_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml index 7b46e91e55..5cd4a15e19 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingActionReqSchema.yaml @@ -2,10 +2,10 @@ type: object description: SUMMARY x-schemaName: AdminPostReturnsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The return's custom price. + title: custom_amount + description: The return's custom amount. internal_note: type: string title: internal_note diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml index 48a850a29f..9cd63a9d16 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminPostReturnsShippingReqSchema.yaml @@ -8,10 +8,10 @@ properties: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml index 73384be760..8e82d12e9d 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminProductVariant.yaml @@ -61,6 +61,10 @@ properties: type: boolean title: manage_inventory description: The parent's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The parent's inventory quantity. hs_code: type: string title: hs_code diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml index a1a589243a..22a9be4f57 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCollection.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateCollection -required: - - metadata properties: title: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml index 71ce5dbe47..acb0253445 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateCustomerGroup.yaml @@ -1,8 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateCustomerGroup -required: - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml index 464f157c82..97688d7c5f 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdatePriceList.yaml @@ -1,10 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdatePriceList -required: - - description - - starts_at - - ends_at properties: title: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml index fb9b87db05..8f30103306 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateSalesChannel.yaml @@ -1,9 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateSalesChannel -required: - - description - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml index 79f40f4276..2312fd5e3c 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStockLocation.yaml @@ -1,9 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateStockLocation -required: - - address_id - - metadata properties: name: type: string @@ -14,13 +11,7 @@ properties: description: The stock location's address. required: - address_1 - - address_2 - - company - - city - country_code - - phone - - postal_code - - province properties: address_1: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml index 263b8caac1..7df88b6bc0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateStore.yaml @@ -1,11 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateStore -required: - - default_sales_channel_id - - default_region_id - - default_location_id - - metadata properties: name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml index 791c465256..5580cc1ef6 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateTaxRate.yaml @@ -1,9 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateTaxRate -required: - - code - - metadata properties: rate: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml index 781812e182..1d1bd54d5a 100644 --- a/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/AdminUpdateUser.yaml @@ -1,10 +1,6 @@ type: object description: SUMMARY x-schemaName: AdminUpdateUser -required: - - first_name - - last_name - - avatar_url properties: first_name: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml index b51f369920..56edabcde0 100644 --- a/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/OrderPreview.yaml @@ -5,8 +5,8 @@ required: - order_change - status - currency_code - - id - version + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -671,14 +671,14 @@ properties: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id @@ -724,6 +724,8 @@ properties: - balance - paid_total - refunded_total + - pending_difference + - raw_pending_difference properties: total: oneOf: @@ -935,6 +937,23 @@ properties: - type: object description: The summary's refunded total. x-schemaName: IBigNumber + pending_difference: + oneOf: + - type: string + title: pending_difference + description: The summary's pending difference. + - type: number + title: pending_difference + description: The summary's pending difference. + - type: string + title: pending_difference + description: The summary's pending difference. + - type: object + description: The summary's pending difference. + x-schemaName: IBigNumber + raw_pending_difference: + type: object + description: The summary's raw pending difference. metadata: type: object description: The order preview's metadata. diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml index abf0714b02..c791cbd824 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreAddCartLineItem.yaml @@ -4,7 +4,6 @@ x-schemaName: StoreAddCartLineItem required: - variant_id - quantity - - metadata properties: variant_id: type: string diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml index e7c6862965..a6468aab56 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCartLineItem.yaml @@ -3,7 +3,6 @@ description: SUMMARY x-schemaName: StoreUpdateCartLineItem required: - quantity - - metadata properties: quantity: type: number diff --git a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml index f9c3b19ebb..f3f14b1f5e 100644 --- a/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml +++ b/www/apps/api-reference/specs/store/components/schemas/StoreUpdateCustomer.yaml @@ -1,11 +1,6 @@ type: object description: SUMMARY x-schemaName: StoreUpdateCustomer -required: - - company_name - - first_name - - last_name - - phone properties: company_name: type: string diff --git a/www/apps/api-reference/specs/store/openapi.full.yaml b/www/apps/api-reference/specs/store/openapi.full.yaml index 9df62f3a88..bfe4e73beb 100644 --- a/www/apps/api-reference/specs/store/openapi.full.yaml +++ b/www/apps/api-reference/specs/store/openapi.full.yaml @@ -361,30 +361,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -453,30 +429,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -530,30 +482,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -628,30 +556,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -763,30 +667,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -860,30 +740,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -955,30 +811,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -1059,30 +891,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -1160,30 +968,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -1245,30 +1029,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -1345,30 +1105,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -2279,30 +2015,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -2471,30 +2183,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -2543,30 +2231,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -2630,30 +2294,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -2706,30 +2346,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -2820,117 +2436,59 @@ paths: type: string title: order description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - name: metadata - in: query - description: The customer's metadata. - required: true - schema: - type: object - description: The customer's metadata. - - name: first_name - in: query - description: The customer's first name. - required: true - schema: - type: string - title: first_name - description: The customer's first name. - - name: last_name - in: query - description: The customer's last name. - required: true - schema: - type: string - title: last_name - description: The customer's last name. - - name: phone - in: query - description: The customer's phone. - required: true - schema: - type: string - title: phone - description: The customer's phone. - - name: company - in: query - description: The customer's company. - required: true - schema: - type: string - title: company - description: The customer's company. - - name: address_1 - in: query - description: The customer's address 1. - required: true - schema: - type: string - title: address_1 - description: The customer's address 1. - - name: address_2 - in: query - description: The customer's address 2. - required: true - schema: - type: string - title: address_2 - description: The customer's address 2. - name: city in: query description: The customer's city. - required: true + required: false schema: - type: string - title: city - description: The customer's city. + oneOf: + - type: string + title: city + description: The customer's city. + - type: array + description: The customer's city. + items: + type: string + title: city + description: The city's details. - name: country_code in: query description: The customer's country code. - required: true + required: false schema: - type: string - title: country_code - description: The customer's country code. - - name: province - in: query - description: The customer's province. - required: true - schema: - type: string - title: province - description: The customer's province. + oneOf: + - type: string + title: country_code + description: The customer's country code. + - type: array + description: The customer's country code. + items: + type: string + title: country_code + description: The country code's details. - name: postal_code in: query description: The customer's postal code. - required: true - schema: - type: string - title: postal_code - description: The customer's postal code. - - name: address_name - in: query - description: The customer's address name. - required: true - schema: - type: string - title: address_name - description: The customer's address name. - - name: is_default_shipping - in: query - description: The customer's is default shipping. required: false schema: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - - name: is_default_billing + oneOf: + - type: string + title: postal_code + description: The customer's postal code. + - type: array + description: The customer's postal code. + items: + type: string + title: postal_code + description: The postal code's details. + - name: q in: query - description: The customer's is default billing. + description: The customer's q. required: false schema: - type: boolean - title: is_default_billing - description: The customer's is default billing. + type: string + title: q + description: The customer's q. security: - cookie_auth: [] - jwt_token: [] @@ -2983,30 +2541,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -3016,19 +2550,6 @@ paths: schema: type: object description: SUMMARY - required: - - metadata - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - address_name properties: metadata: type: object @@ -3157,30 +2678,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -3239,30 +2736,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -3272,19 +2745,6 @@ paths: schema: type: object description: SUMMARY - required: - - metadata - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - address_name properties: metadata: type: object @@ -3412,30 +2872,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -3497,7 +2933,7 @@ paths: operationId: GetOrders summary: List Orders 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: false + x-authenticated: true parameters: - name: expand in: query @@ -3553,20 +2989,6 @@ paths: type: string title: id description: The id's ID. - - name: name - in: query - required: false - schema: - oneOf: - - type: string - title: name - description: The order's name. - - type: array - description: The order's name. - items: - type: string - title: name - description: The name's details. - name: $and in: query required: false @@ -3585,6 +3007,41 @@ paths: items: type: object title: $or + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: array + description: The order's status. + items: + type: string + description: The status's details. + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived x-codeSamples: - lang: Shell label: cURL @@ -3639,6 +3096,9 @@ paths: $ref: '#/components/responses/invalid_request_error' '500': $ref: '#/components/responses/500_error' + security: + - cookie_auth: [] + - jwt_token: [] /store/orders/{id}: get: operationId: GetOrdersId @@ -3668,76 +3128,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - 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: $and - in: query - required: false - schema: - type: array - description: The order's $and. - items: - type: object - title: $and - - name: $or - in: query - required: false - schema: - type: array - description: The order's $or. - items: - type: object - title: $or x-codeSamples: - lang: Shell label: cURL @@ -3786,30 +3176,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -3878,30 +3244,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. requestBody: content: application/json: @@ -4002,58 +3344,11 @@ paths: - name: region_id in: query description: The payment provider's region id. - required: false + required: true schema: - oneOf: - - type: string - title: region_id - description: The payment provider's region id. - - type: array - description: The payment provider's region id. - items: - type: string - title: region_id - description: The region id's details. - - name: id - in: query - required: false - schema: - oneOf: - - type: string - title: id - description: The payment provider's ID. - - type: array - description: The payment provider's ID. - items: - type: string - title: id - description: The id's ID. - - name: is_enabled - in: query - description: The payment provider's is enabled. - required: false - schema: - type: boolean - title: is_enabled - description: The payment provider's is enabled. - - name: $and - in: query - required: false - schema: - type: array - description: The payment provider's $and. - items: - type: object - title: $and - - name: $or - in: query - required: false - schema: - type: array - description: The payment provider's $or. - items: - type: object - title: $or + type: string + title: region_id + description: The payment provider's region id. x-codeSamples: - lang: Shell label: cURL @@ -4960,22 +4255,6 @@ paths: type: string title: name description: The name's details. - - name: is_active - in: query - description: The product category's is active. - required: false - schema: - type: boolean - title: is_active - description: The product category's is active. - - name: is_internal - in: query - description: The product category's is internal. - required: false - schema: - type: boolean - title: is_internal - description: The product category's is internal. x-codeSamples: - lang: Shell label: cURL @@ -5030,30 +4309,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: include_ancestors_tree in: query description: The product category's include ancestors tree. @@ -5232,21 +4487,6 @@ paths: type: string title: collection_id description: The collection id's details. - - name: tags - in: query - description: The product's tags. - required: false - schema: - oneOf: - - type: string - title: tags - description: The product's tags. - - type: array - description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. - name: type_id in: query description: The product's type id. @@ -5923,397 +5163,6 @@ paths: type: boolean title: $exists description: The deleted at's $exists. - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: array - description: The product's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - - name: categories - in: query - required: false - schema: - oneOf: - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The id's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The id's $eq. - - type: object - description: The id's $eq. - x-schemaName: RegExp - - type: array - description: The id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The id's $ne. - - type: object - description: The id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The id's $not. - - type: object - description: The id's $not. - x-schemaName: RegExp - - type: object - description: The id's $not. - - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The id's $gt. - - type: object - description: The id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The id's $gte. - - type: object - description: The id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The id's $lt. - - type: object - description: The id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The id's $lte. - - type: object - description: The id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - type: array - description: The $and's details. - items: - type: array - description: The $and's details. - items: - type: object - title: $and - $or: - type: array - description: The id's $or. - items: - type: array - description: The $or's details. - items: - type: array - description: The $or's details. - items: - type: object - title: $or - $eq: - oneOf: - - type: array - description: The id's $eq. - items: - type: string - title: $eq - description: The $eq's details. - - type: array - description: The id's $eq. - items: - type: array - description: The $eq's details. - items: - type: string - title: $eq - description: The $eq's details. - $ne: - type: array - description: The id's $ne. - items: - type: string - title: $ne - description: The $ne's details. - $in: - type: array - description: The id's $in. - items: - type: array - description: The $in's details. - items: - type: string - title: $in - description: The $in's details. - $nin: - type: array - description: The id's $nin. - items: - type: array - description: The $nin's details. - items: - type: string - title: $nin - description: The $nin's details. - $not: - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - $gt: - type: array - description: The id's $gt. - items: - type: string - title: $gt - description: The $gt's details. - $gte: - type: array - description: The id's $gte. - items: - type: string - title: $gte - description: The $gte's details. - $lt: - type: array - description: The id's $lt. - items: - type: string - title: $lt - description: The $lt's details. - $lte: - type: array - description: The id's $lte. - items: - type: string - title: $lte - description: The $lte's details. - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. - name: region_id in: query description: The product's region id. @@ -6366,6 +5215,20 @@ paths: type: string title: category_id description: The category id's details. + - name: tag_id + in: query + required: false + schema: + oneOf: + - type: string + title: tag_id + description: The product's tag id. + - type: array + description: The product's tag id. + items: + type: string + title: tag_id + description: The tag id's details. x-codeSamples: - lang: Shell label: cURL @@ -6449,30 +5312,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - name: region_id in: query description: The product's region id. @@ -7022,482 +5861,6 @@ paths: type: string title: name description: The name's details. - - name: code - in: query - required: false - schema: - oneOf: - - type: string - title: code - description: The region's code. - - type: array - description: The region's code. - items: - type: string - title: code - description: The code's details. - - name: created_at - in: query - description: The region's created at. - required: false - schema: - type: object - description: The region's created at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - name: updated_at - in: query - description: The region's updated at. - required: false - schema: - type: object - description: The region's updated at. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - properties: - $and: - type: array - description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - - type: object - description: Filter by values not matching the conditions in this parameter. - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - type: array - description: Filter by values not matching the conditions in this parameter. - items: - type: string - title: $not - description: Filter by values not matching the conditions in this parameter. - $gt: - type: string - title: $gt - description: Filter by values greater than this parameter. Useful for numbers and dates only. - $gte: - type: string - title: $gte - description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: Filter by values less than this parameter. Useful for numbers and dates only. - $lte: - type: string - title: $lte - description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -7518,6 +5881,20 @@ paths: items: type: object title: $or + - name: currency_code + in: query + required: false + schema: + oneOf: + - type: string + title: currency_code + description: The region's currency code. + - type: array + description: The region's currency code. + items: + type: string + title: currency_code + description: The currency code's details. x-codeSamples: - lang: Shell label: cURL @@ -7601,30 +5978,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -7662,7 +6015,6 @@ paths: summary: Create Return description: Create a return. x-authenticated: false - parameters: [] requestBody: content: application/json: @@ -7843,30 +6195,6 @@ paths: type: string title: fields description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. x-codeSamples: - lang: Shell label: cURL @@ -7899,14 +6227,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: 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. @@ -8894,7 +7214,6 @@ components: x-schemaName: AdminCreateCollection required: - title - - metadata properties: title: type: string @@ -8913,7 +7232,6 @@ components: x-schemaName: AdminCreateCustomerGroup required: - name - - metadata properties: name: type: string @@ -8934,12 +7252,7 @@ components: - labels - order - order_id - - shipping_option_id - data - - packed_at - - shipped_at - - delivered_at - - canceled_at - metadata properties: location_id: @@ -8953,18 +7266,6 @@ components: delivery_address: type: object description: The fulfillment's delivery address. - required: - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - metadata properties: first_name: type: string @@ -9020,8 +7321,6 @@ components: - sku - quantity - barcode - - line_item_id - - inventory_item_id properties: title: type: string @@ -9174,8 +7473,6 @@ components: required: - title - description - - starts_at - - ends_at properties: title: type: string @@ -9218,8 +7515,6 @@ components: - currency_code - amount - variant_id - - min_quantity - - max_quantity properties: currency_code: type: string @@ -9888,6 +8183,7 @@ components: AdminCreateShippingProfile: type: object description: SUMMARY + x-schemaName: AdminCreateShippingProfile required: - name - type @@ -9903,7 +8199,6 @@ components: metadata: type: object description: The shipping profile's metadata. - x-schemaName: AdminCreateShippingProfile AdminCreateStockLocation: type: object description: SUMMARY @@ -11964,6 +10259,18 @@ components: properties: invite: $ref: '#/components/schemas/AdminInvite' + AdminLinkPriceListProducts: + type: object + description: The removal details. + properties: + remove: + type: array + description: The products to remove from the price list. + items: + type: string + title: remove + description: The ID of a product. + x-schemaName: AdminLinkPriceListProducts AdminNotification: type: object description: The notification's details. @@ -12414,8 +10721,8 @@ components: - return_requested_total - order_change - currency_code - - id - version + - id - region_id - customer_id - sales_channel_id @@ -12874,14 +11181,14 @@ components: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id @@ -13460,8 +11767,6 @@ components: type: object description: SUMMARY x-schemaName: AdminPostClaimsItemsActionReqSchema - required: - - reason_id properties: quantity: type: number @@ -13480,10 +11785,10 @@ components: description: SUMMARY x-schemaName: AdminPostClaimsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. internal_note: type: string title: internal_note @@ -13502,10 +11807,10 @@ components: type: string title: shipping_option_id description: The claim's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The claim's custom price. + title: custom_amount + description: The claim's custom amount. description: type: string title: description @@ -13631,10 +11936,10 @@ components: description: SUMMARY x-schemaName: AdminPostExchangesShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. internal_note: type: string title: internal_note @@ -13653,10 +11958,10 @@ components: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description @@ -13675,8 +11980,6 @@ components: required: - type - order_id - - reason_id - - metadata properties: type: type: string @@ -13760,7 +12063,6 @@ components: x-schemaName: AdminPostOrderEditsReqSchema required: - order_id - - metadata properties: order_id: type: string @@ -13782,10 +12084,10 @@ components: description: SUMMARY x-schemaName: AdminPostOrderEditsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. internal_note: type: string title: internal_note @@ -13804,10 +12106,10 @@ components: type: string title: shipping_option_id description: The order edit's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The order edit's custom price. + title: custom_amount + description: The order edit's custom amount. description: type: string title: description @@ -13840,7 +12142,6 @@ components: x-schemaName: AdminPostOrderExchangesReqSchema required: - order_id - - metadata properties: order_id: type: string @@ -13861,8 +12162,6 @@ components: type: object description: SUMMARY x-schemaName: AdminPostReceiveReturnsReqSchema - required: - - metadata properties: internal_note: type: string @@ -13947,7 +12246,6 @@ components: x-schemaName: AdminPostReturnsReqSchema required: - order_id - - metadata properties: order_id: type: string @@ -14034,8 +12332,6 @@ components: type: object description: SUMMARY x-schemaName: AdminPostReturnsReturnReqSchema - required: - - metadata properties: location_id: type: string @@ -14053,10 +12349,10 @@ components: description: SUMMARY x-schemaName: AdminPostReturnsShippingActionReqSchema properties: - custom_price: + custom_amount: type: number - title: custom_price - description: The return's custom price. + title: custom_amount + description: The return's custom amount. internal_note: type: string title: internal_note @@ -14075,10 +12371,10 @@ components: type: string title: shipping_option_id description: The exchange's shipping option id. - custom_price: + custom_amount: type: number - title: custom_price - description: The exchange's custom price. + title: custom_amount + description: The exchange's custom amount. description: type: string title: description @@ -15167,6 +13463,10 @@ components: type: boolean title: manage_inventory description: The parent's manage inventory. + inventory_quantity: + type: number + title: inventory_quantity + description: The parent's inventory quantity. hs_code: type: string title: hs_code @@ -17522,8 +15822,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateCollection - required: - - metadata properties: title: type: string @@ -17540,8 +15838,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateCustomerGroup - required: - - metadata properties: name: type: string @@ -17554,10 +15850,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdatePriceList - required: - - description - - starts_at - - ends_at properties: title: type: string @@ -18014,9 +16306,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateSalesChannel - required: - - description - - metadata properties: name: type: string @@ -18037,9 +16326,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateStockLocation - required: - - address_id - - metadata properties: name: type: string @@ -18050,13 +16336,7 @@ components: description: The stock location's address. required: - address_1 - - address_2 - - company - - city - country_code - - phone - - postal_code - - province properties: address_1: type: string @@ -18101,11 +16381,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateStore - required: - - default_sales_channel_id - - default_region_id - - default_location_id - - metadata properties: name: type: string @@ -18151,9 +16426,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateTaxRate - required: - - code - - metadata properties: rate: type: number @@ -18200,10 +16472,6 @@ components: type: object description: SUMMARY x-schemaName: AdminUpdateUser - required: - - first_name - - last_name - - avatar_url properties: first_name: type: string @@ -21839,8 +20107,8 @@ components: - order_change - status - currency_code - - id - version + - id - original_item_total - original_item_subtotal - original_item_tax_total @@ -22505,14 +20773,14 @@ components: type: string title: currency_code description: The order preview's currency code. - id: - type: string - title: id - description: The order preview's ID. version: type: number title: version description: The order preview's version. + id: + type: string + title: id + description: The order preview's ID. region_id: type: string title: region_id @@ -22558,6 +20826,8 @@ components: - balance - paid_total - refunded_total + - pending_difference + - raw_pending_difference properties: total: oneOf: @@ -22769,6 +21039,23 @@ components: - type: object description: The summary's refunded total. x-schemaName: IBigNumber + pending_difference: + oneOf: + - type: string + title: pending_difference + description: The summary's pending difference. + - type: number + title: pending_difference + description: The summary's pending difference. + - type: string + title: pending_difference + description: The summary's pending difference. + - type: object + description: The summary's pending difference. + x-schemaName: IBigNumber + raw_pending_difference: + type: object + description: The summary's raw pending difference. metadata: type: object description: The order preview's metadata. @@ -23525,7 +21812,6 @@ components: required: - variant_id - quantity - - metadata properties: variant_id: type: string @@ -25789,7 +24075,6 @@ components: x-schemaName: StoreUpdateCartLineItem required: - quantity - - metadata properties: quantity: type: number @@ -25802,11 +24087,6 @@ components: type: object description: SUMMARY x-schemaName: StoreUpdateCustomer - required: - - company_name - - first_name - - last_name - - phone properties: company_name: type: string 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 a4dbbbda69..d1306fa3b4 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts.yaml @@ -30,35 +30,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml index bf9d487c3e..f006842baf 100644 --- a/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_carts_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL @@ -131,35 +102,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_complete.yaml index 0833932a29..75d1035f22 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: 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 30046012ab..02d54dab32 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_line-items_{line_id}.yaml index efef7e35e1..f3fc8f8a2c 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 @@ -42,35 +42,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: @@ -149,35 +120,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_promotions.yaml index a0ecc71497..7dafacbc55 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: @@ -148,35 +119,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml b/www/apps/api-reference/specs/store/paths/store_carts_{id}_shipping-methods.yaml index bc30300e32..1d82a764af 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: 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 e74c1f27f7..304649c33d 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: 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 18e9ce07bb..4a93fa147a 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 @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL 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 049daacf71..a04e6a17ec 100644 --- a/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_currencies_{code}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_customers.yaml b/www/apps/api-reference/specs/store/paths/store_customers.yaml index e721bb12c2..1d4fed43cb 100644 --- a/www/apps/api-reference/specs/store/paths/store_customers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_customers.yaml @@ -30,35 +30,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: 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 4c03820c70..3df4d62e3d 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 @@ -32,35 +32,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -122,35 +93,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - cookie_auth: [] - jwt_token: [] diff --git a/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml b/www/apps/api-reference/specs/store/paths/store_customers_me_addresses.yaml index 3e5db28f3f..add9d9799a 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 @@ -61,117 +61,59 @@ get: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - - name: metadata - in: query - description: The customer's metadata. - required: true - schema: - type: object - description: The customer's metadata. - - name: first_name - in: query - description: The customer's first name. - required: true - schema: - type: string - title: first_name - description: The customer's first name. - - name: last_name - in: query - description: The customer's last name. - required: true - schema: - type: string - title: last_name - description: The customer's last name. - - name: phone - in: query - description: The customer's phone. - required: true - schema: - type: string - title: phone - description: The customer's phone. - - name: company - in: query - description: The customer's company. - required: true - schema: - type: string - title: company - description: The customer's company. - - name: address_1 - in: query - description: The customer's address 1. - required: true - schema: - type: string - title: address_1 - description: The customer's address 1. - - name: address_2 - in: query - description: The customer's address 2. - required: true - schema: - type: string - title: address_2 - description: The customer's address 2. - name: city in: query description: The customer's city. - required: true + required: false schema: - type: string - title: city - description: The customer's city. + oneOf: + - type: string + title: city + description: The customer's city. + - type: array + description: The customer's city. + items: + type: string + title: city + description: The city's details. - name: country_code in: query description: The customer's country code. - required: true + required: false schema: - type: string - title: country_code - description: The customer's country code. - - name: province - in: query - description: The customer's province. - required: true - schema: - type: string - title: province - description: The customer's province. + oneOf: + - type: string + title: country_code + description: The customer's country code. + - type: array + description: The customer's country code. + items: + type: string + title: country_code + description: The country code's details. - name: postal_code in: query description: The customer's postal code. - required: true - schema: - type: string - title: postal_code - description: The customer's postal code. - - name: address_name - in: query - description: The customer's address name. - required: true - schema: - type: string - title: address_name - description: The customer's address name. - - name: is_default_shipping - in: query - description: The customer's is default shipping. required: false schema: - type: boolean - title: is_default_shipping - description: The customer's is default shipping. - - name: is_default_billing + oneOf: + - type: string + title: postal_code + description: The customer's postal code. + - type: array + description: The customer's postal code. + items: + type: string + title: postal_code + description: The postal code's details. + - name: q in: query - description: The customer's is default billing. + description: The customer's q. required: false schema: - type: boolean - title: is_default_billing - description: The customer's is default billing. + type: string + title: q + description: The customer's q. security: - cookie_auth: [] - jwt_token: [] @@ -233,35 +175,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -271,19 +184,6 @@ post: schema: type: object description: SUMMARY - required: - - metadata - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - address_name properties: metadata: type: object 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 c489d8e710..3dc6c3f2d2 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 @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -134,35 +105,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - cookie_auth: [] - jwt_token: [] @@ -172,19 +114,6 @@ post: schema: type: object description: SUMMARY - required: - - metadata - - first_name - - last_name - - phone - - company - - address_1 - - address_2 - - city - - country_code - - province - - postal_code - - address_name properties: metadata: type: object @@ -309,35 +238,6 @@ delete: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. security: - cookie_auth: [] - jwt_token: [] diff --git a/www/apps/api-reference/specs/store/paths/store_orders.yaml b/www/apps/api-reference/specs/store/paths/store_orders.yaml index 5d501a7310..fc8c0c10ed 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders.yaml @@ -4,7 +4,7 @@ get: 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: false + x-authenticated: true parameters: - name: expand in: query @@ -75,20 +75,6 @@ get: type: string title: id description: The id's ID. - - name: name - in: query - required: false - schema: - oneOf: - - type: string - title: name - description: The order's name. - - type: array - description: The order's name. - items: - type: string - title: name - description: The name's details. - name: $and in: query required: false @@ -107,6 +93,41 @@ get: items: type: object title: $or + - name: status + in: query + required: false + schema: + oneOf: + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: string + title: status + description: The order's status. + - type: array + description: The order's status. + items: + type: string + description: The status's details. + enum: + - canceled + - requires_action + - pending + - completed + - draft + - archived x-codeSamples: - lang: Shell label: cURL @@ -162,3 +183,6 @@ get: $ref: ../components/responses/invalid_request_error.yaml '500': $ref: ../components/responses/500_error.yaml + security: + - cookie_auth: [] + - jwt_token: [] 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 d2bcb881df..d0a18d5198 100644 --- a/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_orders_{id}.yaml @@ -38,81 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - - 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: $and - in: query - required: false - schema: - type: array - description: The order's $and. - items: - type: object - title: $and - - name: $or - in: query - required: false - schema: - type: array - description: The order's $or. - items: - type: object - title: $or x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections.yaml index 52d20716f2..87300a047a 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 @@ -30,35 +30,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml b/www/apps/api-reference/specs/store/paths/store_payment-collections_{id}_payment-sessions.yaml index ad66307dff..2300507400 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 @@ -36,35 +36,6 @@ post: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml index 90325a58d8..6a1141a6e4 100644 --- a/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml +++ b/www/apps/api-reference/specs/store/paths/store_payment-providers.yaml @@ -65,58 +65,11 @@ get: - name: region_id in: query description: The payment provider's region id. - required: false + required: true schema: - oneOf: - - type: string - title: region_id - description: The payment provider's region id. - - type: array - description: The payment provider's region id. - items: - type: string - title: region_id - description: The region id's details. - - name: id - in: query - required: false - schema: - oneOf: - - type: string - title: id - description: The payment provider's ID. - - type: array - description: The payment provider's ID. - items: - type: string - title: id - description: The id's ID. - - name: is_enabled - in: query - description: The payment provider's is enabled. - required: false - schema: - type: boolean - title: is_enabled - description: The payment provider's is enabled. - - name: $and - in: query - required: false - schema: - type: array - description: The payment provider's $and. - items: - type: object - title: $and - - name: $or - in: query - required: false - schema: - type: array - description: The payment provider's $or. - items: - type: object - title: $or + type: string + title: region_id + description: The payment provider's region id. x-codeSamples: - lang: Shell label: cURL 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 ac4b1ac8a6..d63a3c4d48 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 @@ -1023,22 +1023,6 @@ get: type: string title: name description: The name's details. - - name: is_active - in: query - description: The product category's is active. - required: false - schema: - type: boolean - title: is_active - description: The product category's is active. - - name: is_internal - in: query - description: The product category's is internal. - required: false - schema: - type: boolean - title: is_internal - description: The product category's is internal. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_product-categories_{id}.yaml index a98362fe16..7bf3c74861 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 @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - name: include_ancestors_tree in: query description: The product category's include ancestors tree. 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 30e6a15c1e..4c2804c72f 100644 --- a/www/apps/api-reference/specs/store/paths/store_products.yaml +++ b/www/apps/api-reference/specs/store/paths/store_products.yaml @@ -151,21 +151,6 @@ get: type: string title: collection_id description: The collection id's details. - - name: tags - in: query - description: The product's tags. - required: false - schema: - oneOf: - - type: string - title: tags - description: The product's tags. - - type: array - description: The product's tags. - items: - type: string - title: tags - description: The tag's tags. - name: type_id in: query description: The product's type id. @@ -950,397 +935,6 @@ get: type: boolean title: $exists description: The deleted at's $exists. - - name: status - in: query - required: false - schema: - oneOf: - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: string - title: status - description: The product's status. - - type: array - description: The product's status. - items: - type: string - enum: - - draft - - proposed - - published - - rejected - - name: categories - in: query - required: false - schema: - oneOf: - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - - type: object - description: The $and's details. - - type: array - description: The $and's details. - items: - oneOf: - - type: array - description: The $and's details. - items: - type: object - title: $and - - type: object - description: The $and's details. - x-schemaName: RegExp - $or: - type: array - description: The id's $or. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - - type: object - description: The $or's details. - - type: array - description: The $or's details. - items: - oneOf: - - type: array - description: The $or's details. - items: - type: object - title: $or - - type: object - description: The $or's details. - x-schemaName: RegExp - $eq: - oneOf: - - type: string - title: $eq - description: The id's $eq. - - type: object - description: The id's $eq. - x-schemaName: RegExp - - type: array - description: The id's $eq. - items: - oneOf: - - type: string - title: $eq - description: The $eq's details. - - type: object - description: The $eq's details. - x-schemaName: RegExp - $ne: - oneOf: - - type: string - title: $ne - description: The id's $ne. - - type: object - description: The id's $ne. - x-schemaName: RegExp - $in: - type: array - description: The id's $in. - items: - oneOf: - - type: string - title: $in - description: The $in's details. - - type: object - description: The $in's details. - x-schemaName: RegExp - $nin: - type: array - description: The id's $nin. - items: - oneOf: - - type: string - title: $nin - description: The $nin's details. - - type: object - description: The $nin's details. - x-schemaName: RegExp - $not: - oneOf: - - type: string - title: $not - description: The id's $not. - - type: object - description: The id's $not. - x-schemaName: RegExp - - type: object - description: The id's $not. - - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - x-schemaName: RegExp - $gt: - oneOf: - - type: string - title: $gt - description: The id's $gt. - - type: object - description: The id's $gt. - x-schemaName: RegExp - $gte: - oneOf: - - type: string - title: $gte - description: The id's $gte. - - type: object - description: The id's $gte. - x-schemaName: RegExp - $lt: - oneOf: - - type: string - title: $lt - description: The id's $lt. - - type: object - description: The id's $lt. - x-schemaName: RegExp - $lte: - oneOf: - - type: string - title: $lte - description: The id's $lte. - - type: object - description: The id's $lte. - x-schemaName: RegExp - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. - - type: object - description: The product's categories. - required: - - id - properties: - id: - type: object - description: The category's ID. - properties: - $and: - type: array - description: The id's $and. - items: - type: array - description: The $and's details. - items: - type: array - description: The $and's details. - items: - type: object - title: $and - $or: - type: array - description: The id's $or. - items: - type: array - description: The $or's details. - items: - type: array - description: The $or's details. - items: - type: object - title: $or - $eq: - oneOf: - - type: array - description: The id's $eq. - items: - type: string - title: $eq - description: The $eq's details. - - type: array - description: The id's $eq. - items: - type: array - description: The $eq's details. - items: - type: string - title: $eq - description: The $eq's details. - $ne: - type: array - description: The id's $ne. - items: - type: string - title: $ne - description: The $ne's details. - $in: - type: array - description: The id's $in. - items: - type: array - description: The $in's details. - items: - type: string - title: $in - description: The $in's details. - $nin: - type: array - description: The id's $nin. - items: - type: array - description: The $nin's details. - items: - type: string - title: $nin - description: The $nin's details. - $not: - type: array - description: The id's $not. - items: - oneOf: - - type: string - title: $not - description: The $not's details. - - type: object - description: The $not's details. - $gt: - type: array - description: The id's $gt. - items: - type: string - title: $gt - description: The $gt's details. - $gte: - type: array - description: The id's $gte. - items: - type: string - title: $gte - description: The $gte's details. - $lt: - type: array - description: The id's $lt. - items: - type: string - title: $lt - description: The $lt's details. - $lte: - type: array - description: The id's $lte. - items: - type: string - title: $lte - description: The $lte's details. - $like: - type: string - title: $like - description: The id's $like. - $re: - type: string - title: $re - description: The id's $re. - $ilike: - type: string - title: $ilike - description: The id's $ilike. - $fulltext: - type: string - title: $fulltext - description: The id's $fulltext. - $overlap: - type: array - description: The id's $overlap. - items: - type: string - title: $overlap - description: The $overlap's details. - $contains: - type: array - description: The id's $contains. - items: - type: string - title: $contains - description: The $contain's $contains. - $contained: - type: array - description: The id's $contained. - items: - type: string - title: $contained - description: The $contained's details. - $exists: - type: boolean - title: $exists - description: The id's $exists. - name: region_id in: query description: The product's region id. @@ -1393,6 +987,20 @@ get: type: string title: category_id description: The category id's details. + - name: tag_id + in: query + required: false + schema: + oneOf: + - type: string + title: tag_id + description: The product's tag id. + - type: array + description: The product's tag id. + items: + type: string + title: tag_id + description: The tag id's details. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml b/www/apps/api-reference/specs/store/paths/store_products_{id}.yaml index 4d2c6b1f4c..e43a682dc7 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 @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. - name: region_id in: query description: The product's region id. 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 bc243a0743..8c7212bd7d 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions.yaml @@ -636,586 +636,6 @@ get: type: string title: name description: The name's details. - - name: code - in: query - required: false - schema: - oneOf: - - type: string - title: code - description: The region's code. - - type: array - description: The region's code. - items: - type: string - title: code - description: The code's details. - - name: created_at - in: query - description: The region's created at. - required: false - schema: - type: object - description: The region's created at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content - is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content - is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers - and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful - for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - - name: updated_at - in: query - description: The region's updated at. - required: false - schema: - type: object - description: The region's updated at. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's content - is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's content - is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - properties: - $and: - type: array - description: >- - Join query parameters with an AND condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $and - $or: - type: array - description: >- - Join query parameters with an OR condition. Each object's - content is the same type as the expected query parameters. - items: - type: object - title: $or - $eq: - oneOf: - - type: string - title: $eq - description: Filter by an exact match. - - type: array - description: Filter by an exact match. - items: - type: string - title: $eq - description: Filter by an exact match. - $ne: - type: string - title: $ne - description: Filter by values not equal to this parameter. - $in: - type: array - description: Filter by values in this array. - items: - type: string - title: $in - description: Filter by values in this array. - $nin: - type: array - description: Filter by values not in this array. - items: - type: string - title: $nin - description: Filter by values not in this array. - $not: - oneOf: - - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - - type: object - description: >- - Filter by values not matching the conditions in this - parameter. - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for - numbers and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. - Useful for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for - numbers and dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. - Useful for numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: >- - Apply a case-insensitive `like` filter. Useful for strings - only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: >- - Filter arrays that have overlapping values with this - parameter. - items: - type: string - title: $overlap - description: >- - Filter arrays that have overlapping values with this - parameter. - $contains: - type: array - description: >- - Filter arrays that contain some of the values of this - parameter. - items: - type: string - title: $contains - description: >- - Filter arrays that contain some of the values of this - parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: >- - Filter by whether a value for this parameter exists (not - `null`). - - type: array - description: >- - Filter by values not matching the conditions in this - parameter. - items: - type: string - title: $not - description: >- - Filter by values not matching the conditions in this - parameter. - $gt: - type: string - title: $gt - description: >- - Filter by values greater than this parameter. Useful for numbers - and dates only. - $gte: - type: string - title: $gte - description: >- - Filter by values greater than or equal to this parameter. Useful - for numbers and dates only. - $lt: - type: string - title: $lt - description: >- - Filter by values less than this parameter. Useful for numbers and - dates only. - $lte: - type: string - title: $lte - description: >- - Filter by values less than or equal to this parameter. Useful for - numbers and dates only. - $like: - type: string - title: $like - description: Apply a `like` filter. Useful for strings only. - $re: - type: string - title: $re - description: Apply a regex filter. Useful for strings only. - $ilike: - type: string - title: $ilike - description: Apply a case-insensitive `like` filter. Useful for strings only. - $fulltext: - type: string - title: $fulltext - description: Filter to apply on full-text properties. - $overlap: - type: array - description: Filter arrays that have overlapping values with this parameter. - items: - type: string - title: $overlap - description: Filter arrays that have overlapping values with this parameter. - $contains: - type: array - description: Filter arrays that contain some of the values of this parameter. - items: - type: string - title: $contains - description: Filter arrays that contain some of the values of this parameter. - $contained: - type: array - description: Filter arrays that contain all values of this parameter. - items: - type: string - title: $contained - description: Filter arrays that contain all values of this parameter. - $exists: - type: boolean - title: $exists - description: Filter by whether a value for this parameter exists (not `null`). - name: $and in: query description: >- @@ -1244,6 +664,20 @@ get: items: type: object title: $or + - name: currency_code + in: query + required: false + schema: + oneOf: + - type: string + title: currency_code + description: The region's currency code. + - type: array + description: The region's currency code. + items: + type: string + title: currency_code + description: The currency code's details. x-codeSamples: - lang: Shell label: cURL 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 cdc9b887de..c18e9d349b 100644 --- a/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_regions_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL 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 5ea63a57fc..0adc679223 100644 --- a/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return-reasons_{id}.yaml @@ -38,35 +38,6 @@ get: if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. without prefix it will replace the entire default fields. - - name: offset - in: query - description: The number of items to skip when retrieving a list. - required: false - schema: - type: number - title: offset - description: The number of items to skip when retrieving a list. - - name: limit - in: query - description: Limit the number of items returned in the list. - required: false - schema: - type: number - title: limit - description: Limit the number of items returned in the list. - - name: order - in: query - description: >- - The field to sort the data by. By default, the sort order is ascending. - To change the order to descending, prefix the field name with `-`. - required: false - schema: - type: string - title: order - description: >- - The field to sort the data by. By default, the sort order is - ascending. To change the order to descending, prefix the field name - with `-`. x-codeSamples: - lang: Shell label: cURL diff --git a/www/apps/api-reference/specs/store/paths/store_return.yaml b/www/apps/api-reference/specs/store/paths/store_return.yaml index 1dd093e554..637d658f9c 100644 --- a/www/apps/api-reference/specs/store/paths/store_return.yaml +++ b/www/apps/api-reference/specs/store/paths/store_return.yaml @@ -3,7 +3,6 @@ post: summary: Create Return description: Create a return. x-authenticated: false - parameters: [] requestBody: content: application/json: diff --git a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml index f5807cf7cf..4ce4b79b4b 100644 --- a/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml +++ b/www/apps/api-reference/specs/store/paths/store_shipping-options.yaml @@ -6,16 +6,6 @@ get: fields such as `id`. The shipping options 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/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 4dbd033eb3..f53f3b7c0a 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts index 637c146e48..061830f40b 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_claims_[id]_inbound_items_[action_id].ts @@ -21,48 +21,6 @@ * required: true * schema: * type: string - * - name: expand - * in: query - * description: Comma-separated relations that should be expanded in the returned data. - * required: false - * schema: - * type: string - * title: expand - * description: Comma-separated relations that should be expanded in the returned data. - * - name: fields - * in: query - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 28f539a64a..fe6ae593e5 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 6f1446b837..8ddc25b353 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 af971ede3a..16cc18baf5 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 @@ -35,30 +35,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts index d26cb27099..3574923aae 100644 --- a/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts +++ b/www/utils/generated/oas-output/operations/admin/delete_admin_exchanges_[id]_inbound_items_[action_id].ts @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 0c655ef219..04f271b3ac 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c5694ce1f0..47fc10dd34 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8dac87a804..0404e99769 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3f4b3f758d..c76c6daa33 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 80fa04bb46..81807017fa 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 017db1698f..3a32576304 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 @@ -42,30 +42,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f0490106da..3ed27eed4b 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3698eefbd3..5de109651b 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 2e7eafe3f9..5131393dcb 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 1064dfd07e..d5e868f317 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 05516861ab..f8c5b70d6a 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 aa1ea82d0c..f0e80fef37 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 53c585da69..3ff74e4971 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 38969843f9..c45f05dc48 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 17d736dd22..c8128cd2ce 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 77505f2557..a2fb8a4e0f 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 544273c0bb..bd298064de 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ce4e951979..02541f1b29 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 665d688af6..4a3e03470c 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 @@ -35,30 +35,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 48040ac177..0d351833ce 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 07d2b14da1..5d5cd96864 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 9e2ca85b7c..90d8a1bda2 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 fd11afd38f..496aca603c 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 28f8a2709e..6e3553b274 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 75634633f8..101e7b79cf 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 1c97e34ff3..205a085e6e 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 @@ -37,30 +37,6 @@ * Comma-separated fields that should be included in the returned data. * if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default fields. * without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 e1d0a55ebb..0ef57c1f7a 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 9a972a84c9..eea8505313 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 bd875a9f99..6af8a76a39 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c24c07f54b..5ad7798e63 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: include_ancestors_tree * in: query * description: Whether to retrieve the category's parent. When enabled, the parent category is set in the `parent_category` property. 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 bcfb1ac0dc..ddf48e3de8 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 2e19f7099a..5713aceedb 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 1638c442a8..2d7d06084a 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 fe9162ff69..ad1c26a0e4 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f987528457..9b2b9cb195 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 70ffe7949d..8ccee0cc40 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 89d842bd23..1041d92192 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 @@ -6,8 +6,9 @@ * description: > * Retrieve a list of rules in a promotion. The type of rules retrieved depend on the value of the `rule_type` path parameter: * - * - If `rule_type` is `rules`, the promotion's rules are retrivied. - * - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. + * - If `rule_type` is `rules`, the promotion's rules are retrivied. - If `rule_type` is `target-rules`, the target rules of the promotion's application method are retrieved. + * + * * - If `rule_type` is `buy-rules`, the buy rules of the promotion's application method are retrieved. * x-authenticated: true * parameters: @@ -45,30 +46,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts index c8bd67d504..5a981ccfd2 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-attribute-options_[rule_type].ts @@ -9,8 +9,9 @@ * Only the attributes of the rule type specified in the path parameter are retrieved: * * - If `rule_type` is `rules`, the attributes of the promotion's type are retrieved. - * - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - * - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. + * + * + * - If `rule_type` is `target-rules`, the target rules' attributes of the application method's type are retrieved. - If `rule_type` is `buy-rules`, the buy rules' attributes of the application method's type are retrieved. * x-authenticated: true * parameters: * - name: rule_type diff --git a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts index 184e4c8e22..be75944e0f 100644 --- a/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts +++ b/www/utils/generated/oas-output/operations/admin/get_admin_promotions_rule-value-options_[rule_type]_[rule_attribute_id].ts @@ -24,24 +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 - * fields. without prefix it will replace the entire default fields. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. * - name: offset * in: query * description: The number of items to skip when retrieving a list. 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 9f2741d5a3..b2c210a955 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 690fe209ef..4fec944c1c 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 @@ -69,20 +69,6 @@ * type: string * title: id * description: A region's ID. - * - name: code - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: code - * description: Filter by a currency code. - * - type: array - * description: Filter by currency codes. - * items: - * type: string - * title: code - * description: A currency code. * - name: name * in: query * required: false @@ -472,6 +458,20 @@ * items: * type: object * title: $or + * - name: currency_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: currency_code + * description: The region's currency code. + * - type: array + * description: The region's currency code. + * items: + * type: string + * title: currency_code + * description: The currency code's details. * security: * - api_token: [] * - cookie_auth: [] 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 0e8407fffe..6b69b61194 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 aa8c628c34..176cbf820e 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3d612c5102..6dc46530c2 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 7d22c1faab..79fd6cb761 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 15162ed20d..83d2b46526 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 56e04c5140..8403abbff0 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f55e21b90c..ddabcaacba 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d9129ae0f7..4f1ea90538 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 0c9964ba9f..e0cce49875 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 58c6e29966..933f28ac95 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 b9b657a344..4a5fc175e8 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 5695c38aee..8dfd6c6606 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 0857ec47e9..29a5faa71a 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 e2b83b4652..306774baf5 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 2eb7bd7bf8..6d352603a4 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts index 19842b41f7..c068ccb326 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_api-keys.ts @@ -2,15 +2,12 @@ * @oas [post] /admin/api-keys * operationId: PostApiKeys * summary: Create Api Key - * description: > + * description: | * Create a secret or publishable API key. - * * A secret API key is used for admin authentication. * - * * A publishable API key is used by client applications to set the scope of the request. * x-authenticated: true - * parameters: [] * security: * - api_token: [] * - cookie_auth: [] 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 fc1ee9cd23..df10044c33 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f32c672571..eff2ad9d86 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 @@ -2,9 +2,8 @@ * @oas [post] /admin/api-keys/{id}/revoke * operationId: PostApiKeysIdRevoke * summary: Revoke API Key - * description: > - * Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, - * it can't be used by client applications. + * description: | + * Revokes an API key. If the API key is a secret, it can't be used for authentication anymore. If it's publishable, it can't be used by client applications. * x-authenticated: true * parameters: * - name: id @@ -31,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 dd347c12c5..028d43795b 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c96fcd2e10..3bc9cb05ff 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -90,8 +66,8 @@ * type: string * title: type * description: > - * The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. - * Use `usage` to set a limit on the total number of times the campaign's promotions can be used. + * The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. Use `usage` to set a limit on the total + * number of times the campaign's promotions can be used. * enum: * - spend * - usage 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 9378c141c2..1e7942540c 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 bc5472ac4a..143f512a2e 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f49247642e..811de350c5 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 9059950963..377da4b633 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c3cd95dfe4..24c3b238d4 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 @@ -38,30 +38,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 5cb399e26e..4cb132db73 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 1219b0322c..e7fc5525a1 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 @@ -31,30 +31,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 33f2305f07..f791f73d88 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 1ba3e482e0..2122e26f2b 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 @@ -31,30 +31,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 705a1fc278..ac7f7f5174 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 dc89edf834..c5c28a09f2 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8bf05e6d63..3ccf9a8114 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 a18b5fe09e..0668fa6389 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 224894849c..9b8819bde7 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 cd918486b6..cae93d250c 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 002949d537..a9d751fc0d 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 32e1bc8970..86b8212cf1 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8066d9144a..98bd86bb46 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 fb26f3c3b4..e3c5bbc5b4 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d2ad86e9a3..e25a07a9aa 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 6c24e45466..2a978ef37c 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ece06f52dc..992e50077f 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 444ad38501..d3bd736193 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts index e26265cde8..44205a3f26 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_exchanges_[id]_cancel.ts @@ -2,7 +2,7 @@ * @oas [post] /admin/exchanges/{id}/cancel * operationId: PostExchangesIdCancel * summary: Cancel an Exchange - * description: Cancel an exchange and its associated return. + * description: Cancel an exchange and its associated return. * x-authenticated: true * parameters: * - name: id 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 99bb7cd9dc..b182cb364b 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 782b480c95..aa3bc38438 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 32190a0304..d439024156 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 01cf292714..31b5db7a51 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d19f18758b..8499409f9d 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8762d4f358..b2d8cfea05 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 02b0be571e..a244a4cf22 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -94,7 +70,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "country" + * default: country * - type: object * description: A province geo zone. * required: @@ -114,7 +90,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "province" + * default: province * province_code: * type: string * title: province_code @@ -139,7 +115,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "city" + * default: city * province_code: * type: string * title: province_code @@ -169,7 +145,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "zip" + * default: zip * province_code: * type: string * title: province_code 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 638e23aff9..33f2178c4c 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -70,8 +46,6 @@ * schema: * type: object * description: The service zone's details. - * required: - * - name * properties: * name: * type: string @@ -93,7 +67,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "country" + * default: country * metadata: * type: object * description: The geo zone's metadata. @@ -117,7 +91,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "province" + * default: province * metadata: * type: object * description: The geo zone's metadata. @@ -146,7 +120,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "city" + * default: city * metadata: * type: object * description: The geo zone's metadata. @@ -180,7 +154,7 @@ * type: string * title: type * description: The geo zone's type. - * default: "zip" + * default: zip * metadata: * type: object * description: The geo zone's metadata. 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 5710b1c095..109b56e1b7 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c45acc4d04..6176d12e3e 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 @@ -2,10 +2,9 @@ * @oas [post] /admin/fulfillments/{id}/cancel * operationId: PostFulfillmentsIdCancel * summary: Cancel a Fulfillment - * description: > + * description: | * Cancel a fulfillment. The fulfillment can't be shipped or delivered. * - * * To cancel the fulfillment, the `cancelFulfillment` method of the associated fulfillment provider is used. * x-authenticated: true * parameters: @@ -33,30 +32,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 bc6e1a60d6..87d4954ad5 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 9925fc0299..711995ea54 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 531617315c..63246b4a25 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -63,20 +39,6 @@ * schema: * type: object * description: The properties to update in the inventory item. - * required: - * - sku - * - hs_code - * - weight - * - length - * - height - * - width - * - origin_country - * - mid_code - * - material - * - title - * - description - * - thumbnail - * - metadata * properties: * sku: * type: string 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 0c220e36f2..7d3ec58114 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 4e050d8215..16140153e4 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 a38c8cdbfd..0d91186e5d 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 67c0be8ba0..53d9c582bd 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts index 3a1c2f3851..80ce64627f 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_invites_accept.ts @@ -5,62 +5,14 @@ * description: > * Accept an invite and create a new user. * - * Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). - * The user can then authenticate using the `/auth/user/emailpass` API route. + * Since the user isn't created yet, the JWT token used in the authorization header is retrieved from the `/auth/user/emailpass/register` API route (or a provider other than `emailpass`). The user can then authenticate using the `/auth/user/emailpass` API route. * 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. - * required: false - * schema: - * type: string - * title: fields - * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default - * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: * schema: * type: object * description: The details of the user to be created. - * required: - * - email - * - first_name - * - last_name * properties: * email: * type: string diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts index 2722fbad69..0088fa57f9 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_order-edits.ts @@ -4,7 +4,6 @@ * summary: Create Order Edit * description: Create an order edit. * x-authenticated: true - * parameters: [] * security: * - api_token: [] * - cookie_auth: [] 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 bb18e12bd6..eac36e1d33 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 09735a84bd..b145661294 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 49cc1b35d7..598aaae87d 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 @@ -2,11 +2,14 @@ * @oas [post] /admin/orders/{id}/cancel * operationId: PostOrdersIdCancel * summary: Cancel Order - * description: > + * description: | * Cancel an order. The cancelation fails if: - * * - The order has captured payments. + * + * * - The order has refund payments. + * + * * - The order has fulfillments that aren't canceled. * x-authenticated: true * parameters: @@ -34,30 +37,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 4307a6c318..3aa2d9762e 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 e787ce8c43..24efadc96d 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 4c102587f9..2c94e5ae46 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 @@ -35,30 +35,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 acdd88db73..68ae8eb5f0 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 @@ -3,7 +3,7 @@ * operationId: PostOrdersIdFulfillmentsFulfillment_idShipments * summary: Create Shipment for an Order's Fulfillment * x-sidebar-summary: Create Shipment - * description: Create a shipment for an order's fulfillment. + * description: Create a shipment for an order's fulfillment. * x-authenticated: true * parameters: * - name: id @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f90b2fdcb2..9be898960c 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3c75638b36..d18490692a 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 eb264f5716..cb319ef64f 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f00b29ff77..a9040a1d08 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8661e97e71..1c8b259246 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d208d540cb..e78f2cb4f3 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts index 16d9eaf1a6..a372a5aff5 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_price-lists_[id]_prices_batch.ts @@ -33,8 +33,6 @@ * - currency_code * - amount * - variant_id - * - min_quantity - * - max_quantity * properties: * currency_code: * type: string @@ -70,8 +68,6 @@ * required: * - id * - variant_id - * - min_quantity - * - max_quantity * properties: * id: * type: string 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 b0ec543668..ba97baf7cb 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -61,16 +37,7 @@ * content: * application/json: * schema: - * type: object - * description: The removal details. - * properties: - * remove: - * type: array - * description: The products to remove from the price list. - * items: - * type: string - * title: remove - * description: The ID of a product. + * $ref: "#/components/schemas/AdminLinkPriceListProducts" * x-codeSamples: * - lang: Shell * label: cURL 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 0246c8d9e1..9867029200 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 5cc7d9e030..8e552d42cf 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 0c10f8ca35..c060e2ac53 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 37ee303278..cad9ef6ca7 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 2297cc8338..7d8994bbde 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 030ae0405d..ff73262c7e 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c9a4fac650..3a30e54d4e 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 51bd665df3..3adc04871a 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 67640d2c79..fe9313fcca 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 b94be0e21a..cc67cb2790 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c828d02670..c53b112dac 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 5251f564dd..49253fa7ca 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 be526057ec..1b71914dc0 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 0ee31612de..576569b1a4 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8408fce5f5..e2843692d1 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 369fe6ab46..63fac95097 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 @@ -36,30 +36,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ddc878afa5..57aabb8e34 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 @@ -42,30 +42,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 32abaf87ac..0885673df2 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 6d45dc9262..3dc88fe90f 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 0140be1599..e4f76dc59f 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 @@ -6,11 +6,9 @@ * Start a product export process to retrieve a CSV of exported products. * * - * You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the - * execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`. + * You'll receive in the response the transaction ID of the workflow generating the CSV file. To check the status of the execution, send a GET request to `/admin/workflows-executions/export-products/:transaction-id`. * - * 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. + * 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 @@ -31,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts index 88bfd18738..c794b266f1 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_products_import.ts @@ -4,7 +4,6 @@ * summary: Create Product Import * description: Create a new product import process. The products aren't imported until the import is confirmed with the `/admin/products/:transaction-id/import` API route. * x-authenticated: true - * parameters: [] * security: * - api_token: [] * - cookie_auth: [] 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 529b12b113..3a6da2a3d0 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -118,8 +94,8 @@ * type: * type: string * description: > - * The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. - * Use `usage` to set a limit on the total number of times the campaign's promotions can be used. + * The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. Use `usage` to set a limit on the total + * number of times the campaign's promotions can be used. * enum: * - spend * - usage 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 ec657b84c5..4ef1bc2d00 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 54e4cd5764..2985f35a9c 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +49,6 @@ * description: A buy rule's details. * required: * - operator - * - description * - attribute * - values * properties: @@ -118,7 +93,6 @@ * description: The properties to update in a buy rule. * required: * - id - * - description * - values * properties: * id: @@ -215,7 +189,7 @@ * type: string * title: object * description: The name of the object that was deleted. - * default: "promotion-rule" + * default: promotion-rule * deleted: * type: boolean * title: deleted 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 8622d57df7..fa85ea725a 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +49,6 @@ * description: A rule's details. * required: * - operator - * - description * - attribute * - values * properties: @@ -118,7 +93,6 @@ * description: The properties to update in a rule. * required: * - id - * - description * - values * properties: * id: @@ -215,7 +189,7 @@ * type: string * title: object * description: The name of the object that was deleted. - * default: "promotion-rule" + * default: promotion-rule * deleted: * type: boolean * title: deleted 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 28effb6204..c3cc1610f3 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -73,7 +49,6 @@ * description: A target rule's details. * required: * - operator - * - description * - attribute * - values * properties: @@ -118,7 +93,6 @@ * description: The properties to update in a target rule. * required: * - id - * - description * - values * properties: * id: @@ -215,7 +189,7 @@ * type: string * title: object * description: The name of the object that was deleted. - * default: "promotion-rule" + * default: promotion-rule * deleted: * type: boolean * title: deleted 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 cff3a2557d..27e547426e 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 7e629246eb..ed93b4fb67 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 60dc521681..c5af9a5952 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 4da306addf..a78dc22cee 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 7f005761b7..d39d1278a3 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 b52e71ddd8..8f6b0bed54 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 f91fab2ae5..e27a0746ca 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 a1fe646bc3..cba4b32ed8 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 35c566a4bf..0d9652acc7 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d46a9020b0..70686fe079 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 9dae85135e..b711956a34 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 01185c481a..765f3de519 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 5876868023..c5ea2b39c7 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 54f5d9b91e..cd96a9bcb0 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3fbb49683c..e531b73d71 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3d4db81433..0e2f61e965 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 @@ -2,9 +2,8 @@ * @oas [post] /admin/returns/{id}/receive/confirm * operationId: PostReturnsIdReceiveConfirm * summary: Confirm Return Receival - * description: > - * Confirm that a return has been received. This updates the quantity of the items received, if not damaged, and - * reflects the changes on the order. + * description: | + * Confirm that a return has been received. This updates the quantity of the items received, if not damaged, and reflects the changes on the order. * x-authenticated: true * parameters: * - name: id @@ -31,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 1a25937301..fab248d245 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 34cafc63de..d718e0a578 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 4bde1556ab..5daa324157 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 @@ -2,9 +2,8 @@ * @oas [post] /admin/returns/{id}/request * operationId: PostReturnsIdRequest * summary: Confirm Return Request - * description: > - * Confirm a requested return. The changes are applied on the inventory quantity and the order only after the - * return has been confirmed as received using the `/admin/returns/:id/received/confirm`. + * description: | + * Confirm a requested return. The changes are applied on the inventory quantity and the order only after the return has been confirmed as received using the `/admin/returns/:id/received/confirm`. * x-authenticated: true * parameters: * - name: id @@ -31,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d4fa46c956..49aee33b9a 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ed3b31a00f..2af3ee2c81 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 @@ -39,30 +39,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 76a58768c9..d9a2cb9ea6 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 39f618ca0f..22307f34d7 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 2a61c5cdb1..6bc2c6537d 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d1a5f25129..d406ddfde7 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 43b33247e9..ff834f6688 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -76,8 +52,8 @@ * price_type: * type: string * description: > - * The type of the shipping option's price. If `calculated`, its price is retrieved by the - * associated fulfillment provider during checkout. If `flat`, its price is set in the `prices` property. + * The type of the shipping option's price. If `calculated`, its price is retrieved by the associated fulfillment provider during checkout. If `flat`, its price is set in the `prices` + * property. * enum: * - calculated * - flat 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 913c84acd1..9155775b9e 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 d1025e6dbb..2f21a20e36 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 4c123de6da..736d6404ea 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] @@ -63,8 +39,6 @@ * schema: * type: object * description: The properties to update in the shipping profile. - * required: - * - metadata * properties: * name: * type: string 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 1930dc227c..950d9b1304 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 af1b87b2e6..6e53c2664a 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 3bc3d1bf2d..874a645f46 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ba79624e6e..d804f1b098 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 7a7cc7e56e..468cf0f3cd 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 c028fe432b..123406793a 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 133cc9b477..65d1bde382 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 8f0aa0e90b..9ed4d08124 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 aca446c904..e3ca32ae10 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 @@ -30,30 +30,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] 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 ef9f5da634..a0a4e2bb9c 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - api_token: [] * - cookie_auth: [] diff --git a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts index f73fe29b8b..81764d6408 100644 --- a/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts +++ b/www/utils/generated/oas-output/operations/admin/post_admin_uploads.ts @@ -4,7 +4,6 @@ * summary: Upload Files * description: Upload files to the configured File Module Provider. * x-authenticated: true - * parameters: [] * security: * - api_token: [] * - cookie_auth: [] 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 d082892800..eb7a812ef8 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: diff --git a/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts b/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts index 3be8983e2d..0ec6dd5b24 100644 --- a/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts +++ b/www/utils/generated/oas-output/operations/auth/delete_auth_session.ts @@ -4,7 +4,6 @@ * summary: Delete Session * description: Delete Session * x-authenticated: false - * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts new file mode 100644 index 0000000000..810cc60779 --- /dev/null +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_reset-password.ts @@ -0,0 +1,44 @@ +/** + * @oas [post] /auth/{actor_type}/{auth_provider}/reset-password + * operationId: PostActor_typeAuth_providerResetPassword + * summary: Add Reset Password to [actor_type] + * description: Add a Reset Password to a [actor_type] + * x-authenticated: false + * parameters: + * - name: actor_type + * in: path + * description: The [actor type]'s actor type. + * required: true + * schema: + * type: string + * - name: auth_provider + * in: path + * description: The [actor type]'s auth provider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/reset-password' + * tags: + * - "[actor_type]" + * responses: + * "200": + * description: OK + * "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: generateResetPasswordTokenWorkflow + * +*/ + diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts new file mode 100644 index 0000000000..33f5b0f454 --- /dev/null +++ b/www/utils/generated/oas-output/operations/auth/post_auth_[actor_type]_[auth_provider]_update.ts @@ -0,0 +1,43 @@ +/** + * @oas [post] /auth/{actor_type}/{auth_provider}/update + * operationId: PostActor_typeAuth_providerUpdate + * summary: Add Update to [actor_type] + * description: Add a Update to a [actor_type] + * x-authenticated: false + * parameters: + * - name: actor_type + * in: path + * description: The [actor type]'s actor type. + * required: true + * schema: + * type: string + * - name: auth_provider + * in: path + * description: The [actor type]'s auth provider. + * required: true + * schema: + * type: string + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/{actor_type}/{auth_provider}/update' + * tags: + * - "[actor_type]" + * responses: + * "200": + * description: OK + * "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/auth/post_auth_session.ts b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts index 439565ac24..13eb92de15 100644 --- a/www/utils/generated/oas-output/operations/auth/post_auth_session.ts +++ b/www/utils/generated/oas-output/operations/auth/post_auth_session.ts @@ -4,7 +4,6 @@ * summary: Create Session * description: Create a session. * x-authenticated: false - * parameters: [] * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts b/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts new file mode 100644 index 0000000000..dd1b87493f --- /dev/null +++ b/www/utils/generated/oas-output/operations/auth/post_auth_token_refresh.ts @@ -0,0 +1,31 @@ +/** + * @oas [post] /auth/token/refresh + * operationId: PostTokenRefresh + * summary: Create Token + * description: Create a token. + * x-authenticated: false + * parameters: [] + * x-codeSamples: + * - lang: Shell + * label: cURL + * source: curl -X POST '{backend_url}/auth/token/refresh' + * tags: + * - Token + * responses: + * "200": + * description: OK + * "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/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 77d7a64620..32a7bebf1f 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 @@ -35,30 +35,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 0fdbf6ba94..0bd0a80dbd 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 5bac80f7e3..0b66468c59 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - cookie_auth: [] * - jwt_token: [] 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 06fc94df2b..9b16ffca5c 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 ec80a84a6a..e2707cdbbf 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 4650c55703..beeb9d384f 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 105eb5e896..1fb5c5e033 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - cookie_auth: [] * - jwt_token: [] 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 2a51dbdefc..dd0693be1d 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 @@ -47,117 +47,59 @@ * type: string * title: order * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * - name: metadata - * in: query - * description: The customer's metadata. - * required: true - * schema: - * type: object - * description: The customer's metadata. - * - name: first_name - * in: query - * description: The customer's first name. - * required: true - * schema: - * type: string - * title: first_name - * description: The customer's first name. - * - name: last_name - * in: query - * description: The customer's last name. - * required: true - * schema: - * type: string - * title: last_name - * description: The customer's last name. - * - name: phone - * in: query - * description: The customer's phone. - * required: true - * schema: - * type: string - * title: phone - * description: The customer's phone. - * - name: company - * in: query - * description: The customer's company. - * required: true - * schema: - * type: string - * title: company - * description: The customer's company. - * - name: address_1 - * in: query - * description: The customer's address 1. - * required: true - * schema: - * type: string - * title: address_1 - * description: The customer's address 1. - * - name: address_2 - * in: query - * description: The customer's address 2. - * required: true - * schema: - * type: string - * title: address_2 - * description: The customer's address 2. * - name: city * in: query * description: The customer's city. - * required: true + * required: false * schema: - * type: string - * title: city - * description: The customer's city. + * oneOf: + * - type: string + * title: city + * description: The customer's city. + * - type: array + * description: The customer's city. + * items: + * type: string + * title: city + * description: The city's details. * - name: country_code * in: query * description: The customer's country code. - * required: true + * required: false * schema: - * type: string - * title: country_code - * description: The customer's country code. - * - name: province - * in: query - * description: The customer's province. - * required: true - * schema: - * type: string - * title: province - * description: The customer's province. + * oneOf: + * - type: string + * title: country_code + * description: The customer's country code. + * - type: array + * description: The customer's country code. + * items: + * type: string + * title: country_code + * description: The country code's details. * - name: postal_code * in: query * description: The customer's postal code. - * required: true - * schema: - * type: string - * title: postal_code - * description: The customer's postal code. - * - name: address_name - * in: query - * description: The customer's address name. - * required: true - * schema: - * type: string - * title: address_name - * description: The customer's address name. - * - name: is_default_shipping - * in: query - * description: The customer's is default shipping. * required: false * schema: - * type: boolean - * title: is_default_shipping - * description: The customer's is default shipping. - * - name: is_default_billing + * oneOf: + * - type: string + * title: postal_code + * description: The customer's postal code. + * - type: array + * description: The customer's postal code. + * items: + * type: string + * title: postal_code + * description: The postal code's details. + * - name: q * in: query - * description: The customer's is default billing. + * description: The customer's q. * required: false * schema: - * type: boolean - * title: is_default_billing - * description: The customer's is default billing. + * type: string + * title: q + * description: The customer's q. * security: * - cookie_auth: [] * - jwt_token: [] 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 362e67819e..31a6d138a3 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - cookie_auth: [] * - jwt_token: [] 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 fdf4f8e9da..1d5f666d3b 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 @@ -3,7 +3,7 @@ * operationId: GetOrders * summary: List Orders * 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: false + * x-authenticated: true * parameters: * - name: expand * in: query @@ -61,20 +61,6 @@ * type: string * title: id * description: The id's ID. - * - name: name - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: name - * description: The order's name. - * - type: array - * description: The order's name. - * items: - * type: string - * title: name - * description: The name's details. * - name: $and * in: query * required: false @@ -93,6 +79,41 @@ * items: * type: object * title: $or + * - name: status + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: status + * description: The order's status. + * - type: string + * title: status + * description: The order's status. + * - type: string + * title: status + * description: The order's status. + * - type: string + * title: status + * description: The order's status. + * - type: string + * title: status + * description: The order's status. + * - type: string + * title: status + * description: The order's status. + * - type: array + * description: The order's status. + * items: + * type: string + * description: The status's details. + * enum: + * - canceled + * - requires_action + * - pending + * - completed + * - draft + * - archived * x-codeSamples: * - lang: Shell * label: cURL @@ -147,6 +168,9 @@ * $ref: "#/components/responses/invalid_request_error" * "500": * $ref: "#/components/responses/500_error" + * security: + * - cookie_auth: [] + * - jwt_token: [] * */ 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 c8b3df4636..68d2e17c8a 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 @@ -29,76 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * - 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: $and - * in: query - * required: false - * schema: - * type: array - * description: The order's $and. - * items: - * type: object - * title: $and - * - name: $or - * in: query - * required: false - * schema: - * type: array - * description: The order's $or. - * items: - * type: object - * title: $or * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts index a543d9496f..790b1ea66d 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_payment-providers.ts @@ -50,58 +50,11 @@ * - name: region_id * in: query * description: The payment provider's region id. - * required: false + * required: true * schema: - * oneOf: - * - type: string - * title: region_id - * description: The payment provider's region id. - * - type: array - * description: The payment provider's region id. - * items: - * type: string - * title: region_id - * description: The region id's details. - * - name: id - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: id - * description: The payment provider's ID. - * - type: array - * description: The payment provider's ID. - * items: - * type: string - * title: id - * description: The id's ID. - * - name: is_enabled - * in: query - * description: The payment provider's is enabled. - * required: false - * schema: - * type: boolean - * title: is_enabled - * description: The payment provider's is enabled. - * - name: $and - * in: query - * required: false - * schema: - * type: array - * description: The payment provider's $and. - * items: - * type: object - * title: $and - * - name: $or - * in: query - * required: false - * schema: - * type: array - * description: The payment provider's $or. - * items: - * type: object - * title: $or + * type: string + * title: region_id + * description: The payment provider's region id. * x-codeSamples: * - lang: Shell * label: cURL 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 3f52db4c5e..bc1362477b 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 @@ -852,22 +852,6 @@ * type: string * title: name * description: The name's details. - * - name: is_active - * in: query - * description: The product category's is active. - * required: false - * schema: - * type: boolean - * title: is_active - * description: The product category's is active. - * - name: is_internal - * in: query - * description: The product category's is internal. - * required: false - * schema: - * type: boolean - * title: is_internal - * description: The product category's is internal. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_product-categories_[id].ts index c008e45258..ee0f059aea 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: include_ancestors_tree * in: query * description: The product category's include ancestors tree. 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 85cb79d8b2..64faa386dd 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 @@ -137,21 +137,6 @@ * type: string * title: collection_id * description: The collection id's details. - * - name: tags - * in: query - * description: The product's tags. - * required: false - * schema: - * oneOf: - * - type: string - * title: tags - * description: The product's tags. - * - type: array - * description: The product's tags. - * items: - * type: string - * title: tags - * description: The tag's tags. * - name: type_id * in: query * description: The product's type id. @@ -828,393 +813,6 @@ * type: boolean * title: $exists * description: The deleted at's $exists. - * - name: status - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: status - * description: The product's status. - * - type: string - * title: status - * description: The product's status. - * - type: string - * title: status - * description: The product's status. - * - type: string - * title: status - * description: The product's status. - * - type: array - * description: The product's status. - * items: - * type: string - * enum: - * - draft - * - proposed - * - published - * - rejected - * - name: categories - * in: query - * required: false - * schema: - * oneOf: - * - type: object - * description: The product's categories. - * required: - * - id - * properties: - * id: - * type: object - * description: The category's ID. - * properties: - * $and: - * type: array - * description: The id's $and. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: &a1 - * type: object - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * - type: object - * description: The $and's details. - * - type: array - * description: The $and's details. - * items: - * oneOf: - * - type: array - * description: The $and's details. - * items: *a1 - * title: $and - * - type: object - * description: The $and's details. - * x-schemaName: RegExp - * $or: - * type: array - * description: The id's $or. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: &a2 - * type: object - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * - type: object - * description: The $or's details. - * - type: array - * description: The $or's details. - * items: - * oneOf: - * - type: array - * description: The $or's details. - * items: *a2 - * title: $or - * - type: object - * description: The $or's details. - * x-schemaName: RegExp - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: The id's $eq. - * - type: object - * description: The id's $eq. - * x-schemaName: RegExp - * - type: array - * description: The id's $eq. - * items: - * oneOf: - * - type: string - * title: $eq - * description: The $eq's details. - * - type: object - * description: The $eq's details. - * x-schemaName: RegExp - * $ne: - * oneOf: - * - type: string - * title: $ne - * description: The id's $ne. - * - type: object - * description: The id's $ne. - * x-schemaName: RegExp - * $in: - * type: array - * description: The id's $in. - * items: - * oneOf: - * - type: string - * title: $in - * description: The $in's details. - * - type: object - * description: The $in's details. - * x-schemaName: RegExp - * $nin: - * type: array - * description: The id's $nin. - * items: - * oneOf: - * - type: string - * title: $nin - * description: The $nin's details. - * - type: object - * description: The $nin's details. - * x-schemaName: RegExp - * $not: - * oneOf: - * - type: string - * title: $not - * description: The id's $not. - * - type: object - * description: The id's $not. - * x-schemaName: RegExp - * - type: object - * description: The id's $not. - * - type: array - * description: The id's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * x-schemaName: RegExp - * $gt: - * oneOf: - * - type: string - * title: $gt - * description: The id's $gt. - * - type: object - * description: The id's $gt. - * x-schemaName: RegExp - * $gte: - * oneOf: - * - type: string - * title: $gte - * description: The id's $gte. - * - type: object - * description: The id's $gte. - * x-schemaName: RegExp - * $lt: - * oneOf: - * - type: string - * title: $lt - * description: The id's $lt. - * - type: object - * description: The id's $lt. - * x-schemaName: RegExp - * $lte: - * oneOf: - * - type: string - * title: $lte - * description: The id's $lte. - * - type: object - * description: The id's $lte. - * x-schemaName: RegExp - * $like: - * type: string - * title: $like - * description: The id's $like. - * $re: - * type: string - * title: $re - * description: The id's $re. - * $ilike: - * type: string - * title: $ilike - * description: The id's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The id's $fulltext. - * $overlap: - * type: array - * description: The id's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The id's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The id's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The id's $exists. - * - type: object - * description: The product's categories. - * required: - * - id - * properties: - * id: - * type: object - * description: The category's ID. - * properties: - * $and: - * type: array - * description: The id's $and. - * items: - * type: array - * description: The $and's details. - * items: - * type: array - * description: The $and's details. - * items: *a1 - * title: $and - * $or: - * type: array - * description: The id's $or. - * items: - * type: array - * description: The $or's details. - * items: - * type: array - * description: The $or's details. - * items: *a2 - * title: $or - * $eq: - * oneOf: - * - type: array - * description: The id's $eq. - * items: - * type: string - * title: $eq - * description: The $eq's details. - * - type: array - * description: The id's $eq. - * items: - * type: array - * description: The $eq's details. - * items: - * type: string - * title: $eq - * description: The $eq's details. - * $ne: - * type: array - * description: The id's $ne. - * items: - * type: string - * title: $ne - * description: The $ne's details. - * $in: - * type: array - * description: The id's $in. - * items: - * type: array - * description: The $in's details. - * items: - * type: string - * title: $in - * description: The $in's details. - * $nin: - * type: array - * description: The id's $nin. - * items: - * type: array - * description: The $nin's details. - * items: - * type: string - * title: $nin - * description: The $nin's details. - * $not: - * type: array - * description: The id's $not. - * items: - * oneOf: - * - type: string - * title: $not - * description: The $not's details. - * - type: object - * description: The $not's details. - * $gt: - * type: array - * description: The id's $gt. - * items: - * type: string - * title: $gt - * description: The $gt's details. - * $gte: - * type: array - * description: The id's $gte. - * items: - * type: string - * title: $gte - * description: The $gte's details. - * $lt: - * type: array - * description: The id's $lt. - * items: - * type: string - * title: $lt - * description: The $lt's details. - * $lte: - * type: array - * description: The id's $lte. - * items: - * type: string - * title: $lte - * description: The $lte's details. - * $like: - * type: string - * title: $like - * description: The id's $like. - * $re: - * type: string - * title: $re - * description: The id's $re. - * $ilike: - * type: string - * title: $ilike - * description: The id's $ilike. - * $fulltext: - * type: string - * title: $fulltext - * description: The id's $fulltext. - * $overlap: - * type: array - * description: The id's $overlap. - * items: - * type: string - * title: $overlap - * description: The $overlap's details. - * $contains: - * type: array - * description: The id's $contains. - * items: - * type: string - * title: $contains - * description: The $contain's $contains. - * $contained: - * type: array - * description: The id's $contained. - * items: - * type: string - * title: $contained - * description: The $contained's details. - * $exists: - * type: boolean - * title: $exists - * description: The id's $exists. * - name: region_id * in: query * description: The product's region id. @@ -1267,6 +865,20 @@ * type: string * title: category_id * description: The category id's details. + * - name: tag_id + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: tag_id + * description: The product's tag id. + * - type: array + * description: The product's tag id. + * items: + * type: string + * title: tag_id + * description: The tag id's details. * x-codeSamples: * - lang: Shell * label: cURL 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 693c4a4b31..071e2c9d40 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * - name: region_id * in: query * description: The product's region id. 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 0b5c79fda8..73b8878860 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 @@ -492,482 +492,6 @@ * type: string * title: name * description: The name's details. - * - name: code - * in: query - * required: false - * schema: - * oneOf: - * - type: string - * title: code - * description: The region's code. - * - type: array - * description: The region's code. - * items: - * type: string - * title: code - * description: The code's details. - * - name: created_at - * in: query - * description: The region's created at. - * required: false - * schema: - * type: object - * description: The region's created at. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $gt: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $gt: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * - name: updated_at - * in: query - * description: The region's updated at. - * required: false - * schema: - * type: object - * description: The region's updated at. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * properties: - * $and: - * type: array - * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $and - * $or: - * type: array - * description: Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters. - * items: - * type: object - * title: $or - * $eq: - * oneOf: - * - type: string - * title: $eq - * description: Filter by an exact match. - * - type: array - * description: Filter by an exact match. - * items: - * type: string - * title: $eq - * description: Filter by an exact match. - * $ne: - * type: string - * title: $ne - * description: Filter by values not equal to this parameter. - * $in: - * type: array - * description: Filter by values in this array. - * items: - * type: string - * title: $in - * description: Filter by values in this array. - * $nin: - * type: array - * description: Filter by values not in this array. - * items: - * type: string - * title: $nin - * description: Filter by values not in this array. - * $not: - * oneOf: - * - type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * - type: object - * description: Filter by values not matching the conditions in this parameter. - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $gt: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). - * - type: array - * description: Filter by values not matching the conditions in this parameter. - * items: - * type: string - * title: $not - * description: Filter by values not matching the conditions in this parameter. - * $gt: - * type: string - * title: $gt - * description: Filter by values greater than this parameter. Useful for numbers and dates only. - * $gte: - * type: string - * title: $gte - * description: Filter by values greater than or equal to this parameter. Useful for numbers and dates only. - * $lt: - * type: string - * title: $lt - * description: Filter by values less than this parameter. Useful for numbers and dates only. - * $lte: - * type: string - * title: $lte - * description: Filter by values less than or equal to this parameter. Useful for numbers and dates only. - * $like: - * type: string - * title: $like - * description: Apply a `like` filter. Useful for strings only. - * $re: - * type: string - * title: $re - * description: Apply a regex filter. Useful for strings only. - * $ilike: - * type: string - * title: $ilike - * description: Apply a case-insensitive `like` filter. Useful for strings only. - * $fulltext: - * type: string - * title: $fulltext - * description: Filter to apply on full-text properties. - * $overlap: - * type: array - * description: Filter arrays that have overlapping values with this parameter. - * items: - * type: string - * title: $overlap - * description: Filter arrays that have overlapping values with this parameter. - * $contains: - * type: array - * description: Filter arrays that contain some of the values of this parameter. - * items: - * type: string - * title: $contains - * description: Filter arrays that contain some of the values of this parameter. - * $contained: - * type: array - * description: Filter arrays that contain all values of this parameter. - * items: - * type: string - * title: $contained - * description: Filter arrays that contain all values of this parameter. - * $exists: - * type: boolean - * title: $exists - * description: Filter by whether a value for this parameter exists (not `null`). * - name: $and * in: query * description: Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters. @@ -988,6 +512,20 @@ * items: * type: object * title: $or + * - name: currency_code + * in: query + * required: false + * schema: + * oneOf: + * - type: string + * title: currency_code + * description: The region's currency code. + * - type: array + * description: The region's currency code. + * items: + * type: string + * title: currency_code + * description: The currency code's details. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts b/www/utils/generated/oas-output/operations/store/get_store_regions_[id].ts index a5a7d196ba..6354e35331 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL 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 23c3bafab7..e40f17f7cb 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * x-codeSamples: * - lang: Shell * label: cURL diff --git a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts index fd601abc5f..5ec51d24d0 100644 --- a/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts +++ b/www/utils/generated/oas-output/operations/store/get_store_shipping-options.ts @@ -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: 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.ts b/www/utils/generated/oas-output/operations/store/post_store_carts.ts index 39888d99a5..b223e70ea4 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 b51ac6568a..d5aa71c83e 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 6c0ad10a34..c195b641b0 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 c9e2046cfd..9bfc3e7695 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 17021ad255..f2c5eb38ee 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 @@ -35,30 +35,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 0ec3ce5cbd..74f916c606 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 28aa117b30..5b64c7facd 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 bd84aa0533..192be2f9f9 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 29817bd5c7..2cf8c83df6 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 68e00c6cba..29d7df075e 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - cookie_auth: [] * - jwt_token: [] 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 87e3239266..7cdaa1f2a6 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - cookie_auth: [] * - jwt_token: [] @@ -56,19 +32,6 @@ * schema: * type: object * description: SUMMARY - * required: - * - metadata - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - address_name * properties: * metadata: * type: object 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 e0eb0d0710..1000ca82a4 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * security: * - cookie_auth: [] * - jwt_token: [] @@ -62,19 +38,6 @@ * schema: * type: object * description: SUMMARY - * required: - * - metadata - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - address_name * properties: * metadata: * type: object 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 f54c9d69cc..7da87a0363 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 @@ -23,30 +23,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: 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 2144d2f31e..dfc1713bce 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 @@ -29,30 +29,6 @@ * title: fields * description: Comma-separated fields that should be included in the returned data. if a field is prefixed with `+` it will be added to the default fields, using `-` will remove it from the default * fields. without prefix it will replace the entire default fields. - * - name: offset - * in: query - * description: The number of items to skip when retrieving a list. - * required: false - * schema: - * type: number - * title: offset - * description: The number of items to skip when retrieving a list. - * - name: limit - * in: query - * description: Limit the number of items returned in the list. - * required: false - * schema: - * type: number - * title: limit - * description: Limit the number of items returned in the list. - * - name: order - * in: query - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. - * required: false - * schema: - * type: string - * title: order - * description: The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with `-`. * requestBody: * content: * application/json: diff --git a/www/utils/generated/oas-output/operations/store/post_store_return.ts b/www/utils/generated/oas-output/operations/store/post_store_return.ts index 2ce0bbf2b9..0dbebfff29 100644 --- a/www/utils/generated/oas-output/operations/store/post_store_return.ts +++ b/www/utils/generated/oas-output/operations/store/post_store_return.ts @@ -4,7 +4,6 @@ * summary: Create Return * description: Create a return. * x-authenticated: false - * parameters: [] * requestBody: * content: * application/json: diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts b/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts index 6653a61def..7a43743e31 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateCollection.ts @@ -5,7 +5,6 @@ * x-schemaName: AdminCreateCollection * required: * - title - * - metadata * properties: * title: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts index 6c8b41c6bf..b224861c47 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateCustomerGroup.ts @@ -5,7 +5,6 @@ * x-schemaName: AdminCreateCustomerGroup * required: * - name - * - metadata * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts index 4587bff9c1..6ad31be232 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateFulfillment.ts @@ -11,12 +11,7 @@ * - labels * - order * - order_id - * - shipping_option_id * - data - * - packed_at - * - shipped_at - * - delivered_at - * - canceled_at * - metadata * properties: * location_id: @@ -30,18 +25,6 @@ * delivery_address: * type: object * description: The fulfillment's delivery address. - * required: - * - first_name - * - last_name - * - phone - * - company - * - address_1 - * - address_2 - * - city - * - country_code - * - province - * - postal_code - * - metadata * properties: * first_name: * type: string @@ -97,8 +80,6 @@ * - sku * - quantity * - barcode - * - line_item_id - * - inventory_item_id * properties: * title: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts index 6a0fab8381..bcb01df18a 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreatePriceList.ts @@ -6,8 +6,6 @@ * required: * - title * - description - * - starts_at - * - ends_at * properties: * title: * type: string @@ -50,8 +48,6 @@ * - currency_code * - amount * - variant_id - * - min_quantity - * - max_quantity * properties: * currency_code: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts b/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts index 9f10c2856d..3fcb59dc49 100644 --- a/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts +++ b/www/utils/generated/oas-output/schemas/AdminCreateShippingProfile.ts @@ -2,6 +2,7 @@ * @schema AdminCreateShippingProfile * type: object * description: SUMMARY + * x-schemaName: AdminCreateShippingProfile * required: * - name * - type @@ -17,7 +18,6 @@ * metadata: * type: object * description: The shipping profile's metadata. - * x-schemaName: AdminCreateShippingProfile * */ diff --git a/www/utils/generated/oas-output/schemas/AdminLinkPriceListProducts.ts b/www/utils/generated/oas-output/schemas/AdminLinkPriceListProducts.ts new file mode 100644 index 0000000000..34ad89f3db --- /dev/null +++ b/www/utils/generated/oas-output/schemas/AdminLinkPriceListProducts.ts @@ -0,0 +1,16 @@ +/** + * @schema AdminLinkPriceListProducts + * type: object + * description: The removal details. + * properties: + * remove: + * type: array + * description: The products to remove from the price list. + * items: + * type: string + * title: remove + * description: The ID of a product. + * x-schemaName: AdminLinkPriceListProducts + * +*/ + diff --git a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts index b5714ed429..f306190611 100644 --- a/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/AdminOrderPreview.ts @@ -7,8 +7,8 @@ * - return_requested_total * - order_change * - currency_code - * - id * - version + * - id * - region_id * - customer_id * - sales_channel_id @@ -467,14 +467,14 @@ * type: string * title: currency_code * description: The order preview's currency code. - * id: - * type: string - * title: id - * description: The order preview's ID. * version: * type: number * title: version * description: The order preview's version. + * id: + * type: string + * title: id + * description: The order preview's ID. * region_id: * type: string * title: region_id diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts index b2b0227da4..fd5e1e65e3 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsItemsActionReqSchema.ts @@ -3,8 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminPostClaimsItemsActionReqSchema - * required: - * - reason_id * properties: * quantity: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts index a13cd49f0d..e5d1541e15 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingActionReqSchema.ts @@ -4,10 +4,10 @@ * description: SUMMARY * x-schemaName: AdminPostClaimsShippingActionReqSchema * properties: - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The claim's custom price. + * title: custom_amount + * description: The claim's custom amount. * internal_note: * type: string * title: internal_note diff --git a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts index d47e578798..6cb4aa2673 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostClaimsShippingReqSchema.ts @@ -10,10 +10,10 @@ * type: string * title: shipping_option_id * description: The claim's shipping option id. - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The claim's custom price. + * title: custom_amount + * description: The claim's custom amount. * description: * type: string * title: description diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts index 1a0729aa16..f2970b2600 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingActionReqSchema.ts @@ -4,10 +4,10 @@ * description: SUMMARY * x-schemaName: AdminPostExchangesShippingActionReqSchema * properties: - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The exchange's custom price. + * title: custom_amount + * description: The exchange's custom amount. * internal_note: * type: string * title: internal_note diff --git a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts index 40f97d56c4..19b5bb1bd9 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostExchangesShippingReqSchema.ts @@ -10,10 +10,10 @@ * type: string * title: shipping_option_id * description: The exchange's shipping option id. - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The exchange's custom price. + * title: custom_amount + * description: The exchange's custom amount. * description: * type: string * title: description diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts index da414d511c..0a0f6eb0a1 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderClaimsReqSchema.ts @@ -6,8 +6,6 @@ * required: * - type * - order_id - * - reason_id - * - metadata * properties: * type: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts index fb29681a97..3a317903c4 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsReqSchema.ts @@ -5,7 +5,6 @@ * x-schemaName: AdminPostOrderEditsReqSchema * required: * - order_id - * - metadata * properties: * order_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts index 28964c3650..ebaed778ac 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingActionReqSchema.ts @@ -4,10 +4,10 @@ * description: SUMMARY * x-schemaName: AdminPostOrderEditsShippingActionReqSchema * properties: - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The order edit's custom price. + * title: custom_amount + * description: The order edit's custom amount. * internal_note: * type: string * title: internal_note diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts index cb32d0e6fc..d7f2a237ca 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderEditsShippingReqSchema.ts @@ -10,10 +10,10 @@ * type: string * title: shipping_option_id * description: The order edit's shipping option id. - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The order edit's custom price. + * title: custom_amount + * description: The order edit's custom amount. * description: * type: string * title: description diff --git a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts index d0cac217f4..abcdf7c2c2 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostOrderExchangesReqSchema.ts @@ -5,7 +5,6 @@ * x-schemaName: AdminPostOrderExchangesReqSchema * required: * - order_id - * - metadata * properties: * order_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts index 670646407a..2aa9c1e7f7 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReceiveReturnsReqSchema.ts @@ -3,8 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminPostReceiveReturnsReqSchema - * required: - * - metadata * properties: * internal_note: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts index f028d40256..8deb396f08 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReqSchema.ts @@ -5,7 +5,6 @@ * x-schemaName: AdminPostReturnsReqSchema * required: * - order_id - * - metadata * properties: * order_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts index 83d95f33e1..9dfff57b92 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsReturnReqSchema.ts @@ -3,8 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminPostReturnsReturnReqSchema - * required: - * - metadata * properties: * location_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts index 7579878ea3..b8f94c34f0 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingActionReqSchema.ts @@ -4,10 +4,10 @@ * description: SUMMARY * x-schemaName: AdminPostReturnsShippingActionReqSchema * properties: - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The return's custom price. + * title: custom_amount + * description: The return's custom amount. * internal_note: * type: string * title: internal_note diff --git a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts index 862ff6c101..f851221c24 100644 --- a/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts +++ b/www/utils/generated/oas-output/schemas/AdminPostReturnsShippingReqSchema.ts @@ -10,10 +10,10 @@ * type: string * title: shipping_option_id * description: The exchange's shipping option id. - * custom_price: + * custom_amount: * type: number - * title: custom_price - * description: The exchange's custom price. + * title: custom_amount + * description: The exchange's custom amount. * description: * type: string * title: description diff --git a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts index 35e871610a..2709de804a 100644 --- a/www/utils/generated/oas-output/schemas/AdminProductVariant.ts +++ b/www/utils/generated/oas-output/schemas/AdminProductVariant.ts @@ -63,6 +63,10 @@ * type: boolean * title: manage_inventory * description: The parent's manage inventory. + * inventory_quantity: + * type: number + * title: inventory_quantity + * description: The parent's inventory quantity. * hs_code: * type: string * title: hs_code diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts index acf7754a64..92f05aa0cb 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCollection.ts @@ -3,8 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateCollection - * required: - * - metadata * properties: * title: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts b/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts index dc5f88653b..adf288c2a0 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateCustomerGroup.ts @@ -3,8 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateCustomerGroup - * required: - * - metadata * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts index b332d68fce..03760f4c24 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdatePriceList.ts @@ -3,10 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdatePriceList - * required: - * - description - * - starts_at - * - ends_at * properties: * title: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts b/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts index 4ed0e0812b..e44bf61623 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateSalesChannel.ts @@ -3,9 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateSalesChannel - * required: - * - description - * - metadata * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts index 5e08691535..44e1b4fb27 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStockLocation.ts @@ -3,9 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateStockLocation - * required: - * - address_id - * - metadata * properties: * name: * type: string @@ -16,13 +13,7 @@ * description: The stock location's address. * required: * - address_1 - * - address_2 - * - company - * - city * - country_code - * - phone - * - postal_code - * - province * properties: * address_1: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts index 05edcb16c8..a280577132 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateStore.ts @@ -3,11 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateStore - * required: - * - default_sales_channel_id - * - default_region_id - * - default_location_id - * - metadata * properties: * name: * type: string diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts index 6ef92a07d4..00d74053cd 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateTaxRate.ts @@ -3,9 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateTaxRate - * required: - * - code - * - metadata * properties: * rate: * type: number diff --git a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts index bb12d598cf..445cb8590e 100644 --- a/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts +++ b/www/utils/generated/oas-output/schemas/AdminUpdateUser.ts @@ -3,10 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: AdminUpdateUser - * required: - * - first_name - * - last_name - * - avatar_url * properties: * first_name: * type: string diff --git a/www/utils/generated/oas-output/schemas/OrderPreview.ts b/www/utils/generated/oas-output/schemas/OrderPreview.ts index 185238c828..688e53ab92 100644 --- a/www/utils/generated/oas-output/schemas/OrderPreview.ts +++ b/www/utils/generated/oas-output/schemas/OrderPreview.ts @@ -7,8 +7,8 @@ * - order_change * - status * - currency_code - * - id * - version + * - id * - original_item_total * - original_item_subtotal * - original_item_tax_total @@ -673,14 +673,14 @@ * type: string * title: currency_code * description: The order preview's currency code. - * id: - * type: string - * title: id - * description: The order preview's ID. * version: * type: number * title: version * description: The order preview's version. + * id: + * type: string + * title: id + * description: The order preview's ID. * region_id: * type: string * title: region_id @@ -726,6 +726,8 @@ * - balance * - paid_total * - refunded_total + * - pending_difference + * - raw_pending_difference * properties: * total: * oneOf: @@ -937,6 +939,23 @@ * - type: object * description: The summary's refunded total. * x-schemaName: IBigNumber + * pending_difference: + * oneOf: + * - type: string + * title: pending_difference + * description: The summary's pending difference. + * - type: number + * title: pending_difference + * description: The summary's pending difference. + * - type: string + * title: pending_difference + * description: The summary's pending difference. + * - type: object + * description: The summary's pending difference. + * x-schemaName: IBigNumber + * raw_pending_difference: + * type: object + * description: The summary's raw pending difference. * metadata: * type: object * description: The order preview's metadata. diff --git a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts index c14166474e..e6146a4bcf 100644 --- a/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreAddCartLineItem.ts @@ -6,7 +6,6 @@ * required: * - variant_id * - quantity - * - metadata * properties: * variant_id: * type: string diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts index 73f0ad2a01..b9585badee 100644 --- a/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCartLineItem.ts @@ -5,7 +5,6 @@ * x-schemaName: StoreUpdateCartLineItem * required: * - quantity - * - metadata * properties: * quantity: * type: number diff --git a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts index f72ce46ef9..c955692822 100644 --- a/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts +++ b/www/utils/generated/oas-output/schemas/StoreUpdateCustomer.ts @@ -3,11 +3,6 @@ * type: object * description: SUMMARY * x-schemaName: StoreUpdateCustomer - * required: - * - company_name - * - first_name - * - last_name - * - phone * properties: * company_name: * type: string