liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,580 lines (1,579 loc) • 46.5 kB
TypeScript
export type Address = {
city: string;
country?: string;
countryISOCode: string;
description?: string;
readonly externalReferenceCode?: string;
id?: number;
latitude?: number;
longitude?: number;
name: string;
phoneNumber?: string;
region?: string;
regionISOCode?: string;
street1: string;
street2?: string;
street3?: string;
subtype?: string;
readonly type?: string;
typeId?: number;
vatNumber?: string;
zip?: string;
readonly 'x-class-name'?: string;
};
export type Attachment = {
readonly externalReferenceCode?: string;
readonly id?: number;
readonly title?: string;
readonly type?: number;
readonly url?: string;
readonly 'x-class-name'?: string;
};
export type Facet = {
facetCriteria?: string;
facetValues?: Array<FacetValue>;
};
export type FacetValue = {
numberOfOccurrences?: number;
term?: 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 AttachmentBase64 = {
/**
* Base64 encoded file
*/
attachment?: string;
externalReferenceCode?: string;
title?: string;
readonly 'x-class-name'?: string;
};
export type CartComment = {
readonly author?: string;
readonly authorId?: number;
readonly authorPortraitURL?: string;
content?: string;
readonly externalReferenceCode?: string;
readonly id?: number;
readonly modifiedDate?: string;
readonly orderId?: number;
restricted?: boolean;
readonly 'x-class-name'?: string;
};
export type PageCartComment = {
items?: Array<CartComment>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type CartItem = {
readonly adaptiveMediaImageHTMLTag?: string;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
/**
* @deprecated
*/
deliveryGroup?: string;
deliveryGroupName?: string;
errorMessages?: Array<string>;
readonly externalReferenceCode?: string;
readonly id?: number;
readonly name?: string;
options?: string;
readonly parentCartItemId?: number;
price?: Price;
productId?: number;
readonly productURLs?: {
[key: string]: string;
};
quantity?: number;
readonly replacedSku?: string;
replacedSkuExternalReferenceCode?: string;
replacedSkuId?: number;
requestedDeliveryDate?: string;
settings?: Settings;
shippingAddress?: Address;
shippingAddressExternalReferenceCode?: string;
shippingAddressId?: number;
readonly sku?: string;
skuId: number;
skuUnitOfMeasure?: SkuUnitOfMeasure;
readonly subscription?: boolean;
readonly thumbnail?: string;
readonly unitOfMeasure?: string;
readonly valid?: boolean;
readonly 'x-class-name'?: string;
};
export type PageCartItem = {
items?: Array<CartItem>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Price = {
currency?: string;
discount?: number;
discountFormatted?: string;
discountPercentage?: string;
discountPercentageLevel1?: number;
discountPercentageLevel2?: number;
discountPercentageLevel3?: number;
discountPercentageLevel4?: number;
finalPrice?: number;
finalPriceFormatted?: string;
price?: number;
priceFormatted?: string;
readonly priceOnApplication?: boolean;
promoPrice?: number;
promoPriceFormatted?: string;
readonly 'x-class-name'?: string;
};
export type Settings = {
allowedQuantities?: Array<number>;
maxQuantity?: number;
minQuantity?: number;
multipleQuantity?: number;
readonly 'x-class-name'?: string;
};
export type SkuUnitOfMeasure = {
incrementalOrderQuantity?: number;
key?: string;
name?: string;
precision?: number;
primary?: boolean;
priority?: number;
rate?: number;
readonly 'x-class-name'?: string;
};
export type Cart = {
readonly account?: string;
accountId?: number;
attachments?: Array<Attachment>;
readonly author?: string;
billingAddress?: Address;
billingAddressExternalReferenceCode?: string;
billingAddressId?: number;
cartItems?: Array<CartItem>;
readonly channelId?: number;
couponCode?: string;
readonly createDate?: string;
currencyCode?: string;
currencyExternalReferenceCode?: string;
currencyId?: number;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
deliveryTermId?: number;
readonly deliveryTermLabel?: string;
errorMessages?: Array<string>;
readonly externalReferenceCode?: string;
readonly friendlyURLSeparator?: string;
readonly id?: number;
readonly lastPriceUpdateDate?: string;
readonly modifiedDate?: string;
name?: string;
notes?: Array<CartComment>;
orderStatusInfo?: Status;
readonly orderType?: string;
orderTypeExternalReferenceCode?: string;
orderTypeId?: number;
readonly orderUUID?: string;
paymentMethod?: string;
readonly paymentMethodLabel?: string;
readonly paymentMethodType?: number;
readonly paymentStatus?: number;
paymentStatusInfo?: Status;
readonly paymentStatusLabel?: string;
paymentTermId?: number;
readonly paymentTermLabel?: string;
printedNote?: string;
purchaseOrderNumber?: string;
requestedDeliveryDate?: string;
shippingAddress?: Address;
shippingAddressExternalReferenceCode?: string;
shippingAddressId?: number;
shippingMethod?: string;
shippingOption?: string;
readonly status?: string;
steps?: Array<Step>;
summary?: Summary;
useAsBilling?: boolean;
readonly valid?: boolean;
workflowStatusInfo?: Status;
readonly 'x-class-name'?: string;
};
export type Status = {
readonly code?: number;
label?: string;
label_i18n?: string;
readonly 'x-class-name'?: string;
};
export type Step = {
readonly id?: string;
readonly label?: string;
readonly state?: string;
readonly 'x-class-name'?: string;
};
export type Summary = {
currency?: string;
readonly itemsCount?: number;
itemsQuantity?: number;
shippingDiscountPercentages?: Array<string>;
shippingDiscountValue?: number;
shippingDiscountValueFormatted?: string;
shippingValue?: number;
shippingValueFormatted?: string;
shippingValueWithTaxAmount?: number;
shippingValueWithTaxAmountFormatted?: string;
subtotal?: number;
subtotalDiscountPercentages?: Array<string>;
subtotalDiscountValue?: number;
subtotalDiscountValueFormatted?: string;
subtotalFormatted?: string;
taxValue?: number;
taxValueFormatted?: string;
total?: number;
totalDiscountPercentages?: Array<string>;
totalDiscountValue?: number;
totalDiscountValueFormatted?: string;
totalFormatted?: string;
readonly 'x-class-name'?: string;
};
export type PageCart = {
items?: Array<Cart>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type CouponCode = {
code?: string;
readonly 'x-class-name'?: string;
};
export type CartTransition = {
readonly cartId?: number;
comment?: string;
readonly label?: string;
name?: string;
readonly open?: boolean;
workflowTaskId?: number;
readonly 'x-class-name'?: string;
};
export type PageCartTransition = {
items?: Array<CartTransition>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PagePaymentMethod = {
items?: Array<PaymentMethod>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PaymentMethod = {
description?: string;
key?: string;
name?: string;
readonly 'x-class-name'?: string;
};
export type PageShippingMethod = {
items?: Array<ShippingMethod>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ShippingMethod = {
description?: string;
engineKey?: string;
id?: number;
name?: string;
shippingOptions?: Array<ShippingOption>;
readonly 'x-class-name'?: string;
};
export type ShippingOption = {
amount?: number;
amountFormatted?: string;
label?: string;
name?: string;
readonly 'x-class-name'?: string;
};
export type PageTerm = {
items?: Array<Term>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Term = {
readonly description?: string;
externalReferenceCode?: string;
id?: number;
readonly label?: string;
readonly name?: string;
readonly 'x-class-name'?: string;
};
export type GetCartBillingAddresData = {
body?: never;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/billing-address';
};
export type GetCartBillingAddresResponses = {
/**
* default response
*/
default: Address;
};
export type GetCartBillingAddresResponse = GetCartBillingAddresResponses[keyof GetCartBillingAddresResponses];
export type GetCartByExternalReferenceCodeBillingAddressData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/billing-address';
};
export type GetCartByExternalReferenceCodeBillingAddressResponses = {
/**
* default response
*/
default: Address;
};
export type GetCartByExternalReferenceCodeBillingAddressResponse = GetCartByExternalReferenceCodeBillingAddressResponses[keyof GetCartByExternalReferenceCodeBillingAddressResponses];
export type GetCartByExternalReferenceCodeShippingAddressData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/shipping-address';
};
export type GetCartByExternalReferenceCodeShippingAddressResponses = {
/**
* default response
*/
default: Address;
};
export type GetCartByExternalReferenceCodeShippingAddressResponse = GetCartByExternalReferenceCodeShippingAddressResponses[keyof GetCartByExternalReferenceCodeShippingAddressResponses];
export type GetCartShippingAddresData = {
body?: never;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/shipping-address';
};
export type GetCartShippingAddresResponses = {
/**
* default response
*/
default: Address;
};
export type GetCartShippingAddresResponse = GetCartShippingAddresResponses[keyof GetCartShippingAddresResponses];
export type DeleteCartAttachmentData = {
body?: never;
path: {
attachmentId: string;
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/attachments/{attachmentId}';
};
export type DeleteCartAttachmentResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteCartByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCodeData = {
body?: never;
path: {
attachmentExternalReferenceCode: string;
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/attachments/by-externalReferenceCode/{attachmentExternalReferenceCode}';
};
export type DeleteCartByExternalReferenceCodeAttachmentByExternalReferenceCodeAttachmentExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartAttachmentsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/attachments';
};
export type GetCartAttachmentsPageResponses = {
/**
* default response
*/
default: PageAttachment;
};
export type GetCartAttachmentsPageResponse = GetCartAttachmentsPageResponses[keyof GetCartAttachmentsPageResponses];
export type GetCartByExternalReferenceCodeAttachmentsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/attachments';
};
export type GetCartByExternalReferenceCodeAttachmentsPageResponses = {
/**
* default response
*/
default: PageAttachment;
};
export type GetCartByExternalReferenceCodeAttachmentsPageResponse = GetCartByExternalReferenceCodeAttachmentsPageResponses[keyof GetCartByExternalReferenceCodeAttachmentsPageResponses];
export type PostCartAttachmentByBase64Data = {
body?: AttachmentBase64;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/attachments/by-base64';
};
export type PostCartAttachmentByBase64Responses = {
/**
* default response
*/
default: Attachment;
};
export type PostCartAttachmentByBase64Response = PostCartAttachmentByBase64Responses[keyof PostCartAttachmentByBase64Responses];
export type PostCartAttachmentsPageExportBatchData = {
body?: never;
path: {
cartId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/attachments/export-batch';
};
export type PostCartAttachmentsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostCartByExternalReferenceCodeAttachmentByBase64Data = {
body?: AttachmentBase64;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/attachments/by-base64';
};
export type PostCartByExternalReferenceCodeAttachmentByBase64Responses = {
/**
* default response
*/
default: Attachment;
};
export type PostCartByExternalReferenceCodeAttachmentByBase64Response = PostCartByExternalReferenceCodeAttachmentByBase64Responses[keyof PostCartByExternalReferenceCodeAttachmentByBase64Responses];
export type DeleteCartCommentData = {
body?: never;
path: {
cartCommentId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/{cartCommentId}';
};
export type DeleteCartCommentResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartCommentData = {
body?: never;
path: {
cartCommentId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/{cartCommentId}';
};
export type GetCartCommentResponses = {
/**
* default response
*/
default: CartComment;
};
export type GetCartCommentResponse = GetCartCommentResponses[keyof GetCartCommentResponses];
export type PatchCartCommentData = {
body?: CartComment;
path: {
cartCommentId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/{cartCommentId}';
};
export type PatchCartCommentResponses = {
/**
* default response
*/
default: CartComment;
};
export type PatchCartCommentResponse = PatchCartCommentResponses[keyof PatchCartCommentResponses];
export type PutCartCommentData = {
body?: CartComment;
path: {
cartCommentId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/{cartCommentId}';
};
export type PutCartCommentResponses = {
/**
* default response
*/
default: CartComment;
};
export type PutCartCommentResponse = PutCartCommentResponses[keyof PutCartCommentResponses];
export type DeleteCartCommentBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/batch';
};
export type DeleteCartCommentBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutCartCommentBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/batch';
};
export type PutCartCommentBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteCartCommentByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteCartCommentByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartCommentByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetCartCommentByExternalReferenceCodeResponses = {
/**
* default response
*/
default: CartComment;
};
export type GetCartCommentByExternalReferenceCodeResponse = GetCartCommentByExternalReferenceCodeResponses[keyof GetCartCommentByExternalReferenceCodeResponses];
export type PatchCartCommentByExternalReferenceCodeData = {
body?: CartComment;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchCartCommentByExternalReferenceCodeResponses = {
/**
* default response
*/
default: CartComment;
};
export type PatchCartCommentByExternalReferenceCodeResponse = PatchCartCommentByExternalReferenceCodeResponses[keyof PatchCartCommentByExternalReferenceCodeResponses];
export type PutCartCommentByExternalReferenceCodeData = {
body?: CartComment;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-comments/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutCartCommentByExternalReferenceCodeResponses = {
/**
* default response
*/
default: CartComment;
};
export type PutCartCommentByExternalReferenceCodeResponse = PutCartCommentByExternalReferenceCodeResponses[keyof PutCartCommentByExternalReferenceCodeResponses];
export type GetCartByExternalReferenceCodeCommentsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/comments';
};
export type GetCartByExternalReferenceCodeCommentsPageResponses = {
/**
* default response
*/
default: PageCartComment;
};
export type GetCartByExternalReferenceCodeCommentsPageResponse = GetCartByExternalReferenceCodeCommentsPageResponses[keyof GetCartByExternalReferenceCodeCommentsPageResponses];
export type PostCartByExternalReferenceCodeCommentData = {
body?: CartComment;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/comments';
};
export type PostCartByExternalReferenceCodeCommentResponses = {
/**
* default response
*/
default: CartComment;
};
export type PostCartByExternalReferenceCodeCommentResponse = PostCartByExternalReferenceCodeCommentResponses[keyof PostCartByExternalReferenceCodeCommentResponses];
export type GetCartCommentsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/comments';
};
export type GetCartCommentsPageResponses = {
/**
* default response
*/
default: PageCartComment;
};
export type GetCartCommentsPageResponse = GetCartCommentsPageResponses[keyof GetCartCommentsPageResponses];
export type PostCartCommentData = {
body?: CartComment;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/comments';
};
export type PostCartCommentResponses = {
/**
* default response
*/
default: CartComment;
};
export type PostCartCommentResponse = PostCartCommentResponses[keyof PostCartCommentResponses];
export type DeleteCartItemData = {
body?: never;
path: {
cartItemId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/{cartItemId}';
};
export type DeleteCartItemResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartItemData = {
body?: never;
path: {
cartItemId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/{cartItemId}';
};
export type GetCartItemResponses = {
/**
* default response
*/
default: CartItem;
};
export type GetCartItemResponse = GetCartItemResponses[keyof GetCartItemResponses];
export type PatchCartItemData = {
body?: CartItem;
path: {
cartItemId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/{cartItemId}';
};
export type PatchCartItemResponses = {
/**
* default response
*/
default: CartItem;
};
export type PatchCartItemResponse = PatchCartItemResponses[keyof PatchCartItemResponses];
export type PutCartItemData = {
body?: CartItem;
path: {
cartItemId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/{cartItemId}';
};
export type PutCartItemResponses = {
/**
* default response
*/
default: CartItem;
};
export type PutCartItemResponse = PutCartItemResponses[keyof PutCartItemResponses];
export type DeleteCartItemBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/batch';
};
export type DeleteCartItemBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutCartItemBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/batch';
};
export type PutCartItemBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteCartItemByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteCartItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartItemByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetCartItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: CartItem;
};
export type GetCartItemByExternalReferenceCodeResponse = GetCartItemByExternalReferenceCodeResponses[keyof GetCartItemByExternalReferenceCodeResponses];
export type PatchCartItemByExternalReferenceCodeData = {
body?: CartItem;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchCartItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: CartItem;
};
export type PatchCartItemByExternalReferenceCodeResponse = PatchCartItemByExternalReferenceCodeResponses[keyof PatchCartItemByExternalReferenceCodeResponses];
export type PutCartItemByExternalReferenceCodeData = {
body?: CartItem;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/cart-items/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutCartItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: CartItem;
};
export type PutCartItemByExternalReferenceCodeResponse = PutCartItemByExternalReferenceCodeResponses[keyof PutCartItemByExternalReferenceCodeResponses];
export type GetCartByExternalReferenceCodeItemsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
search?: string;
skuId?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/items';
};
export type GetCartByExternalReferenceCodeItemsPageResponses = {
/**
* default response
*/
default: PageCartItem;
};
export type GetCartByExternalReferenceCodeItemsPageResponse = GetCartByExternalReferenceCodeItemsPageResponses[keyof GetCartByExternalReferenceCodeItemsPageResponses];
export type PostCartByExternalReferenceCodeItemData = {
body?: CartItem;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/items';
};
export type PostCartByExternalReferenceCodeItemResponses = {
/**
* default response
*/
default: CartItem;
};
export type PostCartByExternalReferenceCodeItemResponse = PostCartByExternalReferenceCodeItemResponses[keyof PostCartByExternalReferenceCodeItemResponses];
export type GetCartItemsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
page?: string;
pageSize?: string;
search?: string;
skuId?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/items';
};
export type GetCartItemsPageResponses = {
/**
* default response
*/
default: PageCartItem;
};
export type GetCartItemsPageResponse = GetCartItemsPageResponses[keyof GetCartItemsPageResponses];
export type PostCartItemData = {
body?: CartItem;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/items';
};
export type PostCartItemResponses = {
/**
* default response
*/
default: CartItem;
};
export type PostCartItemResponse = PostCartItemResponses[keyof PostCartItemResponses];
export type DeleteCartData = {
body?: never;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}';
};
export type DeleteCartResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartData = {
body?: never;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}';
};
export type GetCartResponses = {
/**
* default response
*/
default: Cart;
};
export type GetCartResponse = GetCartResponses[keyof GetCartResponses];
export type PatchCartData = {
body?: Cart;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}';
};
export type PatchCartResponses = {
/**
* default response
*/
default: Cart;
};
export type PatchCartResponse = PatchCartResponses[keyof PatchCartResponses];
export type PutCartData = {
body?: Cart;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}';
};
export type PutCartResponses = {
/**
* default response
*/
default: Cart;
};
export type PutCartResponse = PutCartResponses[keyof PutCartResponses];
export type DeleteCartBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/batch';
};
export type DeleteCartBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutCartBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/batch';
};
export type PutCartBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteCartByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteCartByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetCartByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Cart;
};
export type GetCartByExternalReferenceCodeResponse = GetCartByExternalReferenceCodeResponses[keyof GetCartByExternalReferenceCodeResponses];
export type PatchCartByExternalReferenceCodeData = {
body?: Cart;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchCartByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Cart;
};
export type PatchCartByExternalReferenceCodeResponse = PatchCartByExternalReferenceCodeResponses[keyof PatchCartByExternalReferenceCodeResponses];
export type PutCartByExternalReferenceCodeData = {
body?: Cart;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutCartByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Cart;
};
export type PutCartByExternalReferenceCodeResponse = PutCartByExternalReferenceCodeResponses[keyof PutCartByExternalReferenceCodeResponses];
export type GetCartByExternalReferenceCodePaymentUrlData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/payment-url';
};
export type GetCartByExternalReferenceCodePaymentUrlResponses = {
/**
* default response
*/
default: string;
};
export type GetCartByExternalReferenceCodePaymentUrlResponse = GetCartByExternalReferenceCodePaymentUrlResponses[keyof GetCartByExternalReferenceCodePaymentUrlResponses];
export type GetCartPaymentUrlData = {
body?: never;
path: {
cartId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/payment-url';
};
export type GetCartPaymentUrlResponses = {
/**
* default response
*/
default: string;
};
export type GetCartPaymentUrlResponse = GetCartPaymentUrlResponses[keyof GetCartPaymentUrlResponses];
export type GetChannelAccountCartsPageData = {
body?: never;
path: {
accountId: string;
channelId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/channels/{channelId}/account/{accountId}/carts';
};
export type GetChannelAccountCartsPageResponses = {
/**
* default response
*/
default: PageCart;
};
export type GetChannelAccountCartsPageResponse = GetChannelAccountCartsPageResponses[keyof GetChannelAccountCartsPageResponses];
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodeCartsPageData = {
body?: never;
path: {
accountExternalReferenceCode: string;
channelExternalReferenceCode: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/channels/by-externalReferenceCode/{channelExternalReferenceCode}/account/by-externalReferenceCode/{accountExternalReferenceCode}/carts';
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodeCartsPageResponses = {
/**
* default response
*/
default: PageCart;
};
export type GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodeCartsPageResponse = GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodeCartsPageResponses[keyof GetChannelByExternalReferenceCodeChannelExternalReferenceCodeAccountByExternalReferenceCodeAccountExternalReferenceCodeCartsPageResponses];
export type GetChannelCartsPageData = {
body?: never;
path: {
channelId: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/channels/{channelId}/carts';
};
export type GetChannelCartsPageResponses = {
/**
* default response
*/
default: PageCart;
};
export type GetChannelCartsPageResponse = GetChannelCartsPageResponses[keyof GetChannelCartsPageResponses];
export type PostChannelCartData = {
body?: Cart;
path: {
channelId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/channels/{channelId}/carts';
};
export type PostChannelCartResponses = {
/**
* default response
*/
default: Cart;
};
export type PostChannelCartResponse = PostChannelCartResponses[keyof PostChannelCartResponses];
export type PostCartByExternalReferenceCodeCheckoutData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/checkout';
};
export type PostCartByExternalReferenceCodeCheckoutResponses = {
/**
* default response
*/
default: Cart;
};
export type PostCartByExternalReferenceCodeCheckoutResponse = PostCartByExternalReferenceCodeCheckoutResponses[keyof PostCartByExternalReferenceCodeCheckoutResponses];
export type PostCartByExternalReferenceCodeCouponCodeData = {
body?: CouponCode;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/coupon-code';
};
export type PostCartByExternalReferenceCodeCouponCodeResponses = {
/**
* default response
*/
default: Cart;
};
export type PostCartByExternalReferenceCodeCouponCodeResponse = PostCartByExternalReferenceCodeCouponCodeResponses[keyof PostCartByExternalReferenceCodeCouponCodeResponses];
export type PostCartCheckoutData = {
body?: never;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/checkout';
};
export type PostCartCheckoutResponses = {
/**
* default response
*/
default: Cart;
};
export type PostCartCheckoutResponse = PostCartCheckoutResponses[keyof PostCartCheckoutResponses];
export type PostCartCouponCodeData = {
body?: CouponCode;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/coupon-code';
};
export type PostCartCouponCodeResponses = {
/**
* default response
*/
default: Cart;
};
export type PostCartCouponCodeResponse = PostCartCouponCodeResponses[keyof PostCartCouponCodeResponses];
export type PostChannelCartByExternalReferenceCodeData = {
body?: Cart;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/channels/by-externalReferenceCode/{externalReferenceCode}/carts';
};
export type PostChannelCartByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Cart;
};
export type PostChannelCartByExternalReferenceCodeResponse = PostChannelCartByExternalReferenceCodeResponses[keyof PostChannelCartByExternalReferenceCodeResponses];
export type GetCartCartTransitionsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/cart-transitions';
};
export type GetCartCartTransitionsPageResponses = {
/**
* default response
*/
default: PageCartTransition;
};
export type GetCartCartTransitionsPageResponse = GetCartCartTransitionsPageResponses[keyof GetCartCartTransitionsPageResponses];
export type PostCartCartTransitionData = {
body?: CartTransition;
path: {
cartId: string;
};
query?: never;
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/cart-transitions';
};
export type PostCartCartTransitionResponses = {
/**
* default response
*/
default: CartTransition;
};
export type PostCartCartTransitionResponse = PostCartCartTransitionResponses[keyof PostCartCartTransitionResponses];
export type PostCartCartTransitionBatchData = {
body?: {
[key: string]: unknown;
};
path: {
cartId: string;
};
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/cart-transitions/batch';
};
export type PostCartCartTransitionBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostCartCartTransitionsPageExportBatchData = {
body?: never;
path: {
cartId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/cart-transitions/export-batch';
};
export type PostCartCartTransitionsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartByExternalReferenceCodePaymentMethodsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/payment-methods';
};
export type GetCartByExternalReferenceCodePaymentMethodsPageResponses = {
/**
* default response
*/
default: PagePaymentMethod;
};
export type GetCartByExternalReferenceCodePaymentMethodsPageResponse = GetCartByExternalReferenceCodePaymentMethodsPageResponses[keyof GetCartByExternalReferenceCodePaymentMethodsPageResponses];
export type GetCartPaymentMethodsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/payment-methods';
};
export type GetCartPaymentMethodsPageResponses = {
/**
* default response
*/
default: PagePaymentMethod;
};
export type GetCartPaymentMethodsPageResponse = GetCartPaymentMethodsPageResponses[keyof GetCartPaymentMethodsPageResponses];
export type PostCartPaymentMethodsPageExportBatchData = {
body?: never;
path: {
cartId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/payment-methods/export-batch';
};
export type PostCartPaymentMethodsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartByExternalReferenceCodeShippingMethodsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/shipping-methods';
};
export type GetCartByExternalReferenceCodeShippingMethodsPageResponses = {
/**
* default response
*/
default: PageShippingMethod;
};
export type GetCartByExternalReferenceCodeShippingMethodsPageResponse = GetCartByExternalReferenceCodeShippingMethodsPageResponses[keyof GetCartByExternalReferenceCodeShippingMethodsPageResponses];
export type GetCartShippingMethodsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/shipping-methods';
};
export type GetCartShippingMethodsPageResponses = {
/**
* default response
*/
default: PageShippingMethod;
};
export type GetCartShippingMethodsPageResponse = GetCartShippingMethodsPageResponses[keyof GetCartShippingMethodsPageResponses];
export type PostCartShippingMethodsPageExportBatchData = {
body?: never;
path: {
cartId: string;
};
query?: {
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/shipping-methods/export-batch';
};
export type PostCartShippingMethodsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetCartByExternalReferenceCodeDeliveryTermsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/delivery-terms';
};
export type GetCartByExternalReferenceCodeDeliveryTermsPageResponses = {
/**
* default response
*/
default: PageTerm;
};
export type GetCartByExternalReferenceCodeDeliveryTermsPageResponse = GetCartByExternalReferenceCodeDeliveryTermsPageResponses[keyof GetCartByExternalReferenceCodeDeliveryTermsPageResponses];
export type GetCartByExternalReferenceCodePaymentTermsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/by-externalReferenceCode/{externalReferenceCode}/payment-terms';
};
export type GetCartByExternalReferenceCodePaymentTermsPageResponses = {
/**
* default response
*/
default: PageTerm;
};
export type GetCartByExternalReferenceCodePaymentTermsPageResponse = GetCartByExternalReferenceCodePaymentTermsPageResponses[keyof GetCartByExternalReferenceCodePaymentTermsPageResponses];
export type GetCartDeliveryTermsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/delivery-terms';
};
export type GetCartDeliveryTermsPageResponses = {
/**
* default response
*/
default: PageTerm;
};
export type GetCartDeliveryTermsPageResponse = GetCartDeliveryTermsPageResponses[keyof GetCartDeliveryTermsPageResponses];
export type GetCartPaymentTermsPageData = {
body?: never;
path: {
cartId: string;
};
query?: {
nestedFields?: string;
};
url: '/o/headless-commerce-delivery-cart/v1.0/carts/{cartId}/payment-terms';
};
export type GetCartPaymentTermsPageResponses = {
/**
* default response
*/
default: PageTerm;
};
export type GetCartPaymentTermsPageResponse = GetCartPaymentTermsPageResponses[keyof GetCartPaymentTermsPageResponses];
export type ClientOptions = {
baseUrl: 'http://localhost:8080' | (string & {});
};