liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,580 lines • 51.4 kB
TypeScript
export type Account = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly customFields?: Array<CustomField>;
/**
* The account's creation date.
*/
readonly dateCreated?: string;
/**
* The account's most recent modification date.
*/
readonly dateModified?: string;
defaultBillingAddressId?: number;
defaultShippingAddressId?: number;
description?: string;
domains?: Array<string>;
externalReferenceCode?: string;
id?: number;
logoId?: number;
logoURL?: string;
name: string;
organizationIds?: Array<number>;
status?: number;
taxId?: string;
readonly 'x-class-name'?: string;
type?: 'business' | 'guest' | 'person' | 'supplier';
};
export type CustomField = {
readonly 'x-class-name'?: string;
customValue?: CustomValue;
/**
* The field type (e.g., image, text, etc.).
*/
readonly dataType?: string;
/**
* The field's internal name. This is valid for comparisons and unique in the structured content.
*/
name?: string;
};
/**
* The field's value.
*/
export type CustomValue = {
readonly 'x-class-name'?: string;
/**
* The field's content value for simple types.
*/
data?: {
[key: string]: unknown;
};
/**
* The localized field's content values for simple types.
*/
data_i18n?: {
[key: string]: string;
};
geo?: Geo;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: string;
};
/**
* A point determined by latitude and longitude.
*/
export type Geo = {
readonly 'x-class-name'?: string;
/**
* The latitude of a point in space.
*/
latitude?: number;
/**
* The longitude of a point in space.
*/
longitude?: number;
};
export type PageAccount = {
items?: Array<Account>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Attachment = {
/**
* Base64 encoded file
*/
attachment?: string;
cdnEnabled?: boolean;
cdnURL?: string;
readonly customFields?: Array<CustomField>;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
readonly fileEntryId?: number;
readonly galleryEnabled?: boolean;
readonly id?: number;
neverExpire?: boolean;
options?: {
[key: string]: string;
};
priority?: number;
/**
* URL of the location
*/
src?: string;
readonly tags?: Array<string>;
title?: string;
readonly type?: number;
readonly 'x-class-name'?: string;
};
export type PageAttachment = {
items?: Array<Attachment>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Category = {
id?: number;
/**
* Category Name
*/
name?: string;
siteId?: number;
/**
* Category Title
*/
readonly title?: string;
readonly vocabulary?: string;
readonly 'x-class-name'?: string;
};
export type PageCategory = {
items?: Array<Category>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Channel = {
currencyCode: string;
externalReferenceCode?: string;
id?: number;
name: string;
siteGroupId?: number;
type: string;
readonly 'x-class-name'?: string;
};
export type PageChannel = {
items?: Array<Channel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Currency = {
active?: boolean;
code: string;
externalReferenceCode?: string;
formatPattern?: {
[key: string]: string;
};
id?: number;
maxFractionDigits?: number;
minFractionDigits?: number;
name: {
[key: string]: string;
};
primary?: boolean;
priority?: number;
rate?: number;
symbol?: string;
readonly 'x-class-name'?: string;
roundingMode?: 'UP' | 'DOWN' | 'CEILING' | 'FLOOR' | 'HALF_UP' | 'HALF_DOWN' | 'HALF_EVEN' | 'UNNECESSARY';
};
export type PageCurrency = {
items?: Array<Currency>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type LinkedProduct = {
readonly productExternalReferenceCode?: string;
readonly productId?: number;
readonly type?: string;
readonly 'x-class-name'?: string;
};
export type PageLinkedProduct = {
items?: Array<LinkedProduct>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Availability = {
label?: string;
label_i18n?: string;
stockQuantity?: number;
readonly 'x-class-name'?: string;
};
export type MappedProduct = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
availability?: Availability;
firstAvailableReplacementMappedProduct?: MappedProduct;
id?: number;
price?: Price;
productConfiguration?: ProductConfiguration;
productExternalReferenceCode?: string;
productId?: number;
readonly productName?: {
[key: string]: string;
};
productOptions?: Array<ProductOption>;
readonly purchasable?: boolean;
quantity?: number;
replacementMappedProduct?: MappedProduct;
readonly replacementMessage?: string;
sequence?: string;
sku?: string;
skuExternalReferenceCode?: string;
skuId?: number;
skuOptions?: Array<SkuOption>;
readonly thumbnail?: string;
urls?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
type?: 'diagram' | 'external' | 'sku';
};
export type PageMappedProduct = {
items?: Array<MappedProduct>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Price = {
currency?: string;
discount?: string;
discountPercentage?: string;
discountPercentages?: Array<string>;
finalPrice?: string;
price?: number;
priceFormatted?: string;
readonly priceOnApplication?: boolean;
pricingQuantityPrice?: number;
pricingQuantityPriceFormatted?: string;
promoPrice?: number;
promoPriceFormatted?: string;
tierPrice?: number;
tierPriceFormatted?: string;
readonly 'x-class-name'?: string;
};
export type ProductConfiguration = {
allowBackOrder?: boolean;
allowedOrderQuantities?: Array<number>;
readonly availabilityEstimateId?: number;
readonly availabilityEstimateName?: string;
displayAvailability?: boolean;
displayStockQuantity?: boolean;
/**
* The inventory engine that will be used to manage the product inventory
*/
inventoryEngine?: string;
/**
* The low stock action that will be performed when a product is out of stock
*/
lowStockAction?: string;
maxOrderQuantity?: number;
minOrderQuantity?: number;
minStockQuantity?: number;
multipleOrderQuantity?: number;
readonly 'x-class-name'?: string;
};
export type ProductOption = {
catalogId?: number;
description?: string;
fieldType?: string;
readonly id?: number;
key?: string;
name?: string;
optionExternalReferenceCode?: string;
optionId?: number;
priority?: number;
productOptionValues?: Array<ProductOptionValue>;
readonly required?: boolean;
readonly skuContributor?: boolean;
readonly 'x-class-name'?: string;
};
export type ProductOptionValue = {
readonly id?: number;
readonly infoMessage?: string;
key?: string;
name?: string;
readonly preselected?: boolean;
readonly price?: string;
readonly priceType?: string;
priority?: number;
readonly productOptionId?: number;
readonly quantity?: string;
readonly relativePriceFormatted?: string;
readonly selectable?: boolean;
readonly skuId?: number;
readonly totalPrice?: string;
readonly unitOfMeasureKey?: string;
readonly visible?: boolean;
readonly 'x-class-name'?: string;
};
export type SkuOption = {
readonly key?: number;
price?: string;
priceType?: string;
quantity?: string;
required?: boolean;
skuId?: number;
skuOptionId?: number;
skuOptionKey?: string;
skuOptionName?: string;
skuOptionValueId?: number;
skuOptionValueKey?: string;
skuOptionValueNames?: Array<string>;
readonly value?: number;
readonly 'x-class-name'?: string;
};
export type PagePin = {
items?: Array<Pin>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Pin = {
id?: number;
mappedProduct?: MappedProduct;
positionX?: number;
positionY?: number;
sequence?: string;
readonly 'x-class-name'?: string;
};
export type PageProductOption = {
items?: Array<ProductOption>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageProductOptionValue = {
items?: Array<ProductOptionValue>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type DdmOption = {
key?: string;
required?: boolean;
value?: Array<string>;
readonly 'x-class-name'?: string;
};
export type Product = {
attachments?: Array<Attachment>;
readonly catalogName?: string;
categories?: Array<Category>;
createDate?: string;
customFields?: Array<CustomField>;
description?: string;
expando?: {
[key: string]: {
[key: string]: unknown;
};
};
externalReferenceCode?: string;
readonly id?: number;
images?: Array<Attachment>;
linkedProducts?: Array<LinkedProduct>;
metaDescription?: string;
metaKeyword?: string;
metaTitle?: string;
modifiedDate?: string;
multipleOrderQuantity?: number;
name?: string;
productConfiguration?: ProductConfiguration;
readonly productId?: number;
productOptions?: Array<ProductOption>;
productSpecifications?: Array<ProductSpecification>;
productType?: string;
relatedProducts?: Array<RelatedProduct>;
shortDescription?: string;
skus?: Array<Sku>;
slug?: string;
tags?: Array<string>;
urlImage?: string;
readonly urls?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type ProductSpecification = {
id?: number;
optionCategoryId?: number;
priority?: number;
productId?: number;
specificationGroupKey?: string;
specificationGroupTitle?: string;
specificationId?: number;
specificationKey?: string;
specificationPriority?: number;
specificationTitle?: string;
value?: string;
readonly 'x-class-name'?: string;
};
export type RelatedProduct = {
readonly id?: number;
priority?: number;
productExternalReferenceCode?: string;
productId?: number;
type?: string;
readonly 'x-class-name'?: string;
};
export type ReplacementSku = {
price?: Price;
productConfiguration?: ProductConfiguration;
readonly sku?: string;
skuExternalReferenceCode?: string;
readonly skuId?: number;
readonly skuOptions?: Array<SkuOption>;
skuUnitOfMeasures?: Array<SkuUnitOfMeasure>;
readonly urls?: {
[key: string]: string;
};
readonly 'x-class-name'?: string;
};
export type Sku = {
readonly DDMOptions?: Array<DdmOption>;
allowedOrderQuantities?: Array<string>;
availability?: Availability;
readonly backOrderAllowed?: boolean;
readonly customFields?: Array<CustomField>;
depth?: number;
discontinued?: boolean;
discontinuedDate?: string;
displayDate?: string;
displayDiscountLevels?: boolean;
expirationDate?: string;
externalReferenceCode?: string;
gtin?: string;
height?: number;
readonly id?: number;
incomingQuantityLabel?: string;
manufacturerPartNumber?: string;
maxOrderQuantity?: number;
minOrderQuantity?: number;
neverExpire?: boolean;
price?: Price;
productConfiguration?: ProductConfiguration;
readonly productId?: number;
published?: boolean;
purchasable?: boolean;
replacementSku?: ReplacementSku;
replacementSkuExternalReferenceCode?: string;
replacementSkuId?: number;
sku?: string;
skuOptions?: Array<SkuOption>;
skuUnitOfMeasures?: Array<SkuUnitOfMeasure>;
tierPrices?: Array<TierPrice>;
weight?: number;
width?: number;
readonly 'x-class-name'?: string;
};
export type SkuUnitOfMeasure = {
incrementalOrderQuantity?: number;
key?: string;
name?: string;
precision?: number;
price?: Price;
primary?: boolean;
priority?: number;
rate?: number;
tierPrices?: Array<TierPrice>;
readonly 'x-class-name'?: string;
};
export type TierPrice = {
currency?: string;
readonly price?: number;
readonly priceFormatted?: string;
readonly pricingQuantityPrice?: number;
readonly pricingQuantityPriceFormatted?: string;
readonly quantity?: number;
readonly 'x-class-name'?: string;
};
export type PageProduct = {
items?: Array<Product>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageProductSpecification = {
items?: Array<ProductSpecification>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageRelatedProduct = {
items?: Array<RelatedProduct>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageSku = {
items?: Array<Sku>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type WishListItem = {
finalPrice?: string;
friendlyURL?: string;
icon?: string;
id?: number;
productId?: number;
productName?: string;
skuId?: number;
readonly 'x-class-name'?: string;
};
export type PageWishListItem = {
items?: Array<WishListItem>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageWishList = {
items?: Array<WishList>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type WishList = {
defaultWishList?: boolean;
id?: number;
name?: string;
wishListItems?: Array<WishListItem>;
readonly 'x-class-name'?: string;
};
export type GetChannelAccountsPageData = {
body?: never;
path: {
channelId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/accounts';
};
export type GetChannelAccountsPageResponses = {
/**
* default response
*/
default: PageAccount;
};
export type GetChannelAccountsPageResponse = GetChannelAccountsPageResponses[keyof GetChannelAccountsPageResponses];
export type PostChannelAccountData = {
body?: Account;
path: {
channelId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/accounts';
};
export type PostChannelAccountResponses = {
/**
* default response
*/
default: Account;
};
export type PostChannelAccountResponse = PostChannelAccountResponses[keyof PostChannelAccountResponses];
export type GetChannelProductAttachmentsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/attachments';
};
export type GetChannelProductAttachmentsPageResponses = {
/**
* default response
*/
default: PageAttachment;
};
export type GetChannelProductAttachmentsPageResponse = GetChannelProductAttachmentsPageResponses[keyof GetChannelProductAttachmentsPageResponses];
export type GetChannelProductImagesPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/images';
};
export type GetChannelProductImagesPageResponses = {
/**
* default response
*/
default: PageAttachment;
};
export type GetChannelProductImagesPageResponse = GetChannelProductImagesPageResponses[keyof GetChannelProductImagesPageResponses];
export type GetChannelProductCategoriesPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/categories';
};
export type GetChannelProductCategoriesPageResponses = {
/**
* default response
*/
default: PageCategory;
};
export type GetChannelProductCategoriesPageResponse = GetChannelProductCategoriesPageResponses[keyof GetChannelProductCategoriesPageResponses];
export type GetChannelsPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels';
};
export type GetChannelsPageResponses = {
/**
* default response
*/
default: PageChannel;
};
export type GetChannelsPageResponse = GetChannelsPageResponses[keyof GetChannelsPageResponses];
export type PostChannelsPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/export-batch';
};
export type PostChannelsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeCurrenciesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/currencies';
};
export type GetChannelByExternalReferenceCodeCurrenciesPageResponses = {
/**
* default response
*/
default: PageCurrency;
};
export type GetChannelByExternalReferenceCodeCurrenciesPageResponse = GetChannelByExternalReferenceCodeCurrenciesPageResponses[keyof GetChannelByExternalReferenceCodeCurrenciesPageResponses];
export type GetChannelCurrenciesPageData = {
body?: never;
path: {
channelId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/currencies';
};
export type GetChannelCurrenciesPageResponses = {
/**
* default response
*/
default: PageCurrency;
};
export type GetChannelCurrenciesPageResponse = GetChannelCurrenciesPageResponses[keyof GetChannelCurrenciesPageResponses];
export type GetChannelProductLinkedProductsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/linked-products';
};
export type GetChannelProductLinkedProductsPageResponses = {
/**
* default response
*/
default: PageLinkedProduct;
};
export type GetChannelProductLinkedProductsPageResponse = GetChannelProductLinkedProductsPageResponses[keyof GetChannelProductLinkedProductsPageResponses];
export type GetChannelProductMappedProductsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/mapped-products';
};
export type GetChannelProductMappedProductsPageResponses = {
/**
* default response
*/
default: PageMappedProduct;
};
export type GetChannelProductMappedProductsPageResponse = GetChannelProductMappedProductsPageResponses[keyof GetChannelProductMappedProductsPageResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodePinsPageData = {
body?: never;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
};
query?: {
accountId?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/pins';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodePinsPageResponses = {
/**
* default response
*/
default: PagePin;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodePinsPageResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodePinsPageResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodePinsPageResponses];
export type GetChannelProductPinsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/pins';
};
export type GetChannelProductPinsPageResponses = {
/**
* default response
*/
default: PagePin;
};
export type GetChannelProductPinsPageResponse = GetChannelProductPinsPageResponses[keyof GetChannelProductPinsPageResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionsPageData = {
body?: never;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/product-options';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionsPageResponses = {
/**
* default response
*/
default: PageProductOption;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionsPageResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionsPageResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionsPageResponses];
export type GetChannelProductProductOptionsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/product-options';
};
export type GetChannelProductProductOptionsPageResponses = {
/**
* default response
*/
default: PageProductOption;
};
export type GetChannelProductProductOptionsPageResponse = GetChannelProductProductOptionsPageResponses[keyof GetChannelProductProductOptionsPageResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageData = {
body?: never;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
productOptionExternalReferenceCode: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
productOptionValueId?: string;
skuId?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/product-options/by-externalReferenceCode/{productOptionExternalReferenceCode}/product-option-values';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponses = {
/**
* default response
*/
default: PageProductOptionValue;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponses];
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageData = {
body?: Array<SkuOption>;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
productOptionExternalReferenceCode: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
productOptionValueId?: string;
skuId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/product-options/by-externalReferenceCode/{productOptionExternalReferenceCode}/product-option-values';
};
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponses = {
/**
* default response
*/
default: PageProductOptionValue;
};
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponse = PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponses[keyof PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductOptionByExternalReferenceCodeProductOptionExternalReferenceCodeProductOptionValuesPageResponses];
export type GetChannelProductProductOptionProductOptionValuesPageData = {
body?: never;
path: {
channelId: string;
productId: string;
productOptionId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
productOptionValueId?: string;
skuId?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/product-options/{productOptionId}/product-option-values';
};
export type GetChannelProductProductOptionProductOptionValuesPageResponses = {
/**
* default response
*/
default: PageProductOptionValue;
};
export type GetChannelProductProductOptionProductOptionValuesPageResponse = GetChannelProductProductOptionProductOptionValuesPageResponses[keyof GetChannelProductProductOptionProductOptionValuesPageResponses];
export type PostChannelProductProductOptionProductOptionValuesPageData = {
body?: Array<SkuOption>;
path: {
channelId: string;
productId: string;
productOptionId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
productOptionValueId?: string;
skuId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/product-options/{productOptionId}/product-option-values';
};
export type PostChannelProductProductOptionProductOptionValuesPageResponses = {
/**
* default response
*/
default: PageProductOptionValue;
};
export type PostChannelProductProductOptionProductOptionValuesPageResponse = PostChannelProductProductOptionProductOptionValuesPageResponses[keyof PostChannelProductProductOptionProductOptionValuesPageResponses];
export type GetChannelProductData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}';
};
export type GetChannelProductResponses = {
/**
* default response
*/
default: Product;
};
export type GetChannelProductResponse = GetChannelProductResponses[keyof GetChannelProductResponses];
export type GetChannelProductByFriendlyUrlPathData = {
body?: never;
path: {
channelId: string;
friendlyUrlPath: string;
};
query?: {
accountId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/by-friendly-url-path/{friendlyUrlPath}';
};
export type GetChannelProductByFriendlyUrlPathResponses = {
/**
* default response
*/
default: Product;
};
export type GetChannelProductByFriendlyUrlPathResponse = GetChannelProductByFriendlyUrlPathResponses[keyof GetChannelProductByFriendlyUrlPathResponses];
export type GetChannelProductsPageData = {
body?: never;
path: {
channelId: string;
};
query?: {
accountId?: string;
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products';
};
export type GetChannelProductsPageResponses = {
/**
* default response
*/
default: PageProduct;
};
export type GetChannelProductsPageResponse = GetChannelProductsPageResponses[keyof GetChannelProductsPageResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductSpecificationsPageData = {
body?: never;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/product-specifications';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductSpecificationsPageResponses = {
/**
* default response
*/
default: PageProductSpecification;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductSpecificationsPageResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductSpecificationsPageResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeProductSpecificationsPageResponses];
export type GetChannelProductProductSpecificationsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/product-specifications';
};
export type GetChannelProductProductSpecificationsPageResponses = {
/**
* default response
*/
default: PageProductSpecification;
};
export type GetChannelProductProductSpecificationsPageResponse = GetChannelProductProductSpecificationsPageResponses[keyof GetChannelProductProductSpecificationsPageResponses];
export type GetChannelProductRelatedProductsPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
page?: string;
pageSize?: string;
type?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/related-products';
};
export type GetChannelProductRelatedProductsPageResponses = {
/**
* default response
*/
default: PageRelatedProduct;
};
export type GetChannelProductRelatedProductsPageResponse = GetChannelProductRelatedProductsPageResponses[keyof GetChannelProductRelatedProductsPageResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuByExternalReferenceCodeSkuExternalReferenceCodeData = {
body?: never;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
skuExternalReferenceCode: string;
};
query?: {
accountId?: string;
currencyCode?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/skus/by-externalReferenceCode/{skuExternalReferenceCode}';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuByExternalReferenceCodeSkuExternalReferenceCodeResponses = {
/**
* default response
*/
default: Sku;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuByExternalReferenceCodeSkuExternalReferenceCodeResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuByExternalReferenceCodeSkuExternalReferenceCodeResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuByExternalReferenceCodeSkuExternalReferenceCodeResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkusPageData = {
body?: never;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/skus';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkusPageResponses = {
/**
* default response
*/
default: PageSku;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkusPageResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkusPageResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkusPageResponses];
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuData = {
body?: Array<DdmOption>;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
};
query?: {
accountId?: string;
quantity?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/skus';
};
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuResponses = {
/**
* default response
*/
default: Sku;
};
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuResponse = PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuResponses[keyof PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuResponses];
export type GetChannelProductSkuData = {
body?: never;
path: {
channelId: string;
productId: string;
skuId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/skus/{skuId}';
};
export type GetChannelProductSkuResponses = {
/**
* default response
*/
default: Sku;
};
export type GetChannelProductSkuResponse = GetChannelProductSkuResponses[keyof GetChannelProductSkuResponses];
export type GetChannelProductSkusPageData = {
body?: never;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/skus';
};
export type GetChannelProductSkusPageResponses = {
/**
* default response
*/
default: PageSku;
};
export type GetChannelProductSkusPageResponse = GetChannelProductSkusPageResponses[keyof GetChannelProductSkusPageResponses];
export type PostChannelProductSkuData = {
body?: Array<DdmOption>;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
quantity?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/skus';
};
export type PostChannelProductSkuResponses = {
/**
* default response
*/
default: Sku;
};
export type PostChannelProductSkuResponse = PostChannelProductSkuResponses[keyof PostChannelProductSkuResponses];
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuBySkuOptionData = {
body?: Array<SkuOption>;
path: {
channelExternalReferenceCode: string;
productExternalReferenceCode: string;
};
query?: {
accountId?: string;
currencyCode?: string;
quantity?: string;
skuUnitOfMeasureKey?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/products/by-externalReferenceCode/{productExternalReferenceCode}/skus/by-sku-option';
};
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuBySkuOptionResponses = {
/**
* default response
*/
default: Sku;
};
export type PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuBySkuOptionResponse = PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuBySkuOptionResponses[keyof PostChannelByExternalReferenceCodeChannelExternalReferenceCodeProductByExternalReferenceCodeProductExternalReferenceCodeSkuBySkuOptionResponses];
export type PostChannelProductSkuBySkuOptionData = {
body?: Array<SkuOption>;
path: {
channelId: string;
productId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
quantity?: string;
skuUnitOfMeasureKey?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/products/{productId}/skus/by-sku-option';
};
export type PostChannelProductSkuBySkuOptionResponses = {
/**
* default response
*/
default: Sku;
};
export type PostChannelProductSkuBySkuOptionResponse = PostChannelProductSkuBySkuOptionResponses[keyof PostChannelProductSkuBySkuOptionResponses];
export type DeleteWishListItemData = {
body?: never;
path: {
wishListItemId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlist-items/{wishListItemId}';
};
export type DeleteWishListItemResponses = {
/**
* default response
*/
default: unknown;
};
export type GetWishListItemData = {
body?: never;
path: {
wishListItemId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlist-items/{wishListItemId}';
};
export type GetWishListItemResponses = {
/**
* default response
*/
default: WishListItem;
};
export type GetWishListItemResponse = GetWishListItemResponses[keyof GetWishListItemResponses];
export type DeleteWishListItemBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlist-items/batch';
};
export type DeleteWishListItemBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetWishlistWishListWishListItemsPageData = {
body?: never;
path: {
wishListId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlists/{wishListId}/wishlist-items';
};
export type GetWishlistWishListWishListItemsPageResponses = {
/**
* default response
*/
default: PageWishListItem;
};
export type GetWishlistWishListWishListItemsPageResponse = GetWishlistWishListWishListItemsPageResponses[keyof GetWishlistWishListWishListItemsPageResponses];
export type PostWishlistWishListWishListItemData = {
body?: WishListItem;
path: {
wishListId: string;
};
query?: {
accountId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlists/{wishListId}/wishlist-items';
};
export type PostWishlistWishListWishListItemResponses = {
/**
* default response
*/
default: WishListItem;
};
export type PostWishlistWishListWishListItemResponse = PostWishlistWishListWishListItemResponses[keyof PostWishlistWishListWishListItemResponses];
export type DeleteWishListData = {
body?: never;
path: {
wishListId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlists/{wishListId}';
};
export type DeleteWishListResponses = {
/**
* default response
*/
default: unknown;
};
export type GetWishListData = {
body?: never;
path: {
wishListId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlists/{wishListId}';
};
export type GetWishListResponses = {
/**
* default response
*/
default: WishList;
};
export type GetWishListResponse = GetWishListResponses[keyof GetWishListResponses];
export type PatchWishListData = {
body?: WishList;
path: {
wishListId: string;
};
query?: {
accountId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlists/{wishListId}';
};
export type PatchWishListResponses = {
/**
* default response
*/
default: WishList;
};
export type PatchWishListResponse = PatchWishListResponses[keyof PatchWishListResponses];
export type DeleteWishListBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/wishlists/batch';
};
export type DeleteWishListBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetChannelByExternalReferenceCodeWishListsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/wishlists';
};
export type GetChannelByExternalReferenceCodeWishListsPageResponses = {
/**
* default response
*/
default: PageWishList;
};
export type GetChannelByExternalReferenceCodeWishListsPageResponse = GetChannelByExternalReferenceCodeWishListsPageResponses[keyof GetChannelByExternalReferenceCodeWishListsPageResponses];
export type PostChannelByExternalReferenceCodeWishListData = {
body?: WishList;
path: {
externalReferenceCode: string;
};
query?: {
accountId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/wishlists';
};
export type PostChannelByExternalReferenceCodeWishListResponses = {
/**
* default response
*/
default: WishList;
};
export type PostChannelByExternalReferenceCodeWishListResponse = PostChannelByExternalReferenceCodeWishListResponses[keyof PostChannelByExternalReferenceCodeWishListResponses];
export type GetChannelWishListsPageData = {
body?: never;
path: {
channelId: string;
};
query?: {
accountId?: string;
currencyCode?: string;
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/wishlists';
};
export type GetChannelWishListsPageResponses = {
/**
* default response
*/
default: PageWishList;
};
export type GetChannelWishListsPageResponse = GetChannelWishListsPageResponses[keyof GetChannelWishListsPageResponses];
export type PostChannelWishListData = {
body?: WishList;
path: {
channelId: string;
};
query?: {
accountId?: string;
};
url: '/o/headless-commerce-delivery-catalog/v1.0/channels/{channelId}/wishlists';
};
export type PostChannelWishListResponses = {
/**
* default response
*/
default: WishList;
};
export type PostChannelWishListResponse = PostChannelWishListResponses[keyof PostChannelWishListResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};