liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
1,750 lines • 81.5 kB
TypeScript
export type Account = {
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
emailAddress?: string;
externalReferenceCode?: string;
id?: number;
logoId?: number;
name?: string;
root?: boolean;
taxId?: string;
type?: number;
readonly 'x-class-name'?: string;
};
export type BillingAddress = {
city: string;
countryISOCode: string;
description?: string;
readonly externalReferenceCode?: string;
id?: number;
latitude?: number;
longitude?: number;
name: string;
phoneNumber?: string;
regionISOCode?: string;
street1: string;
street2?: string;
street3?: string;
subtype?: string;
vatNumber?: string;
zip?: string;
readonly 'x-class-name'?: string;
};
export type Channel = {
currencyCode?: string;
externalReferenceCode?: string;
id?: number;
name?: string;
type?: string;
readonly 'x-class-name'?: string;
};
export type OrderAccountGroup = {
readonly id?: number;
name?: string;
readonly 'x-class-name'?: string;
};
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 OrderItem = {
bookedQuantityId?: number;
customFields?: Array<CustomField>;
decimalQuantity?: number;
/**
* @deprecated
*/
deliveryGroup?: string;
deliveryGroupName?: string;
discountAmount?: number;
readonly discountManuallyAdjusted?: boolean;
discountPercentageLevel1?: number;
discountPercentageLevel1WithTaxAmount?: number;
discountPercentageLevel2?: number;
discountPercentageLevel2WithTaxAmount?: number;
discountPercentageLevel3?: number;
discountPercentageLevel3WithTaxAmount?: number;
discountPercentageLevel4?: number;
discountPercentageLevel4WithTaxAmount?: number;
discountWithTaxAmount?: number;
externalReferenceCode?: string;
finalPrice?: number;
finalPriceWithTaxAmount?: number;
readonly formattedQuantity?: string;
id?: number;
name?: {
[key: string]: string;
};
options?: string;
orderExternalReferenceCode?: string;
orderId?: number;
readonly priceManuallyAdjusted?: boolean;
printedNote?: string;
promoPrice?: number;
promoPriceWithTaxAmount?: number;
quantity?: number;
readonly replacedSku?: string;
replacedSkuExternalReferenceCode?: string;
replacedSkuId?: number;
requestedDeliveryDate?: string;
readonly shippable?: boolean;
shippedQuantity?: number;
shippingAddress?: ShippingAddress;
shippingAddressExternalReferenceCode?: string;
shippingAddressId?: number;
sku?: string;
skuExternalReferenceCode?: string;
skuId?: number;
subscription?: boolean;
unitOfMeasure?: string;
unitOfMeasureKey?: string;
unitPrice?: number;
unitPriceWithTaxAmount?: number;
readonly virtualItemURLs?: Array<string>;
virtualItems?: Array<VirtualItem>;
readonly 'x-class-name'?: string;
};
export type PageOrderItem = {
items?: Array<OrderItem>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type ShippingAddress = {
city: string;
countryISOCode: string;
description?: string;
readonly externalReferenceCode?: string;
id?: number;
latitude?: number;
longitude?: number;
name: string;
phoneNumber?: string;
regionISOCode?: string;
street1: string;
street2?: string;
street3?: string;
subtype?: string;
zip?: string;
readonly 'x-class-name'?: string;
};
export type VirtualItem = {
url?: string;
usages?: number;
version?: string;
readonly 'x-class-name'?: string;
};
export type OrderNote = {
author?: string;
content?: string;
externalReferenceCode?: string;
id?: number;
orderExternalReferenceCode?: string;
orderId?: number;
restricted?: boolean;
readonly 'x-class-name'?: string;
};
export type PageOrderNote = {
items?: Array<OrderNote>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type Order = {
account?: Account;
accountExternalReferenceCode?: string;
accountId?: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
advanceStatus?: string;
billingAddress?: BillingAddress;
billingAddressExternalReferenceCode?: string;
billingAddressId?: number;
channel?: Channel;
channelExternalReferenceCode?: string;
channelId: number;
couponCode?: string;
createDate?: string;
creatorEmailAddress?: string;
currencyCode: string;
currencyExternalReferenceCode?: string;
currencyId?: number;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
readonly deliveryTermDescription?: string;
deliveryTermExternalReferenceCode?: string;
deliveryTermId?: number;
readonly deliveryTermName?: string;
externalReferenceCode?: string;
id?: number;
lastPriceUpdateDate?: string;
modifiedDate?: string;
name?: string;
orderDate?: string;
orderItems?: Array<OrderItem>;
orderStatus?: number;
orderStatusInfo?: Status;
orderTypeExternalReferenceCode?: string;
orderTypeId?: number;
paymentMethod?: string;
paymentStatus?: number;
paymentStatusInfo?: Status;
readonly paymentTermDescription?: string;
paymentTermExternalReferenceCode?: string;
paymentTermId?: number;
readonly paymentTermName?: string;
printedNote?: string;
purchaseOrderNumber?: string;
requestedDeliveryDate?: string;
readonly shippable?: boolean;
shippingAddress?: ShippingAddress;
shippingAddressExternalReferenceCode?: string;
shippingAddressId?: number;
shippingAmount?: number;
shippingAmountFormatted?: string;
shippingAmountValue?: number;
shippingDiscountAmount?: number;
shippingDiscountAmountFormatted?: string;
shippingDiscountAmountValue?: number;
shippingDiscountPercentageLevel1?: number;
shippingDiscountPercentageLevel1WithTaxAmount?: number;
shippingDiscountPercentageLevel2?: number;
shippingDiscountPercentageLevel2WithTaxAmount?: number;
shippingDiscountPercentageLevel3?: number;
shippingDiscountPercentageLevel3WithTaxAmount?: number;
shippingDiscountPercentageLevel4?: number;
shippingDiscountPercentageLevel4WithTaxAmount?: number;
shippingDiscountWithTaxAmount?: number;
shippingDiscountWithTaxAmountFormatted?: string;
shippingMethod?: string;
shippingOption?: string;
shippingWithTaxAmount?: number;
shippingWithTaxAmountFormatted?: string;
shippingWithTaxAmountValue?: number;
subtotal?: number;
readonly subtotalAmount?: number;
subtotalDiscountAmount?: number;
subtotalDiscountAmountFormatted?: string;
subtotalDiscountPercentageLevel1?: number;
subtotalDiscountPercentageLevel1WithTaxAmount?: number;
subtotalDiscountPercentageLevel2?: number;
subtotalDiscountPercentageLevel2WithTaxAmount?: number;
subtotalDiscountPercentageLevel3?: number;
subtotalDiscountPercentageLevel3WithTaxAmount?: number;
subtotalDiscountPercentageLevel4?: number;
subtotalDiscountPercentageLevel4WithTaxAmount?: number;
subtotalDiscountWithTaxAmount?: number;
subtotalDiscountWithTaxAmountFormatted?: string;
subtotalFormatted?: string;
subtotalWithTaxAmount?: number;
subtotalWithTaxAmountFormatted?: string;
readonly subtotalWithTaxAmountValue?: number;
taxAmount?: number;
taxAmountFormatted?: string;
taxAmountValue?: number;
total?: number;
readonly totalAmount?: number;
totalDiscountAmount?: number;
totalDiscountAmountFormatted?: string;
totalDiscountAmountValue?: number;
totalDiscountPercentageLevel1?: number;
totalDiscountPercentageLevel1WithTaxAmount?: number;
totalDiscountPercentageLevel2?: number;
totalDiscountPercentageLevel2WithTaxAmount?: number;
totalDiscountPercentageLevel3?: number;
totalDiscountPercentageLevel3WithTaxAmount?: number;
totalDiscountPercentageLevel4?: number;
totalDiscountPercentageLevel4WithTaxAmount?: number;
totalDiscountWithTaxAmount?: number;
totalDiscountWithTaxAmountFormatted?: string;
totalDiscountWithTaxAmountValue?: number;
totalFormatted?: string;
totalWithTaxAmount?: number;
totalWithTaxAmountFormatted?: string;
readonly totalWithTaxAmountValue?: number;
transactionId?: string;
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 PageOrder = {
items?: Array<Order>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type OrderRuleAccountGroup = {
accountGroup?: OrderAccountGroup;
accountGroupExternalReferenceCode?: string;
accountGroupId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly orderRuleAccountGroupId?: number;
orderRuleExternalReferenceCode?: string;
orderRuleId: number;
readonly 'x-class-name'?: string;
};
export type PageOrderRuleAccountGroup = {
items?: Array<OrderRuleAccountGroup>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type OrderRuleAccount = {
account?: Account;
accountExternalReferenceCode?: string;
accountId: number;
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
readonly orderRuleAccountId?: number;
orderRuleExternalReferenceCode?: string;
orderRuleId: number;
readonly 'x-class-name'?: string;
};
export type PageOrderRuleAccount = {
items?: Array<OrderRuleAccount>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type OrderRuleChannel = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
channel?: Channel;
channelExternalReferenceCode?: string;
channelId: number;
readonly orderRuleChannelId?: number;
orderRuleExternalReferenceCode?: string;
orderRuleId: number;
readonly 'x-class-name'?: string;
};
export type PageOrderRuleChannel = {
items?: Array<OrderRuleChannel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type OrderRuleOrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
orderRuleExternalReferenceCode?: string;
orderRuleId: number;
readonly orderRuleOrderTypeId?: number;
orderType?: OrderType;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
readonly 'x-class-name'?: string;
};
export type OrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
customFields?: {
[key: string]: {
[key: string]: unknown;
};
};
description?: {
[key: string]: string;
};
displayDate?: string;
displayOrder?: number;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
name: {
[key: string]: string;
};
neverExpire?: boolean;
orderTypeChannels?: Array<OrderTypeChannel>;
workflowStatusInfo?: Status;
readonly 'x-class-name'?: string;
};
export type OrderTypeChannel = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
channel?: Channel;
channelExternalReferenceCode?: string;
channelId: number;
readonly orderTypeChannelId?: number;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
readonly 'x-class-name'?: string;
};
export type PageOrderRuleOrderType = {
items?: Array<OrderRuleOrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type OrderRule = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
author?: string;
createDate?: string;
description?: string;
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
name: string;
neverExpire?: boolean;
orderRuleAccount?: Array<OrderRuleAccount>;
orderRuleAccountGroup?: Array<OrderRuleAccountGroup>;
orderRuleChannel?: Array<OrderRuleChannel>;
orderRuleOrderType?: Array<OrderRuleOrderType>;
priority?: number;
type: string;
typeSettings?: string;
workflowStatusInfo?: Status;
readonly 'x-class-name'?: string;
};
export type PageOrderRule = {
items?: Array<OrderRule>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageOrderTypeChannel = {
items?: Array<OrderTypeChannel>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageOrderType = {
items?: Array<OrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type PageTermOrderType = {
items?: Array<TermOrderType>;
lastPage?: number;
totalCount?: number;
actions?: {
[key: string]: {
[key: string]: string;
};
};
page?: number;
facets?: Array<Facet>;
pageSize?: number;
};
export type TermOrderType = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
orderType?: OrderType;
orderTypeExternalReferenceCode?: string;
orderTypeId: number;
termExternalReferenceCode?: string;
termId: number;
readonly termOrderTypeId?: number;
readonly 'x-class-name'?: string;
};
export type Term = {
readonly actions?: {
[key: string]: {
[key: string]: string;
};
};
active?: boolean;
createDate?: string;
description?: {
[key: string]: string;
};
displayDate?: string;
expirationDate?: string;
externalReferenceCode?: string;
id?: number;
label?: {
[key: string]: string;
};
name: string;
neverExpire?: boolean;
priority?: number;
termOrderType?: Array<TermOrderType>;
type: string;
typeLocalized?: string;
typeSettings?: string;
workflowStatusInfo?: Status;
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 GetOrderByExternalReferenceCodeAccountData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/account';
};
export type GetOrderByExternalReferenceCodeAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetOrderByExternalReferenceCodeAccountResponse = GetOrderByExternalReferenceCodeAccountResponses[keyof GetOrderByExternalReferenceCodeAccountResponses];
export type GetOrderIdAccountData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/account';
};
export type GetOrderIdAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetOrderIdAccountResponse = GetOrderIdAccountResponses[keyof GetOrderIdAccountResponses];
export type GetOrderRuleAccountAccountData = {
body?: never;
path: {
orderRuleAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rule-accounts/{orderRuleAccountId}/account';
};
export type GetOrderRuleAccountAccountResponses = {
/**
* default response
*/
default: Account;
};
export type GetOrderRuleAccountAccountResponse = GetOrderRuleAccountAccountResponses[keyof GetOrderRuleAccountAccountResponses];
export type GetOrderByExternalReferenceCodeBillingAddressData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/billingAddress';
};
export type GetOrderByExternalReferenceCodeBillingAddressResponses = {
/**
* default response
*/
default: BillingAddress;
};
export type GetOrderByExternalReferenceCodeBillingAddressResponse = GetOrderByExternalReferenceCodeBillingAddressResponses[keyof GetOrderByExternalReferenceCodeBillingAddressResponses];
export type PatchOrderByExternalReferenceCodeBillingAddressData = {
body?: BillingAddress;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/billingAddress';
};
export type PatchOrderByExternalReferenceCodeBillingAddressResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderIdBillingAddressData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/billingAddress';
};
export type GetOrderIdBillingAddressResponses = {
/**
* default response
*/
default: BillingAddress;
};
export type GetOrderIdBillingAddressResponse = GetOrderIdBillingAddressResponses[keyof GetOrderIdBillingAddressResponses];
export type PatchOrderIdBillingAddressData = {
body?: BillingAddress;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/billingAddress';
};
export type PatchOrderIdBillingAddressResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderByExternalReferenceCodeChannelData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/channel';
};
export type GetOrderByExternalReferenceCodeChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetOrderByExternalReferenceCodeChannelResponse = GetOrderByExternalReferenceCodeChannelResponses[keyof GetOrderByExternalReferenceCodeChannelResponses];
export type GetOrderIdChannelData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/channel';
};
export type GetOrderIdChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetOrderIdChannelResponse = GetOrderIdChannelResponses[keyof GetOrderIdChannelResponses];
export type GetOrderRuleChannelChannelData = {
body?: never;
path: {
orderRuleChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rule-channels/{orderRuleChannelId}/channel';
};
export type GetOrderRuleChannelChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetOrderRuleChannelChannelResponse = GetOrderRuleChannelChannelResponses[keyof GetOrderRuleChannelChannelResponses];
export type GetOrderTypeChannelChannelData = {
body?: never;
path: {
orderTypeChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-type-channels/{orderTypeChannelId}/channel';
};
export type GetOrderTypeChannelChannelResponses = {
/**
* default response
*/
default: Channel;
};
export type GetOrderTypeChannelChannelResponse = GetOrderTypeChannelChannelResponses[keyof GetOrderTypeChannelChannelResponses];
export type GetOrderRuleAccountGroupAccountGroupData = {
body?: never;
path: {
orderRuleAccountGroupId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rule-account-groups/{orderRuleAccountGroupId}/account-group';
};
export type GetOrderRuleAccountGroupAccountGroupResponses = {
/**
* default response
*/
default: OrderAccountGroup;
};
export type GetOrderRuleAccountGroupAccountGroupResponse = GetOrderRuleAccountGroupAccountGroupResponses[keyof GetOrderRuleAccountGroupAccountGroupResponses];
export type DeleteOrderItemData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/{id}';
};
export type DeleteOrderItemResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderItemData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/{id}';
};
export type GetOrderItemResponses = {
/**
* default response
*/
default: OrderItem;
};
export type GetOrderItemResponse = GetOrderItemResponses[keyof GetOrderItemResponses];
export type PatchOrderItemData = {
body?: OrderItem;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/{id}';
};
export type PatchOrderItemResponses = {
/**
* default response
*/
default: OrderItem;
};
export type PatchOrderItemResponse = PatchOrderItemResponses[keyof PatchOrderItemResponses];
export type PutOrderItemData = {
body?: OrderItem;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/{id}';
};
export type PutOrderItemResponses = {
/**
* default response
*/
default: OrderItem;
};
export type PutOrderItemResponse = PutOrderItemResponses[keyof PutOrderItemResponses];
export type DeleteOrderItemBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orderItems/batch';
};
export type DeleteOrderItemBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PutOrderItemBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orderItems/batch';
};
export type PutOrderItemBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderItemByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteOrderItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderItemByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetOrderItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: OrderItem;
};
export type GetOrderItemByExternalReferenceCodeResponse = GetOrderItemByExternalReferenceCodeResponses[keyof GetOrderItemByExternalReferenceCodeResponses];
export type PatchOrderItemByExternalReferenceCodeData = {
body?: OrderItem;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchOrderItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: OrderItem;
};
export type PatchOrderItemByExternalReferenceCodeResponse = PatchOrderItemByExternalReferenceCodeResponses[keyof PatchOrderItemByExternalReferenceCodeResponses];
export type PutOrderItemByExternalReferenceCodeData = {
body?: OrderItem;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderItems/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutOrderItemByExternalReferenceCodeResponses = {
/**
* default response
*/
default: OrderItem;
};
export type PutOrderItemByExternalReferenceCodeResponse = PutOrderItemByExternalReferenceCodeResponses[keyof PutOrderItemByExternalReferenceCodeResponses];
export type GetOrderByExternalReferenceCodeOrderItemsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/orderItems';
};
export type GetOrderByExternalReferenceCodeOrderItemsPageResponses = {
/**
* default response
*/
default: PageOrderItem;
};
export type GetOrderByExternalReferenceCodeOrderItemsPageResponse = GetOrderByExternalReferenceCodeOrderItemsPageResponses[keyof GetOrderByExternalReferenceCodeOrderItemsPageResponses];
export type PostOrderByExternalReferenceCodeOrderItemData = {
body?: OrderItem;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/orderItems';
};
export type PostOrderByExternalReferenceCodeOrderItemResponses = {
/**
* default response
*/
default: OrderItem;
};
export type PostOrderByExternalReferenceCodeOrderItemResponse = PostOrderByExternalReferenceCodeOrderItemResponses[keyof PostOrderByExternalReferenceCodeOrderItemResponses];
export type GetOrderIdOrderItemsPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/orderItems';
};
export type GetOrderIdOrderItemsPageResponses = {
/**
* default response
*/
default: PageOrderItem;
};
export type GetOrderIdOrderItemsPageResponse = GetOrderIdOrderItemsPageResponses[keyof GetOrderIdOrderItemsPageResponses];
export type PostOrderIdOrderItemData = {
body?: OrderItem;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/orderItems';
};
export type PostOrderIdOrderItemResponses = {
/**
* default response
*/
default: OrderItem;
};
export type PostOrderIdOrderItemResponse = PostOrderIdOrderItemResponses[keyof PostOrderIdOrderItemResponses];
export type GetOrderItemsPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orderItems';
};
export type GetOrderItemsPageResponses = {
/**
* default response
*/
default: PageOrderItem;
};
export type GetOrderItemsPageResponse = GetOrderItemsPageResponses[keyof GetOrderItemsPageResponses];
export type PostOrderIdOrderItemBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/orderItems/batch';
};
export type PostOrderIdOrderItemBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostOrderItemsPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orderItems/export-batch';
};
export type PostOrderItemsPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderNoteData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/{id}';
};
export type DeleteOrderNoteResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderNoteData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/{id}';
};
export type GetOrderNoteResponses = {
/**
* default response
*/
default: OrderNote;
};
export type GetOrderNoteResponse = GetOrderNoteResponses[keyof GetOrderNoteResponses];
export type PatchOrderNoteData = {
body?: OrderNote;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/{id}';
};
export type PatchOrderNoteResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderNoteBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/batch';
};
export type DeleteOrderNoteBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderNoteByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteOrderNoteByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderNoteByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetOrderNoteByExternalReferenceCodeResponses = {
/**
* default response
*/
default: OrderNote;
};
export type GetOrderNoteByExternalReferenceCodeResponse = GetOrderNoteByExternalReferenceCodeResponses[keyof GetOrderNoteByExternalReferenceCodeResponses];
export type PatchOrderNoteByExternalReferenceCodeData = {
body?: OrderNote;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orderNotes/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchOrderNoteByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderByExternalReferenceCodeOrderNotesPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/orderNotes';
};
export type GetOrderByExternalReferenceCodeOrderNotesPageResponses = {
/**
* default response
*/
default: PageOrderNote;
};
export type GetOrderByExternalReferenceCodeOrderNotesPageResponse = GetOrderByExternalReferenceCodeOrderNotesPageResponses[keyof GetOrderByExternalReferenceCodeOrderNotesPageResponses];
export type PostOrderByExternalReferenceCodeOrderNoteData = {
body?: OrderNote;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}/orderNotes';
};
export type PostOrderByExternalReferenceCodeOrderNoteResponses = {
/**
* default response
*/
default: OrderNote;
};
export type PostOrderByExternalReferenceCodeOrderNoteResponse = PostOrderByExternalReferenceCodeOrderNoteResponses[keyof PostOrderByExternalReferenceCodeOrderNoteResponses];
export type GetOrderIdOrderNotesPageData = {
body?: never;
path: {
id: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/orderNotes';
};
export type GetOrderIdOrderNotesPageResponses = {
/**
* default response
*/
default: PageOrderNote;
};
export type GetOrderIdOrderNotesPageResponse = GetOrderIdOrderNotesPageResponses[keyof GetOrderIdOrderNotesPageResponses];
export type PostOrderIdOrderNoteData = {
body?: OrderNote;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}/orderNotes';
};
export type PostOrderIdOrderNoteResponses = {
/**
* default response
*/
default: OrderNote;
};
export type PostOrderIdOrderNoteResponse = PostOrderIdOrderNoteResponses[keyof PostOrderIdOrderNoteResponses];
export type PostOrderIdOrderNoteBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/orderNotes/batch';
};
export type PostOrderIdOrderNoteBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}';
};
export type DeleteOrderResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderData = {
body?: never;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}';
};
export type GetOrderResponses = {
/**
* default response
*/
default: Order;
};
export type GetOrderResponse = GetOrderResponses[keyof GetOrderResponses];
export type PatchOrderData = {
body?: Order;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/{id}';
};
export type PatchOrderResponses = {
/**
* default response
*/
default: Order;
};
export type PatchOrderResponse = PatchOrderResponses[keyof PatchOrderResponses];
export type DeleteOrderBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/batch';
};
export type DeleteOrderBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type PostOrderBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/batch';
};
export type PostOrderBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}';
};
export type DeleteOrderByExternalReferenceCodeResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderByExternalReferenceCodeData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}';
};
export type GetOrderByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Order;
};
export type GetOrderByExternalReferenceCodeResponse = GetOrderByExternalReferenceCodeResponses[keyof GetOrderByExternalReferenceCodeResponses];
export type PatchOrderByExternalReferenceCodeData = {
body?: Order;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}';
};
export type PatchOrderByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Order;
};
export type PatchOrderByExternalReferenceCodeResponse = PatchOrderByExternalReferenceCodeResponses[keyof PatchOrderByExternalReferenceCodeResponses];
export type PutOrderByExternalReferenceCodeData = {
body?: Order;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders/by-externalReferenceCode/{externalReferenceCode}';
};
export type PutOrderByExternalReferenceCodeResponses = {
/**
* default response
*/
default: Order;
};
export type PutOrderByExternalReferenceCodeResponse = PutOrderByExternalReferenceCodeResponses[keyof PutOrderByExternalReferenceCodeResponses];
export type GetOrdersPageData = {
body?: never;
path?: never;
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders';
};
export type GetOrdersPageResponses = {
/**
* default response
*/
default: PageOrder;
};
export type GetOrdersPageResponse = GetOrdersPageResponses[keyof GetOrdersPageResponses];
export type PostOrderData = {
body?: Order;
path?: never;
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/orders';
};
export type PostOrderResponses = {
/**
* default response
*/
default: Order;
};
export type PostOrderResponse = PostOrderResponses[keyof PostOrderResponses];
export type PostOrdersPageExportBatchData = {
body?: never;
path?: never;
query?: {
filter?: string;
search?: string;
sort?: string;
callbackURL?: string;
contentType?: string;
fieldNames?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/orders/export-batch';
};
export type PostOrdersPageExportBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderRuleAccountGroupData = {
body?: never;
path: {
orderRuleAccountGroupId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rule-account-groups/{orderRuleAccountGroupId}';
};
export type DeleteOrderRuleAccountGroupResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderRuleAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rule-account-groups/batch';
};
export type DeleteOrderRuleAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleAccountGroupsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/by-externalReferenceCode/{externalReferenceCode}/order-rule-account-groups';
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleAccountGroupsPageResponses = {
/**
* default response
*/
default: PageOrderRuleAccountGroup;
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleAccountGroupsPageResponse = GetOrderRuleByExternalReferenceCodeOrderRuleAccountGroupsPageResponses[keyof GetOrderRuleByExternalReferenceCodeOrderRuleAccountGroupsPageResponses];
export type PostOrderRuleByExternalReferenceCodeOrderRuleAccountGroupData = {
body?: OrderRuleAccountGroup;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rules/by-externalReferenceCode/{externalReferenceCode}/order-rule-account-groups';
};
export type PostOrderRuleByExternalReferenceCodeOrderRuleAccountGroupResponses = {
/**
* default response
*/
default: OrderRuleAccountGroup;
};
export type PostOrderRuleByExternalReferenceCodeOrderRuleAccountGroupResponse = PostOrderRuleByExternalReferenceCodeOrderRuleAccountGroupResponses[keyof PostOrderRuleByExternalReferenceCodeOrderRuleAccountGroupResponses];
export type GetOrderRuleIdOrderRuleAccountGroupsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/{id}/order-rule-account-groups';
};
export type GetOrderRuleIdOrderRuleAccountGroupsPageResponses = {
/**
* default response
*/
default: PageOrderRuleAccountGroup;
};
export type GetOrderRuleIdOrderRuleAccountGroupsPageResponse = GetOrderRuleIdOrderRuleAccountGroupsPageResponses[keyof GetOrderRuleIdOrderRuleAccountGroupsPageResponses];
export type PostOrderRuleIdOrderRuleAccountGroupData = {
body?: OrderRuleAccountGroup;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rules/{id}/order-rule-account-groups';
};
export type PostOrderRuleIdOrderRuleAccountGroupResponses = {
/**
* default response
*/
default: OrderRuleAccountGroup;
};
export type PostOrderRuleIdOrderRuleAccountGroupResponse = PostOrderRuleIdOrderRuleAccountGroupResponses[keyof PostOrderRuleIdOrderRuleAccountGroupResponses];
export type PostOrderRuleIdOrderRuleAccountGroupBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/order-rule-account-groups/batch';
};
export type PostOrderRuleIdOrderRuleAccountGroupBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderRuleAccountData = {
body?: never;
path: {
orderRuleAccountId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rule-accounts/{orderRuleAccountId}';
};
export type DeleteOrderRuleAccountResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderRuleAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rule-accounts/batch';
};
export type DeleteOrderRuleAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleAccountsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/by-externalReferenceCode/{externalReferenceCode}/order-rule-accounts';
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleAccountsPageResponses = {
/**
* default response
*/
default: PageOrderRuleAccount;
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleAccountsPageResponse = GetOrderRuleByExternalReferenceCodeOrderRuleAccountsPageResponses[keyof GetOrderRuleByExternalReferenceCodeOrderRuleAccountsPageResponses];
export type PostOrderRuleByExternalReferenceCodeOrderRuleAccountData = {
body?: OrderRuleAccount;
path: {
externalReferenceCode: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rules/by-externalReferenceCode/{externalReferenceCode}/order-rule-accounts';
};
export type PostOrderRuleByExternalReferenceCodeOrderRuleAccountResponses = {
/**
* default response
*/
default: OrderRuleAccount;
};
export type PostOrderRuleByExternalReferenceCodeOrderRuleAccountResponse = PostOrderRuleByExternalReferenceCodeOrderRuleAccountResponses[keyof PostOrderRuleByExternalReferenceCodeOrderRuleAccountResponses];
export type GetOrderRuleIdOrderRuleAccountsPageData = {
body?: never;
path: {
id: string;
};
query?: {
filter?: string;
page?: string;
pageSize?: string;
search?: string;
sort?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/{id}/order-rule-accounts';
};
export type GetOrderRuleIdOrderRuleAccountsPageResponses = {
/**
* default response
*/
default: PageOrderRuleAccount;
};
export type GetOrderRuleIdOrderRuleAccountsPageResponse = GetOrderRuleIdOrderRuleAccountsPageResponses[keyof GetOrderRuleIdOrderRuleAccountsPageResponses];
export type PostOrderRuleIdOrderRuleAccountData = {
body?: OrderRuleAccount;
path: {
id: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rules/{id}/order-rule-accounts';
};
export type PostOrderRuleIdOrderRuleAccountResponses = {
/**
* default response
*/
default: OrderRuleAccount;
};
export type PostOrderRuleIdOrderRuleAccountResponse = PostOrderRuleIdOrderRuleAccountResponses[keyof PostOrderRuleIdOrderRuleAccountResponses];
export type PostOrderRuleIdOrderRuleAccountBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/order-rule-accounts/batch';
};
export type PostOrderRuleIdOrderRuleAccountBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderRuleChannelData = {
body?: never;
path: {
orderRuleChannelId: string;
};
query?: never;
url: '/o/headless-commerce-admin-order/v1.0/order-rule-channels/{orderRuleChannelId}';
};
export type DeleteOrderRuleChannelResponses = {
/**
* default response
*/
default: unknown;
};
export type DeleteOrderRuleChannelBatchData = {
body?: {
[key: string]: unknown;
};
path?: never;
query?: {
callbackURL?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rule-channels/batch';
};
export type DeleteOrderRuleChannelBatchResponses = {
/**
* default response
*/
default: unknown;
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleChannelsPageData = {
body?: never;
path: {
externalReferenceCode: string;
};
query?: {
page?: string;
pageSize?: string;
nestedFields?: string;
};
url: '/o/headless-commerce-admin-order/v1.0/order-rules/by-externalReferenceCode/{externalReferenceCode}/order-rule-channels';
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleChannelsPageResponses = {
/**
* default response
*/
default: PageOrderRuleChannel;
};
export type GetOrderRuleByExternalReferenceCodeOrderRuleChannelsPageResponse = GetOrderRuleByExternalReferenceCodeOrderRuleChannelsPageResponses[keyof GetOrderRuleByExternalReferenceCodeOrderRuleChannelsPageResponses];
export type PostOrderRuleByExternalRef