daea35fe73
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>
8.0 KiB
8.0 KiB
displayed_sidebar
| displayed_sidebar |
|---|
| jsClientSidebar |
Module: internal
Enumerations
- AllocationType
- CartType
- ClaimFulfillmentStatus
- ClaimPaymentStatus
- ClaimReason
- ClaimType
- DiscountConditionOperator
- DiscountConditionType
- DiscountRuleType
- DraftOrderStatus
- FulfillmentStatus
- OrderEditItemChangeType
- OrderEditStatus
- OrderStatus
- PaymentCollectionStatus
- PaymentStatus
- PriceListStatus
- PriceListType
- ProductStatus
- RequirementType
- ReturnStatus
- ShippingOptionPriceType
- ShippingProfileType
- SwapFulfillmentStatus
- SwapPaymentStatus
Classes
- Address
- AdminDeleteProductsFromCollectionReq
- AdminGetCollectionsPaginationParams
- AdminGetCollectionsParams
- AdminPostCollectionsCollectionReq
- AdminPostCollectionsReq
- AdminPostProductsToCollectionReq
- Cart
- ClaimImage
- ClaimItem
- ClaimOrder
- ClaimTag
- Country
- Currency
- Customer
- CustomerGroup
- Discount
- DiscountCondition
- DiscountRule
- DraftOrder
- Fulfillment
- FulfillmentItem
- FulfillmentProvider
- GiftCard
- GiftCardTransaction
- Image
- LineItem
- LineItemAdjustment
- LineItemTaxLine
- MoneyAmount
- Order
- OrderEdit
- OrderItemChange
- Payment
- PaymentCollection
- PaymentProvider
- PaymentSession
- PriceList
- Product
- ProductCategory
- ProductCollection
- ProductOption
- ProductOptionValue
- ProductTag
- ProductType
- ProductVariant
- ProductVariantInventoryItem
- Refund
- Region
- Return
- ReturnItem
- ReturnReason
- SalesChannel
- SalesChannelLocation
- ShippingMethod
- ShippingMethodTaxLine
- ShippingOption
- ShippingOptionRequirement
- ShippingProfile
- Swap
- TaxLine
- TaxProvider
- TaxRate
- TrackingLink
Interfaces
Enumeration Members
ORDER_EDIT
• ORDER_EDIT: "order_edit"
Defined in
packages/medusa/dist/models/payment-collection.d.ts:11
Type Aliases
AdminCollectionsListRes
Ƭ AdminCollectionsListRes: PaginatedResponse & { collections: ProductCollection[] }
Schema
AdminCollectionsListRes type: object required:
- collections
- count
- offset
- limit properties: collections: type: array description: an array of collection details items: $ref: "#/components/schemas/ProductCollection" count: type: integer description: The total number of items available offset: type: integer description: The number of product collections skipped when retrieving the product collections. limit: type: integer description: The number of items per page
Defined in
packages/medusa/dist/api/routes/admin/collections/index.d.ts:32
AdminCollectionsRes
Ƭ AdminCollectionsRes: Object
Schema
AdminCollectionsRes type: object x-expanded-relations: field: collection relations: - products required:
- collection properties: collection: type: "Product Collection details." $ref: "#/components/schemas/ProductCollection"
Type declaration
| Name | Type |
|---|---|
collection |
ProductCollection |
Defined in
packages/medusa/dist/api/routes/admin/collections/index.d.ts:97
AdminDeleteProductsFromCollectionRes
Ƭ AdminDeleteProductsFromCollectionRes: Object
Schema
AdminDeleteProductsFromCollectionRes type: object required:
- id
- object
- removed_products properties: id: type: string description: "The ID of the collection" object: type: string description: "The type of object the removal was executed on" default: product-collection removed_products: description: "The IDs of the products removed from the collection" type: array items: description: "The ID of the Product removed from the Product Collection." type: string
Type declaration
| Name | Type |
|---|---|
id |
string |
object |
string |
removed_products |
string[] |
Defined in
packages/medusa/dist/api/routes/admin/collections/index.d.ts:78
Functions
Boolean
▸ Boolean<T>(value?): boolean
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
value? |
T |
Returns
boolean
Defined in
docs-util/node_modules/typescript/lib/lib.es5.d.ts:553