Shahed Nasser 9372a17d1f docs: generate API reference for 2.12.0 (#14185)

2025-12-02 11:56:37 +02:00

..

AdminAddClaimItems.yaml

…

AdminAddClaimOutboundItems.yaml

…

AdminAddDraftOrderItems.yaml

…

AdminAddDraftOrderPromotions.yaml

…

AdminAddDraftOrderShippingMethod.yaml

…

AdminAddExchangeInboundItems.yaml

…

AdminAddExchangeOutboundItems.yaml

…

AdminAddReturnItem.yaml

…

AdminAddReturnItems.yaml

…

AdminAddReturnShipping.yaml

…

AdminApiKey.yaml

…

AdminApiKeyResponse.yaml

…

AdminApplicationMethod.yaml

…

AdminBatchCreateInventoryItemLocationLevels.yaml

…

AdminBatchCreateInventoryItemsLocationLevels.yaml

…

AdminBatchImageVariantRequest.yaml

…

AdminBatchImageVariantResponse.yaml

…

AdminBatchInventoryItemLocationsLevel.yaml

…

AdminBatchInventoryItemsLocationLevels.yaml

…

AdminBatchInventoryItemsLocationLevelsResponse.yaml

…

AdminBatchLink.yaml

…

AdminBatchProductRequest.yaml

…

AdminBatchProductResponse.yaml

…

AdminBatchProductVariantRequest.yaml

…

AdminBatchProductVariantResponse.yaml

…

AdminBatchUpdateInventoryItemsLocationLevels.yaml

…

AdminBatchUpdateProduct.yaml

…

AdminBatchUpdateProductVariant.yaml

…

AdminBatchVariantImagesRequest.yaml

…

AdminBatchVariantImagesResponse.yaml

…

AdminCampaign.yaml

…

AdminCampaignResponse.yaml

…

AdminCapturePayment.yaml

…

AdminClaim.yaml

…

AdminClaimAddOutboundShipping.yaml

…

AdminClaimDeleteResponse.yaml

…

AdminClaimListResponse.yaml

…

AdminClaimOrderResponse.yaml

…

AdminClaimPreviewResponse.yaml

…

AdminClaimRequestResponse.yaml

…

AdminClaimResponse.yaml

…

AdminClaimReturnPreviewResponse.yaml

…

AdminClaimUpdateInboundShipping.yaml

…

AdminClaimUpdateOutboundShipping.yaml

…

AdminCollection.yaml

…

AdminCollectionDeleteResponse.yaml

…

AdminCollectionListResponse.yaml

…

AdminCollectionResponse.yaml

…

AdminColumn.yaml

…

AdminConfirmReceiveReturn.yaml

…

AdminConfirmReturnRequest.yaml

…

AdminCreateApiKey.yaml

…

AdminCreateCalculatedShippingOption.yaml

…

AdminCreateClaim.yaml

…

AdminCreateCustomerGroup.yaml

…

AdminCreateExchange.yaml

…

AdminCreateFlatRateShippingOption.yaml

…

AdminCreateFulfillment.yaml

…

AdminCreateFulfillmentItem.yaml

…

AdminCreateFulfillmentLabel.yaml

…

AdminCreateFulfillmentSetServiceZone.yaml

…

AdminCreateFulfillmentShipment.yaml

…

AdminCreateGiftCardParams.yaml

…

AdminCreateInventoryItem.yaml

…

AdminCreateOrderCreditLine.yaml

…

AdminCreatePaymentCollection.yaml

…

AdminCreatePriceList.yaml

…

AdminCreatePriceListPrice.yaml

…

AdminCreatePricePreference.yaml

…

AdminCreateProduct.yaml

…

AdminCreateProductCategory.yaml

…

AdminCreateProductOption.yaml

…

AdminCreateProductTag.yaml

…

AdminCreateProductType.yaml

…

AdminCreateProductVariant.yaml

…

AdminCreateProductVariantInventoryKit.yaml

…

AdminCreateProductVariantPrice.yaml

…

AdminCreatePromotionRule.yaml

…

AdminCreateRefundReason.yaml

…

AdminCreateRegion.yaml

…

AdminCreateReservation.yaml

…

AdminCreateReturnReason.yaml

…

AdminCreateSalesChannel.yaml

…

AdminCreateShippingOptionRule.yaml

…

AdminCreateShippingOptionType.yaml

…

AdminCreateShippingProfile.yaml

…

AdminCreateStockLocation.yaml

…

AdminCreateStockLocationFulfillmentSet.yaml

…

AdminCreateStoreCreditAccount.yaml

…

AdminCreateTaxRate.yaml

…

AdminCreateTaxRateRule.yaml

…

AdminCreateTaxRegion.yaml

…

AdminCreateVariantInventoryItem.yaml

…

AdminCreateViewConfiguration.yaml

…

AdminCreateWorkflowsAsyncResponse.yaml

…

AdminCreateWorkflowsRun.yaml

…

AdminCurrency.yaml

…

AdminCurrencyListResponse.yaml

…

AdminCurrencyResponse.yaml

…

AdminCustomer.yaml

…

AdminCustomerAddress.yaml

…

AdminCustomerAddressResponse.yaml

…

AdminCustomerGroup.yaml

…

AdminCustomerGroupResponse.yaml

…

AdminCustomerInGroupFilters.yaml

…

AdminCustomerResponse.yaml

…

AdminDeletePaymentCollectionResponse.yaml

…

AdminDismissItems.yaml

…

AdminDraftOrder.yaml

…

AdminDraftOrderListResponse.yaml

…

AdminDraftOrderParams.yaml

…

AdminDraftOrderPreview.yaml

…

AdminDraftOrderPreviewResponse.yaml

…

AdminDraftOrderResponse.yaml

…

AdminExchange.yaml

…

AdminExchangeAddOutboundShipping.yaml

…

AdminExchangeDeleteResponse.yaml

…

AdminExchangeOrderResponse.yaml

…

AdminExchangePreviewResponse.yaml

…

AdminExchangeRequestResponse.yaml

…

AdminExchangeResponse.yaml

…

AdminExchangeReturnResponse.yaml

…

AdminExchangeUpdateInboundShipping.yaml

…

AdminExchangeUpdateOutboundShipping.yaml

…

AdminExportProductResponse.yaml

…

AdminFile.yaml

…

AdminFileListResponse.yaml

…

AdminFileResponse.yaml

…

AdminFulfillment.yaml

…

AdminFulfillmentAddress.yaml

…

AdminFulfillmentDeliveryAddress.yaml

…

AdminFulfillmentItem.yaml

…

AdminFulfillmentLabel.yaml

…

AdminFulfillmentProvider.yaml

…

AdminFulfillmentProviderListResponse.yaml

…

AdminFulfillmentProviderOption.yaml

…

AdminFulfillmentProviderOptionsListResponse.yaml

…

AdminFulfillmentResponse.yaml

…

AdminFulfillmentSet.yaml

…

AdminFulfillmentSetDeleteResponse.yaml

…

AdminFulfillmentSetResponse.yaml

…

AdminGeoZone.yaml

…

AdminGiftCard.yaml

…

AdminGiftCardResponse.yaml

…

AdminGiftCardsResponse.yaml

…

AdminImportProductRequest.yaml

…

AdminImportProductResponse.yaml

…

AdminImportProducts.yaml

…

AdminIndexDetailsResponse.yaml

…

AdminIndexSyncPayload.yaml

…

AdminInitiateReceiveReturn.yaml

…

AdminInitiateReturnRequest.yaml

…

AdminInventoryItem.yaml

…

AdminInventoryItemResponse.yaml

…

AdminInventoryLevel.yaml

…

AdminInvite.yaml

…

AdminInviteAccept.yaml

…

AdminInviteResponse.yaml

…

AdminLinkPriceListProducts.yaml

…

AdminMarkPaymentCollectionAsPaid.yaml

…

AdminNotification.yaml

…

AdminNotificationListResponse.yaml

…

AdminNotificationResponse.yaml

…

AdminOrder.yaml

…

AdminOrderAddress.yaml

…

AdminOrderChange.yaml

…

AdminOrderChangeAction.yaml

…

AdminOrderChangeResponse.yaml

…

AdminOrderChangesResponse.yaml

…

AdminOrderEditPreviewResponse.yaml

…

AdminOrderEditResponse.yaml

…

AdminOrderFulfillment.yaml

…

AdminOrderItem.yaml

…

AdminOrderLineItem.yaml

…

AdminOrderPreview.yaml

…

AdminOrderPreviewResponse.yaml

…

AdminOrderResponse.yaml

…

AdminOrderReturnResponse.yaml

…

AdminOrderShippingMethod.yaml

…

AdminPayment.yaml

…

AdminPaymentCollection.yaml

…

AdminPaymentCollectionResponse.yaml

…

AdminPaymentProvider.yaml

…

AdminPaymentResponse.yaml

…

AdminPaymentSession.yaml

…

AdminPlugin.yaml

…

AdminPluginsListResponse.yaml

…

AdminPostCancelClaimReqSchema.yaml

…

AdminPostCancelExchangeReqSchema.yaml

…

AdminPostCancelReturnReqSchema.yaml

…

AdminPostExchangesRequestItemsReturnActionReqSchema.yaml

…

AdminPostOrderEditsAddItemsReqSchema.yaml

…

AdminPostOrderEditsItemsActionReqSchema.yaml

…

AdminPostOrderEditsReqSchema.yaml

…

AdminPostOrderEditsShippingActionReqSchema.yaml

…

AdminPostOrderEditsShippingReqSchema.yaml

…

AdminPostOrderEditsUpdateItemQuantityReqSchema.yaml

…

AdminPostReturnsDismissItemsActionReqSchema.yaml

…

AdminPostReturnsReceiveItemsActionReqSchema.yaml

…

AdminPostReturnsRequestItemsActionReqSchema.yaml

…

AdminPostReturnsRequestItemsReqSchema.yaml

…

AdminPostReturnsShippingReqSchema.yaml

…

AdminPrice.yaml

…

AdminPriceList.yaml

…

AdminPriceListBatchResponse.yaml

…

AdminPriceListDeleteResponse.yaml

…

AdminPriceListListResponse.yaml

…

AdminPriceListPrice.yaml

…

AdminPriceListResponse.yaml

…

AdminPricePreference.yaml

…

AdminPricePreferenceDeleteResponse.yaml

…

AdminPricePreferenceListResponse.yaml

…

AdminPricePreferenceResponse.yaml

…

AdminProduct.yaml

…

AdminProductCategory.yaml

…

AdminProductCategoryDeleteResponse.yaml

…

AdminProductCategoryListResponse.yaml

…

AdminProductCategoryResponse.yaml

…

AdminProductDeleteResponse.yaml

…

AdminProductImage.yaml

…

AdminProductOption.yaml

…

AdminProductOptionDeleteResponse.yaml

…

AdminProductOptionResponse.yaml

…

AdminProductOptionValue.yaml

…

AdminProductResponse.yaml

…

AdminProductTag.yaml

…

AdminProductTagDeleteResponse.yaml

…

AdminProductTagListResponse.yaml

…

AdminProductTagResponse.yaml

…

AdminProductType.yaml

…

AdminProductTypeDeleteResponse.yaml

…

AdminProductTypeListResponse.yaml

…

AdminProductTypeResponse.yaml

…

AdminProductVariant.yaml

…

AdminProductVariantDeleteResponse.yaml

…

AdminProductVariantInventoryBatchResponse.yaml

…

AdminProductVariantInventoryItemLink.yaml

…

AdminProductVariantInventoryLink.yaml

…

AdminProductVariantInventoryLinkDeleteResponse.yaml

…

AdminProductVariantResponse.yaml

…

AdminPromotion.yaml

…

AdminPromotionResponse.yaml

…

AdminPromotionRule.yaml

…

AdminReceiveItems.yaml

…

AdminRedeemGiftCard.yaml

…

AdminRefund.yaml

…

AdminRefundPayment.yaml

…

AdminRefundReason.yaml

…

AdminRefundReasonDeleteResponse.yaml

…

AdminRegion.yaml

…

AdminRegionCountry.yaml

…

AdminRegionResponse.yaml

…

AdminRemoveDraftOrderPromotions.yaml

…

AdminRequestOrderTransfer.yaml

…

AdminReservation.yaml

…

AdminReservationResponse.yaml

…

AdminReturn.yaml

…

AdminReturnItem.yaml

…

AdminReturnPreviewResponse.yaml

…

AdminReturnReason.yaml

…

AdminReturnReasonDeleteResponse.yaml

…

AdminReturnReasonListResponse.yaml

…

AdminReturnReasonResponse.yaml

…

AdminReturnResponse.yaml

…

AdminRevokeApiKey.yaml

…

AdminRuleAttributeOption.yaml

…

AdminRuleValueOption.yaml

…

AdminSalesChannel.yaml

…

AdminSalesChannelDeleteResponse.yaml

…

AdminSalesChannelResponse.yaml

…

AdminServiceZone.yaml

…

AdminServiceZoneDeleteResponse.yaml

…

AdminServiceZoneResponse.yaml

…

AdminSetActiveViewConfiguration.yaml

…

AdminShippingOption.yaml

…

AdminShippingOptionDeleteResponse.yaml

…

AdminShippingOptionPrice.yaml

…

AdminShippingOptionPriceRule.yaml

…

AdminShippingOptionResponse.yaml

…

AdminShippingOptionRule.yaml

…

AdminShippingOptionType.yaml

…

AdminShippingOptionTypeDeleteResponse.yaml

…

AdminShippingOptionTypeListResponse.yaml

…

AdminShippingOptionTypeResponse.yaml

…

AdminShippingProfile.yaml

…

AdminShippingProfileDeleteResponse.yaml

…

AdminShippingProfileResponse.yaml

…

AdminStockLocation.yaml

…

AdminStockLocationAddress.yaml

…

AdminStockLocationDeleteResponse.yaml

…

AdminStockLocationListResponse.yaml

…

AdminStockLocationResponse.yaml

…

AdminStore.yaml

…

AdminStoreCreditAccount.yaml

…

AdminStoreCreditAccountResponse.yaml

…

AdminStoreCreditAccountsResponse.yaml

…

AdminStoreCurrency.yaml

…

AdminStoreListResponse.yaml

…

AdminStoreResponse.yaml

…

AdminTaxProvider.yaml

…

AdminTaxRate.yaml

…

AdminTaxRateDeleteResponse.yaml

…

AdminTaxRateResponse.yaml

…

AdminTaxRateRule.yaml

…

AdminTaxRegion.yaml

…

AdminTaxRegionDeleteResponse.yaml

…

AdminTaxRegionResponse.yaml

…

AdminTransaction.yaml

…

AdminTransactionGroup.yaml

…

AdminTransactionGroupsResponse.yaml

…

AdminTransactionsResponse.yaml

…

AdminUpdateApiKey.yaml

…

AdminUpdateClaimItem.yaml

…

AdminUpdateClaimOutboundItem.yaml

…

AdminUpdateCustomerGroup.yaml

…

AdminUpdateDraftOrder.yaml

…

AdminUpdateDraftOrderActionShippingMethod.yaml

…

AdminUpdateDraftOrderItem.yaml

…

AdminUpdateDraftOrderShippingMethod.yaml

…

AdminUpdateExchangeOutboundItem.yaml

…

AdminUpdateFulfillmentSetServiceZone.yaml

…

AdminUpdateGiftCardParams.yaml

…

AdminUpdateInventoryItem.yaml

…

AdminUpdateInventoryLevel.yaml

…

AdminUpdateOrder.yaml

…

AdminUpdateOrderChange.yaml

…

AdminUpdatePriceList.yaml

…

AdminUpdatePricePreference.yaml

…

AdminUpdateProduct.yaml

…

AdminUpdateProductCategory.yaml

…

AdminUpdateProductOption.yaml

…

AdminUpdateProductTag.yaml

…

AdminUpdateProductType.yaml

…

AdminUpdateProductVariant.yaml

…

AdminUpdatePromotionRule.yaml

…

AdminUpdateRefundReason.yaml

…

AdminUpdateRegion.yaml

…

AdminUpdateReservation.yaml

…

AdminUpdateReturnItems.yaml

…

AdminUpdateReturnReason.yaml

…

AdminUpdateReturnRequest.yaml

…

AdminUpdateReturnShipping.yaml

…

AdminUpdateSalesChannel.yaml

…

AdminUpdateShippingOption.yaml

…

AdminUpdateShippingOptionRule.yaml

…

AdminUpdateShippingOptionType.yaml

…

AdminUpdateShippingProfile.yaml

…

AdminUpdateStockLocation.yaml

…

AdminUpdateStore.yaml

…

AdminUpdateStoreSupportedCurrency.yaml

…

AdminUpdateTaxRate.yaml

…

AdminUpdateTaxRegion.yaml

…

AdminUpdateUser.yaml

…

AdminUpdateVariantInventoryItem.yaml

…

AdminUpdateViewConfiguration.yaml

…

AdminUploadPreSignedUrl.yaml

…

AdminUploadPreSignedUrlResponse.yaml

…

AdminUpsertStockLocationAddress.yaml

…

AdminUser.yaml

…

AdminUserDeleteResponse.yaml

…

AdminUserListResponse.yaml

…

AdminUserResponse.yaml

…

AdminViewConfiguration.yaml

…

AdminViewConfigurationResponse.yaml

…

AdminViewsEntityColumnsResponse.yaml

…

AdminWorkflowExecution.yaml

…

AdminWorkflowExecutionExecution.yaml

…

AdminWorkflowExecutionResponse.yaml

…

ApiKeyResponse.yaml

…

AuthAdminSessionResponse.yaml

…

AuthCallbackResponse.yaml

…

AuthResponse.yaml

…

AuthStoreSessionResponse.yaml

…

BaseCalculatedPriceSet.yaml

…

BaseCapture.yaml

…

BaseCart.yaml

…

BaseCartAddress.yaml

…

BaseCartLineItem.yaml

…

BaseCartShippingMethod.yaml

…

BaseClaimItem.yaml

…

BaseCollection.yaml

…

BaseExchangeItem.yaml

…

BaseFulfillmentProvider.yaml

…

BaseLineItemAdjustment.yaml

…

BaseLineItemTaxLine.yaml

…

BaseOrder.yaml

…

BaseOrderAddress.yaml

…

BaseOrderFulfillment.yaml

…

BaseOrderItemDetail.yaml

…

BaseOrderLineItem.yaml

…

BaseOrderLineItemAdjustment.yaml

…

BaseOrderLineItemTaxLine.yaml

…

BaseOrderShippingDetail.yaml

…

BaseOrderShippingMethod.yaml

…

BaseOrderShippingMethodAdjustment.yaml

…

BaseOrderShippingMethodTaxLine.yaml

…

BaseOrderSummary.yaml

…

BaseOrderTransaction.yaml

…

BasePayment.yaml

…

BasePaymentCollection.yaml

…

BasePaymentProvider.yaml

…

BasePaymentSession.yaml

…

BaseProduct.yaml

…

BaseProductCategory.yaml

…

BaseProductImage.yaml

…

BaseProductOption.yaml

…

BaseProductOptionValue.yaml

…

BaseProductTag.yaml

…

BaseProductType.yaml

…

BaseProductVariant.yaml

…

BasePromotionRuleValue.yaml

…

BaseRefund.yaml

…

BaseRefundReason.yaml

…

BaseRegion.yaml

…

BaseRegionCountry.yaml

…

BaseRuleOperatorOptions.yaml

…

BaseShippingMethodAdjustment.yaml

…

BaseShippingMethodTaxLine.yaml

…

CampaignResponse.yaml

…

CreateAddress.yaml

…

CustomerGroupInCustomerFilters.yaml

…

Error.yaml

…

IndexInfo.yaml

…

InventoryLevel.yaml

…

Order.yaml

…

OrderAddress.yaml

…

OrderChange.yaml

…

OrderChangeAction.yaml

…

OrderClaim.yaml

…

OrderCreditLine.yaml

…

OrderExchange.yaml

…

OrderItem.yaml

…

OrderLineItem.yaml

…

OrderLineItemAdjustment.yaml

…

OrderLineItemTaxLine.yaml

…

OrderReturnItem.yaml

…

OrderShippingMethod.yaml

…

OrderShippingMethodAdjustment.yaml

…

OrderShippingMethodTaxLine.yaml

…

OrderTransaction.yaml

…

RefundReasonResponse.yaml

…

Return.yaml

…

StoreAcceptOrderTransfer.yaml

…

StoreAddGiftCardToCart.yaml

…

StoreAddStoreCreditsToCart.yaml

…

StoreCalculatedPrice.yaml

…

StoreCart.yaml

…

StoreCartAddPromotion.yaml

…

StoreCartAddress.yaml

…

StoreCartLineItem.yaml

…

StoreCartPromotion.yaml

…

StoreCartRemovePromotion.yaml

…

StoreCartResponse.yaml

…

StoreCartShippingMethod.yaml

…

StoreCartShippingOption.yaml

…

StoreCollection.yaml

…

StoreCollectionResponse.yaml

…

StoreCreateCart.yaml

…

StoreCreateCustomer.yaml

…

StoreCreateCustomerAddress.yaml

…

StoreCreatePaymentCollection.yaml

…

StoreCreateReturn.yaml

…

StoreCreateReturnItem.yaml

…

StoreCreateReturnShipping.yaml

…

StoreCurrency.yaml

…

StoreCurrencyListResponse.yaml

…

StoreCurrencyResponse.yaml

…

StoreCustomer.yaml

…

StoreCustomerAddress.yaml

…

StoreCustomerAddressListResponse.yaml

…

StoreCustomerAddressResponse.yaml

…

StoreCustomerResponse.yaml

…

StoreDeclineOrderTransfer.yaml

…

StoreGiftCard.yaml

…

StoreGiftCardResponse.yaml

…

StoreInitializePaymentSession.yaml

…

StoreOrder.yaml

…

StoreOrderAddress.yaml

…

StoreOrderFulfillment.yaml

…

StoreOrderLineItem.yaml

…

StoreOrderResponse.yaml

…

StoreOrderShippingMethod.yaml

…

StorePaymentCollection.yaml

…

StorePaymentCollectionResponse.yaml

…

StorePaymentProvider.yaml

…

StorePaymentSession.yaml

…

StorePrice.yaml

…

StorePriceRule.yaml

…

StoreProduct.yaml

…

StoreProductCategory.yaml

…

StoreProductCategoryListResponse.yaml

…

StoreProductCategoryResponse.yaml

…

StoreProductImage.yaml

…

StoreProductOption.yaml

…

StoreProductOptionValue.yaml

…

StoreProductResponse.yaml

…

StoreProductTag.yaml

…

StoreProductTagListResponse.yaml

…

StoreProductTagResponse.yaml

…

StoreProductType.yaml

…

StoreProductTypeListResponse.yaml

…

StoreProductTypeResponse.yaml

…

StoreProductVariant.yaml

…

StoreRegion.yaml

…

StoreRegionCountry.yaml

…

StoreRemoveGiftCardFromCart.yaml

…

StoreRequestOrderTransfer.yaml

…

StoreReturn.yaml

…

StoreReturnItem.yaml

…

StoreReturnReason.yaml

…

StoreReturnReasonResponse.yaml

…

StoreReturnResponse.yaml

…

StoreShippingOption.yaml

…

StoreShippingOptionListResponse.yaml

…

StoreShippingOptionResponse.yaml

…

StoreShippingOptionType.yaml

…

StoreStoreCreditAccount.yaml

…

StoreStoreCreditAccountResponse.yaml

…

StoreStoreCreditAccountsResponse.yaml

…

StoreTransactionGroup.yaml

…

StoreUpdateCustomer.yaml

…

StoreUpdateCustomerAddress.yaml

…

UpdateAddress.yaml

…

UpdateCartData.yaml

…

WorkflowExecutionContext.yaml

…