---
displayed_sidebar: jsClientSidebar
---

# Module: internal

## Enumerations

- [AllocationType](../enums/internal-3.AllocationType.md)
- [CartType](../enums/internal-3.CartType.md)
- [ClaimFulfillmentStatus](../enums/internal-3.ClaimFulfillmentStatus.md)
- [ClaimPaymentStatus](../enums/internal-3.ClaimPaymentStatus.md)
- [ClaimReason](../enums/internal-3.ClaimReason.md)
- [ClaimType](../enums/internal-3.ClaimType.md)
- [DiscountConditionOperator](../enums/internal-3.DiscountConditionOperator.md)
- [DiscountConditionType](../enums/internal-3.DiscountConditionType.md)
- [DiscountRuleType](../enums/internal-3.DiscountRuleType.md)
- [DraftOrderStatus](../enums/internal-3.DraftOrderStatus.md)
- [FulfillmentStatus](../enums/internal-3.FulfillmentStatus.md)
- [OrderEditItemChangeType](../enums/internal-3.OrderEditItemChangeType.md)
- [OrderEditStatus](../enums/internal-3.OrderEditStatus.md)
- [OrderStatus](../enums/internal-3.OrderStatus.md)
- [PaymentCollectionStatus](../enums/internal-3.PaymentCollectionStatus.md)
- [PaymentStatus](../enums/internal-3.PaymentStatus.md)
- [PriceListStatus](../enums/internal-3.PriceListStatus.md)
- [PriceListType](../enums/internal-3.PriceListType.md)
- [ProductStatus](../enums/internal-3.ProductStatus.md)
- [RequirementType](../enums/internal-3.RequirementType.md)
- [ReturnStatus](../enums/internal-3.ReturnStatus.md)
- [ShippingOptionPriceType](../enums/internal-3.ShippingOptionPriceType.md)
- [ShippingProfileType](../enums/internal-3.ShippingProfileType.md)
- [SwapFulfillmentStatus](../enums/internal-3.SwapFulfillmentStatus.md)
- [SwapPaymentStatus](../enums/internal-3.SwapPaymentStatus.md)

## Classes

- [Address](../classes/internal-3.Address.md)
- [AdminDeleteProductsFromCollectionReq](../classes/internal-3.AdminDeleteProductsFromCollectionReq.md)
- [AdminGetCollectionsPaginationParams](../classes/internal-3.AdminGetCollectionsPaginationParams.md)
- [AdminGetCollectionsParams](../classes/internal-3.AdminGetCollectionsParams.md)
- [AdminPostCollectionsCollectionReq](../classes/internal-3.AdminPostCollectionsCollectionReq.md)
- [AdminPostCollectionsReq](../classes/internal-3.AdminPostCollectionsReq.md)
- [AdminPostProductsToCollectionReq](../classes/internal-3.AdminPostProductsToCollectionReq.md)
- [Cart](../classes/internal-3.Cart.md)
- [ClaimImage](../classes/internal-3.ClaimImage.md)
- [ClaimItem](../classes/internal-3.ClaimItem.md)
- [ClaimOrder](../classes/internal-3.ClaimOrder.md)
- [ClaimTag](../classes/internal-3.ClaimTag.md)
- [Country](../classes/internal-3.Country.md)
- [Currency](../classes/internal-3.Currency.md)
- [Customer](../classes/internal-3.Customer.md)
- [CustomerGroup](../classes/internal-3.CustomerGroup.md)
- [Discount](../classes/internal-3.Discount.md)
- [DiscountCondition](../classes/internal-3.DiscountCondition.md)
- [DiscountRule](../classes/internal-3.DiscountRule.md)
- [DraftOrder](../classes/internal-3.DraftOrder.md)
- [Fulfillment](../classes/internal-3.Fulfillment.md)
- [FulfillmentItem](../classes/internal-3.FulfillmentItem.md)
- [FulfillmentProvider](../classes/internal-3.FulfillmentProvider.md)
- [GiftCard](../classes/internal-3.GiftCard.md)
- [GiftCardTransaction](../classes/internal-3.GiftCardTransaction.md)
- [Image](../classes/internal-3.Image.md)
- [LineItem](../classes/internal-3.LineItem.md)
- [LineItemAdjustment](../classes/internal-3.LineItemAdjustment.md)
- [LineItemTaxLine](../classes/internal-3.LineItemTaxLine.md)
- [MoneyAmount](../classes/internal-3.MoneyAmount.md)
- [Order](../classes/internal-3.Order.md)
- [OrderEdit](../classes/internal-3.OrderEdit.md)
- [OrderItemChange](../classes/internal-3.OrderItemChange.md)
- [Payment](../classes/internal-3.Payment.md)
- [PaymentCollection](../classes/internal-3.PaymentCollection.md)
- [PaymentProvider](../classes/internal-3.PaymentProvider.md)
- [PaymentSession](../classes/internal-3.PaymentSession.md)
- [PriceList](../classes/internal-3.PriceList.md)
- [Product](../classes/internal-3.Product.md)
- [ProductCategory](../classes/internal-3.ProductCategory.md)
- [ProductCollection](../classes/internal-3.ProductCollection.md)
- [ProductOption](../classes/internal-3.ProductOption.md)
- [ProductOptionValue](../classes/internal-3.ProductOptionValue.md)
- [ProductTag](../classes/internal-3.ProductTag.md)
- [ProductType](../classes/internal-3.ProductType.md)
- [ProductVariant](../classes/internal-3.ProductVariant.md)
- [ProductVariantInventoryItem](../classes/internal-3.ProductVariantInventoryItem.md)
- [Refund](../classes/internal-3.Refund.md)
- [Region](../classes/internal-3.Region.md)
- [Return](../classes/internal-3.Return.md)
- [ReturnItem](../classes/internal-3.ReturnItem.md)
- [ReturnReason](../classes/internal-3.ReturnReason.md)
- [SalesChannel](../classes/internal-3.SalesChannel.md)
- [SalesChannelLocation](../classes/internal-3.SalesChannelLocation.md)
- [ShippingMethod](../classes/internal-3.ShippingMethod.md)
- [ShippingMethodTaxLine](../classes/internal-3.ShippingMethodTaxLine.md)
- [ShippingOption](../classes/internal-3.ShippingOption.md)
- [ShippingOptionRequirement](../classes/internal-3.ShippingOptionRequirement.md)
- [ShippingProfile](../classes/internal-3.ShippingProfile.md)
- [Swap](../classes/internal-3.Swap.md)
- [TaxLine](../classes/internal-3.TaxLine.md)
- [TaxProvider](../classes/internal-3.TaxProvider.md)
- [TaxRate](../classes/internal-3.TaxRate.md)
- [TrackingLink](../classes/internal-3.TrackingLink.md)

## Interfaces

- [Boolean](../interfaces/internal-3.Boolean.md)

## Enumeration Members

### ORDER\_EDIT

• **ORDER\_EDIT**: ``"order_edit"``

#### Defined in

packages/medusa/dist/models/payment-collection.d.ts:11

## Type Aliases

### AdminCollectionsListRes

Ƭ **AdminCollectionsListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `collections`: [`ProductCollection`](../classes/internal-3.ProductCollection.md)[]  }

**`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`](../classes/internal-3.ProductCollection.md) |

#### 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