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"
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
AdminCollectionsRes
AdminCollectionsRes: Object
Schema
AdminCollectionsRes type: object x-expanded-relations: field: collection relations:
required:
- collection properties: collection: type: "Product Collection details." $ref: "#/components/schemas/ProductCollection"
Type declaration
AdminDeleteProductsFromCollectionRes
AdminDeleteProductsFromCollectionRes: Object
Schema
The ID of the collection
Type declaration
id
stringRequiredobject
stringRequiredremoved_products
string[]RequiredFunctions
Boolean
Boolean<T
>(value?
): boolean
T
objectRequiredParameters
value
TReturns
boolean
boolean
booleanWas this section helpful?