docs: TSDoc + reference of fulfillment service (#5761)
This commit is contained in:
@@ -956,99 +956,103 @@ import ParameterTypes from "@site/src/components/ParameterTypes"
|
||||
- [middlewareHandlerType](../internal/types/internal.middlewareHandlerType.mdx)
|
||||
- [middlewareType](../internal/types/internal.middlewareType.mdx)
|
||||
|
||||
___
|
||||
|
||||
## Enumeration Members
|
||||
|
||||
#### DEFAULT
|
||||
### DEFAULT
|
||||
|
||||
___
|
||||
|
||||
#### ORDER\_EDIT
|
||||
### ORDER\_EDIT
|
||||
|
||||
The payment collection is used for an order edit.
|
||||
|
||||
___
|
||||
|
||||
## Variables
|
||||
|
||||
#### AddressRepository
|
||||
### AddressRepository
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetDiscountsParams\_base
|
||||
### AdminGetDiscountsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetInventoryItemsParams\_base
|
||||
### AdminGetInventoryItemsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetPriceListsPriceListProductsParams\_base
|
||||
### AdminGetPriceListsPriceListProductsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetProductCategoriesParams\_base
|
||||
### AdminGetProductCategoriesParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetReservationsParams\_base
|
||||
### AdminGetReservationsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetSalesChannelsParams\_base
|
||||
### AdminGetSalesChannelsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AdminGetStockLocationsParams\_base
|
||||
### AdminGetStockLocationsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### AnalyticsConfigRepository
|
||||
### AnalyticsConfigRepository
|
||||
|
||||
___
|
||||
|
||||
#### BatchJobRepository
|
||||
### BatchJobRepository
|
||||
|
||||
___
|
||||
|
||||
#### Buffer
|
||||
### Buffer
|
||||
|
||||
___
|
||||
|
||||
#### CartRepository
|
||||
### CartRepository
|
||||
|
||||
___
|
||||
|
||||
#### ClaimRepository
|
||||
### ClaimRepository
|
||||
|
||||
___
|
||||
|
||||
#### CountryRepository
|
||||
### CountryRepository
|
||||
|
||||
___
|
||||
|
||||
#### CurrencyRepository
|
||||
### CurrencyRepository
|
||||
|
||||
___
|
||||
|
||||
#### CustomShippingOptionRepository
|
||||
### CustomShippingOptionRepository
|
||||
|
||||
___
|
||||
|
||||
#### CustomerGroupRepository
|
||||
### CustomerGroupRepository
|
||||
|
||||
___
|
||||
|
||||
#### CustomerRepository
|
||||
### CustomerRepository
|
||||
|
||||
___
|
||||
|
||||
#### DiscountConditionRepository
|
||||
### DiscountConditionRepository
|
||||
|
||||
___
|
||||
|
||||
#### DraftOrderRepository
|
||||
### DraftOrderRepository
|
||||
|
||||
___
|
||||
|
||||
#### File
|
||||
### File
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1114,141 +1118,141 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### FulfillmentProviderRepository
|
||||
### FulfillmentProviderRepository
|
||||
|
||||
___
|
||||
|
||||
#### FulfillmentRepository
|
||||
### FulfillmentRepository
|
||||
|
||||
___
|
||||
|
||||
#### GetOrderEditsParams\_base
|
||||
### GetOrderEditsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### GetPublishableApiKeySalesChannelsParams\_base
|
||||
### GetPublishableApiKeySalesChannelsParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### GetPublishableApiKeysParams\_base
|
||||
### GetPublishableApiKeysParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### GiftCardRepository
|
||||
### GiftCardRepository
|
||||
|
||||
___
|
||||
|
||||
#### GiftCardTransactionRepository
|
||||
### GiftCardTransactionRepository
|
||||
|
||||
___
|
||||
|
||||
#### HTTP\_METHODS
|
||||
### HTTP\_METHODS
|
||||
|
||||
List of all the supported HTTP methods
|
||||
|
||||
___
|
||||
|
||||
#### IdempotencyKeyRepository
|
||||
### IdempotencyKeyRepository
|
||||
|
||||
___
|
||||
|
||||
#### ImageRepository
|
||||
### ImageRepository
|
||||
|
||||
___
|
||||
|
||||
#### LineItemAdjustmentRepository
|
||||
### LineItemAdjustmentRepository
|
||||
|
||||
___
|
||||
|
||||
#### LineItemRepository
|
||||
### LineItemRepository
|
||||
|
||||
___
|
||||
|
||||
#### LineItemTaxLineRepository
|
||||
### LineItemTaxLineRepository
|
||||
|
||||
___
|
||||
|
||||
#### MoneyAmountRepository
|
||||
### MoneyAmountRepository
|
||||
|
||||
___
|
||||
|
||||
#### NoteRepository
|
||||
### NoteRepository
|
||||
|
||||
___
|
||||
|
||||
#### NotificationProviderRepository
|
||||
### NotificationProviderRepository
|
||||
|
||||
___
|
||||
|
||||
#### NotificationRepository
|
||||
### NotificationRepository
|
||||
|
||||
___
|
||||
|
||||
#### OauthRepository
|
||||
### OauthRepository
|
||||
|
||||
___
|
||||
|
||||
#### OrderEditRepository
|
||||
### OrderEditRepository
|
||||
|
||||
___
|
||||
|
||||
#### OrderItemChangeRepository
|
||||
### OrderItemChangeRepository
|
||||
|
||||
___
|
||||
|
||||
#### OrderRepository
|
||||
### OrderRepository
|
||||
|
||||
___
|
||||
|
||||
#### PaymentCollectionRepository
|
||||
### PaymentCollectionRepository
|
||||
|
||||
___
|
||||
|
||||
#### PaymentProviderRepository
|
||||
### PaymentProviderRepository
|
||||
|
||||
___
|
||||
|
||||
#### PaymentRepository
|
||||
### PaymentRepository
|
||||
|
||||
___
|
||||
|
||||
#### PaymentSessionRepository
|
||||
### PaymentSessionRepository
|
||||
|
||||
___
|
||||
|
||||
#### PriceListRepository
|
||||
### PriceListRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductCategoryRepository
|
||||
### ProductCategoryRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductCollectionRepository
|
||||
### ProductCollectionRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductOptionRepository
|
||||
### ProductOptionRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductRepository
|
||||
### ProductRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductTagRepository
|
||||
### ProductTagRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductTypeRepository
|
||||
### ProductTypeRepository
|
||||
|
||||
___
|
||||
|
||||
#### ProductVariantRepository
|
||||
### ProductVariantRepository
|
||||
|
||||
___
|
||||
|
||||
#### ReadableByteStreamController
|
||||
### ReadableByteStreamController
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1282,7 +1286,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableByteStreamController
|
||||
### ReadableByteStreamController
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1316,7 +1320,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStream
|
||||
### ReadableStream
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1462,7 +1466,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStream
|
||||
### ReadableStream
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1560,7 +1564,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamBYOBReader
|
||||
### ReadableStreamBYOBReader
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1608,11 +1612,11 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamBYOBReader
|
||||
### ReadableStreamBYOBReader
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamBYOBRequest
|
||||
### ReadableStreamBYOBRequest
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1646,7 +1650,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamDefaultController
|
||||
### ReadableStreamDefaultController
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1680,7 +1684,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamDefaultController
|
||||
### ReadableStreamDefaultController
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1714,7 +1718,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamDefaultReader
|
||||
### ReadableStreamDefaultReader
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1762,7 +1766,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### ReadableStreamDefaultReader
|
||||
### ReadableStreamDefaultReader
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1810,79 +1814,79 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### RefundRepository
|
||||
### RefundRepository
|
||||
|
||||
___
|
||||
|
||||
#### RegionRepository
|
||||
### RegionRepository
|
||||
|
||||
___
|
||||
|
||||
#### ReturnItemRepository
|
||||
### ReturnItemRepository
|
||||
|
||||
___
|
||||
|
||||
#### ReturnReasonRepository
|
||||
### ReturnReasonRepository
|
||||
|
||||
___
|
||||
|
||||
#### ReturnRepository
|
||||
### ReturnRepository
|
||||
|
||||
___
|
||||
|
||||
#### SalesChannelRepository
|
||||
### SalesChannelRepository
|
||||
|
||||
___
|
||||
|
||||
#### SharedArrayBuffer
|
||||
### SharedArrayBuffer
|
||||
|
||||
___
|
||||
|
||||
#### ShippingMethodRepository
|
||||
### ShippingMethodRepository
|
||||
|
||||
___
|
||||
|
||||
#### ShippingOptionRepository
|
||||
### ShippingOptionRepository
|
||||
|
||||
___
|
||||
|
||||
#### ShippingOptionRequirementRepository
|
||||
### ShippingOptionRequirementRepository
|
||||
|
||||
___
|
||||
|
||||
#### ShippingProfileRepository
|
||||
### ShippingProfileRepository
|
||||
|
||||
___
|
||||
|
||||
#### StagedJobRepository
|
||||
### StagedJobRepository
|
||||
|
||||
___
|
||||
|
||||
#### StoreGetProductCategoriesParams\_base
|
||||
### StoreGetProductCategoriesParams\_base
|
||||
|
||||
___
|
||||
|
||||
#### StoreRepository
|
||||
### StoreRepository
|
||||
|
||||
___
|
||||
|
||||
#### SwapRepository
|
||||
### SwapRepository
|
||||
|
||||
___
|
||||
|
||||
#### TaxProviderRepository
|
||||
### TaxProviderRepository
|
||||
|
||||
___
|
||||
|
||||
#### TrackingLinkRepository
|
||||
### TrackingLinkRepository
|
||||
|
||||
___
|
||||
|
||||
#### UserRepository
|
||||
### UserRepository
|
||||
|
||||
___
|
||||
|
||||
#### WritableStream
|
||||
### WritableStream
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1939,7 +1943,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### WritableStream
|
||||
### WritableStream
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -1996,7 +2000,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### WritableStreamDefaultController
|
||||
### WritableStreamDefaultController
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -2030,7 +2034,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### WritableStreamDefaultController
|
||||
### WritableStreamDefaultController
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -2064,7 +2068,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### WritableStreamDefaultWriter
|
||||
### WritableStreamDefaultWriter
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -2112,7 +2116,7 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### WritableStreamDefaultWriter
|
||||
### WritableStreamDefaultWriter
|
||||
|
||||
#### Call signature
|
||||
|
||||
@@ -2158,11 +2162,13 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
___
|
||||
|
||||
## Functions
|
||||
|
||||
#### Boolean
|
||||
### Boolean
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2176,7 +2182,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2192,9 +2198,9 @@ ___
|
||||
|
||||
___
|
||||
|
||||
#### Error
|
||||
### Error
|
||||
|
||||
##### Parameters
|
||||
#### Parameters
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
@@ -2208,7 +2214,7 @@ ___
|
||||
}
|
||||
]} />
|
||||
|
||||
##### Returns
|
||||
#### Returns
|
||||
|
||||
<ParameterTypes parameters={[
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user