@wix/ecom 1.0.504 → 1.0.505

package/build/es/src/ecom-v1-order.types.d.ts

@@ -120,6 +120,8 @@ export interface Order {
      * + No shipping option is selected.
      */
     recipientInfo?: AddressWithContact;
+    /** Tag ids collections associated with current entity. private_tags requires separate permissions to be accessible and modifiable. */
+    tags?: Tags;
 }
 export interface OrderLineItem {
     /** Line item ID. */
@@ -1107,6 +1109,38 @@ export interface ExtendedFields {
      */
     namespaces?: Record<string, Record<string, any>>;
 }
+/**
+ * Common object for tags.
+ * Should be use as in this example:
+ * message Foo {
+ * string id = 1;
+ * ...
+ * Tags tags = 5
+ * }
+ *
+ * example of taggable entity
+ * {
+ * id: "123"
+ * tags: {
+ * tags: {
+ * tag_ids:["11","22"]
+ * },
+ * private_tags: {
+ * tag_ids: ["33", "44"]
+ * }
+ * }
+ * }
+ */
+export interface Tags {
+    /** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
+    privateTags?: TagList;
+    /** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
+    tags?: TagList;
+}
+export interface TagList {
+    /** List of tag IDs */
+    tagIds?: string[];
+}
 export interface TriggerReindexWithConsistencyRequest {
     metasiteId?: string;
     orderId?: string;
@@ -2002,827 +2036,644 @@ export interface PreviewResendDownloadLinksEmailRequest {
 export interface PreviewResendDownloadLinksEmailResponse {
     emailPreview?: string;
 }
-export interface InvoicePaidEvent {
-    id?: IdAndVersion;
-    /** @readonly */
-    data?: InvoiceFields;
-    /** @readonly */
-    status?: InvoiceStatus;
-}
-export interface IdAndVersion {
-    id?: string | null;
-    version?: number | null;
-}
-export interface InvoiceFields {
-    /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
-    number?: string | null;
-    /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
-    currencyCode?: string | null;
-    /** The invoice customer. The customer must be a contact of the site, with an email. */
-    customer?: Customer;
-    /**
-     * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
-     * Last seen date is the optional date when the invoice was last seen be UoU.
-     */
-    dates?: InvoiceDates;
-    /**
-     * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
-     * and quantity. There must be at least one line item on the invoice.
-     */
-    lineItems?: LineItems;
-    /**
-     * Locale of the invoice, containing the language.
-     * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
-     * on the invoice.
-     */
-    locale?: Locale;
-    /**
-     * The totals on the invoice.
-     * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
-     * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
-     * The totals contain fees and a discount, that apply to the invoice.
-     */
-    totals?: TotalPrice;
-    /** An optional discount on the invoice. */
-    discount?: Discount;
-    /** The taxes of the invoice. */
-    taxes?: CalculatedTaxes;
-    /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
-    payments?: Payments;
-    /** Invoice metadata */
-    metaData?: MetaData;
-    /** Not used */
-    creationAdditional_BIInformation?: string | null;
+export interface PreparePaymentCollectionRequest {
+    /** Ecom order ID. */
+    ecomOrderId?: string;
+    /** Amount to collect */
+    amount?: Price;
     /**
-     * The balance and amount paid on the invoice.
-     * This read-only field is calculated based on the invoice totals and payments.
-     * @readonly
+     * Optional parameter. When present, payment collection will be performed using given payment gateway order.
+     * Existing payment gateway order will be updated with a new amount.
+     * When parameter is absent, new payment gateway order will be created and used for payment collection.
      */
-    dynamicTotals?: InvoiceDynamicPriceTotals;
-    /** The invoice title */
-    title?: string | null;
-    /** Invoice custom fields */
-    customFields?: CustomFieldValue[];
-    /** Not used */
-    designTemplateId?: string | null;
-    /** Not used */
-    createOrder?: boolean | null;
-    /** The optional deposit of the invoice */
-    deposit?: Deposit;
-    /** associated checkout for this invoice */
-    ecomCheckoutId?: string | null;
-}
-export interface Customer {
-    contactId?: string | null;
-    name?: string | null;
-    email?: Email;
-    address?: QuotesAddress;
-    phone?: Phone;
-    company?: Company;
-    firstName?: string | null;
-    lastName?: string | null;
-    billingAddress?: CommonAddress;
-    shippingAddress?: CommonAddress;
+    paymentGatewayOrderId?: string | null;
 }
-export interface Email {
-    address?: string;
+export interface PreparePaymentCollectionResponse {
+    /** Payment gateway order id which is associated with given payment */
+    paymentGatewayOrderId?: string;
 }
-export interface QuotesAddress {
-    street?: string | null;
-    city?: string | null;
-    zip?: string | null;
-    state?: string | null;
-    country?: string | null;
-    /** @readonly */
-    description?: AddressDescription;
+export interface GetPaymentCollectabilityStatusRequest {
+    /** Ecom order ID. */
+    ecomOrderId?: string;
 }
-export interface AddressDescription {
-    content?: string;
-    placement?: Placement;
+export interface GetPaymentCollectabilityStatusResponse {
+    /** Payment collectability status */
+    status?: PaymentCollectabilityStatus;
+    /** Collectable order amount */
+    amount?: Price;
 }
-export declare enum Placement {
-    Unknown = "Unknown",
-    Replace = "Replace",
-    Before = "Before",
-    After = "After"
+export declare enum PaymentCollectabilityStatus {
+    UNKNOWN = "UNKNOWN",
+    COLLECTABLE = "COLLECTABLE",
+    NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
+    NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
+    NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
 }
-export interface Phone {
-    number?: string;
+export interface RecordManuallyCollectedPaymentRequest {
+    /** Order ID. */
+    orderId?: string;
+    /** Amount to be recorded as approved manual payment for given order */
+    amount?: Price;
 }
-export interface Company {
-    name?: string;
-    id?: string | null;
+export interface RecordManuallyCollectedPaymentResponse {
 }
-/** Physical address */
-export interface CommonAddress extends CommonAddressStreetOneOf {
-    /** Street name and number. */
-    streetAddress?: StreetAddress;
-    /** Main address line, usually street and number as free text. */
-    addressLine?: string | null;
-    /** Country code. */
-    country?: string | null;
-    /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
-    subdivision?: string | null;
-    /** City name. */
-    city?: string | null;
-    /** Zip/postal code. */
-    postalCode?: string | null;
-    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
-    addressLine2?: string | null;
+export interface V1MarkOrderAsPaidRequest {
+    /** Ecom order ID. */
+    ecomOrderId?: string;
 }
-/** @oneof */
-export interface CommonAddressStreetOneOf {
-    /** Street name and number. */
-    streetAddress?: StreetAddress;
-    /** Main address line, usually street and number as free text. */
-    addressLine?: string | null;
+export interface V1MarkOrderAsPaidResponse {
+    /** Updated order. */
+    order?: Order;
 }
-export interface Subdivision {
-    /** Short subdivision code. */
-    code?: string;
-    /** Subdivision full name. */
-    name?: string;
+/** Triggered when the payment status of an order is updated */
+export interface PaymentStatusUpdated {
+    /** The order that was updated */
+    order?: Order;
+    /** The previous status (before the update) */
+    previousPaymentStatus?: PaymentStatus;
 }
-export declare enum SubdivisionType {
-    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
-    /** State */
-    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
-    /** County */
-    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
-    /** City/town */
-    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
-    /** Neighborhood/quarter */
-    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
-    /** Street/block */
-    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
-    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
-    COUNTRY = "COUNTRY"
+export interface V1BulkMarkOrdersAsPaidRequest {
+    /** IDs of orders to mark as paid. */
+    ecomOrderIds?: string[];
 }
-export interface InvoiceDates {
-    /** use UTC midnight date to set the issue date according to the site time zone */
-    issueDate?: Date;
-    /** use UTC midnight date to set the due date according to the site time zone */
-    dueDate?: Date;
-    /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
-    timeZoneCode?: string | null;
+export interface V1BulkMarkOrdersAsPaidResponse {
     /**
-     * ignored in request use in response to get the site time zone
-     * @readonly
+     * Items updated by the bulk action.
+     * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
      */
-    lastSeenDate?: Date;
-}
-export interface LineItems {
-    lineItems?: LineItem[];
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
 }
-export interface LineItem {
-    id?: string;
-    name?: string;
-    description?: string | null;
-    price?: BigDecimalWrapper;
-    taxedTotal?: BigDecimalWrapper;
-    quantity?: BigDecimalWrapper;
-    taxes?: LineItemTax[];
-    /** The source of the line item */
-    source?: Source;
-    /** The line-item level metadata. */
-    metadata?: LineItemMetaData;
+export interface BulkOrderResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
+    /** Updated item. Optional - returned only if requested with `return_full_entity` set to `true`. */
+    item?: Order;
 }
-export interface BigDecimalWrapper {
-    serializedValue?: number;
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
 }
-export interface LineItemTax {
-    name?: string;
-    rate?: BigDecimalWrapper;
-    code?: string | null;
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
 }
-export interface Source {
-    /**
-     * Source app or service ID.
-     * @readonly
-     */
-    sourceId?: string;
-    /**
-     * App or service type.
-     * @readonly
-     */
-    sourceType?: SourceType;
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
 }
-export declare enum SourceType {
-    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
-    WIX_APP = "WIX_APP",
-    EXTERNAL = "EXTERNAL",
-    ADMIN = "ADMIN",
-    OTHER = "OTHER"
+export interface GetRefundabilityStatusRequest {
+    /** Order ID. */
+    ecomOrderId?: string;
 }
-export interface LineItemMetaData {
-    metadata?: Record<string, string>;
+export interface GetRefundabilityStatusResponse {
+    /** Refundability details. */
+    refundabilities?: Refundability[];
+    /** Whether the order supports refunding per item. */
+    refundablePerItem?: boolean;
 }
-export interface Locale {
-    /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
-    language?: string;
-    /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
-    country?: string | null;
-    invariant?: string | null;
+export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
+    /** Reason why payment is not refundable. */
+    nonRefundableReason?: NonRefundableReason;
+    /** Reason why payment is only refundable manually. */
+    manuallyRefundableReason?: ManuallyRefundableReason;
+    /** Payment ID. */
+    paymentId?: string;
+    /** Payment refundability status. */
+    refundabilityStatus?: RefundableStatus;
+    /** Link to payment provider dashboard. */
+    providerLink?: string | null;
 }
-export interface TotalPrice {
-    /** the subtotal of the line items without the tax reduction */
-    subtotal?: BigDecimalWrapper;
-    /** the total price taking into account the itemized fees and the taxes */
-    total?: BigDecimalWrapper;
-    fees?: ItemizedFee[];
-    discountAmount?: BigDecimalWrapper;
-    taxedAmount?: BigDecimalWrapper;
+/** @oneof */
+export interface RefundabilityAdditionalRefundabilityInfoOneOf {
+    /** Reason why payment is not refundable. */
+    nonRefundableReason?: NonRefundableReason;
+    /** Reason why payment is only refundable manually. */
+    manuallyRefundableReason?: ManuallyRefundableReason;
 }
-export interface ItemizedFee {
-    name?: string;
-    price?: BigDecimalWrapper;
+export declare enum RefundableStatus {
+    NOT_REFUNDABLE = "NOT_REFUNDABLE",
+    MANUAL = "MANUAL",
+    REFUNDABLE = "REFUNDABLE"
 }
-export interface Discount extends DiscountOneDiscountTypeOneOf {
-    /** Discount as percentage value. */
-    percentage?: BigDecimalWrapper;
+export declare enum NonRefundableReason {
+    NONE = "NONE",
+    ALREADY_REFUNDED = "ALREADY_REFUNDED",
+    PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
+    INTERNAL_ERROR = "INTERNAL_ERROR",
+    NOT_PAID = "NOT_PAID",
+    ACCESS_DENIED = "ACCESS_DENIED",
+    ZERO_PRICE = "ZERO_PRICE",
+    DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
+    PENDING_REFUND = "PENDING_REFUND",
+    FORBIDDEN = "FORBIDDEN",
+    TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND"
 }
-/** @oneof */
-export interface DiscountOneDiscountTypeOneOf {
-    /** Discount as percentage value. */
-    percentage?: BigDecimalWrapper;
+export declare enum ManuallyRefundableReason {
+    EXPIRED = "EXPIRED",
+    NOT_SUPPORTED = "NOT_SUPPORTED",
+    OFFLINE = "OFFLINE"
 }
-export interface CalculatedTaxes {
-    /** consider calculated or not - cannot enforce set */
-    taxes?: CalculatedTax[];
+export interface V1CreatePaymentGatewayOrderRequest {
+    /** Ecom order ID. */
+    ecomOrderId?: string;
+    /** Information about the user who initiated the payment. */
+    chargedBy?: ChargedBy;
 }
-export interface CalculatedTax {
-    name?: string;
-    rate?: BigDecimalWrapper;
-    /** the costs on which the taxes are applied */
-    taxable?: BigDecimalWrapper;
-    /** the taxes as a result of the */
-    taxed?: BigDecimalWrapper;
-    code?: string | null;
+export interface ChargedBy {
+    /** ID - id of the user who initiated the payment */
+    id?: string;
+    /** Full name - name of the user who initiated the payment */
+    fullName?: string | null;
 }
-export interface Payments {
-    payments?: Payment[];
+export interface V1CreatePaymentGatewayOrderResponse {
+    /** ID of the order created in the payment gateway */
+    paymentGatewayOrderId?: string;
 }
-export interface Payment {
-    /** document */
-    id?: string;
-    type?: string;
-    amount?: BigDecimalWrapper;
-    date?: Date;
+export interface ChargeMembershipsRequest {
+    /** Order ID. */
+    ecomOrderId?: string;
     /**
-     * The orderId of the order in cashier associated with the payment.
-     * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
+     * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
+     * but a user which is using the membership on behalf of the a member
      */
-    orderId?: string | null;
+    memberId?: string;
+    /** List of items to be paid by memberships */
+    membershipCharges?: MembershipChargeItem[];
+}
+export interface MembershipChargeItem {
+    /** The id of used membership */
+    membershipId?: string;
+    /** ID of the application providing this payment option */
+    appId?: string;
+    /** The name of used membership */
+    membershipName?: MembershipName;
+    /** Additional data about this membership */
+    membershipAdditionalData?: Record<string, any> | null;
+    /** Catalog and item reference info. */
+    catalogReference?: CatalogReference;
+    /** Properties of the service. When relevant, contains information such as date and number of participants. */
+    serviceProperties?: ServiceProperties;
     /**
-     * The transactionId corresponding to the orderId of the payment which are returned by cashier.
-     * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
+     * Usually would be the same as catalogReference.catalogItemId
+     * For cases when these are not the same, this field would return the actual id of the item in the catalog
+     * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
      */
-    transactionId?: string | null;
-}
-export interface MetaData {
-    notes?: string | null;
-    legalTerms?: string | null;
-    sourceUrl?: string | null;
-    sourceProperties?: Record<string, string>;
-    source?: string | null;
-    sourceRefId?: string | null;
-    /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
-    allowEditByOthers?: boolean | null;
-}
-export interface InvoiceDynamicPriceTotals {
-    paidAmount?: BigDecimalWrapper;
-    balance?: BigDecimalWrapper;
+    rootCatalogItemId?: string | null;
+    /** line item id of Checkout/Order line item */
+    lineItemId?: string;
 }
-/**
- * A custom field value is used to add additional data to a financial document or to a financial document template.
- * The custom field value may be based on a custom field definition.
- */
-export interface CustomFieldValue {
+export interface ServiceProperties {
     /**
-     * The unique id of the custom field value
-     * @readonly
+     * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * For example, the start time of a class.
      */
-    id?: string | null;
-    /** The display name of the custom field value */
-    displayName?: string;
-    /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
-    namespace?: string | null;
-    /** The group of the custom field indicates its intended placement in the financial document */
-    group?: CustomFieldGroup;
-    /** The value of the custom field */
-    value?: Value;
-    /** The optional key of the custom field definition on which the custom field value is based */
-    originCustomFieldKey?: string | null;
-}
-export declare enum CustomFieldGroup {
-    UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
-    BUSINESS_DETAILS = "BUSINESS_DETAILS",
-    CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
-    DOCUMENT = "DOCUMENT",
-    FOOTER = "FOOTER",
-    OTHER = "OTHER"
+    scheduledDate?: Date;
+    /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
+    numberOfParticipants?: number | null;
 }
-export interface Value {
-    value?: string;
-    valueType?: ValueType;
+export interface ChargeMembershipsResponse {
 }
-export declare enum ValueType {
-    UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
-    STRING = "STRING",
-    DATE = "DATE",
-    BOOLEAN = "BOOLEAN",
-    NUMBER = "NUMBER"
+export interface TriggerRefundRequest {
+    /** The order this refund related to */
+    ecomOrderId?: string;
+    /** Refund operations information */
+    payments?: PaymentRefund[];
+    /** Business model of a refund */
+    details?: RefundDetails;
+    /** Side effect details related to refund */
+    sideEffects?: RefundSideEffects;
 }
-export interface Deposit {
-    /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */
-    flatAmount?: string;
+export interface PaymentRefund {
+    /** Specific payment within the order to refund */
+    paymentId?: string;
+    /** Refund amount. Not relevant for membership refunds. */
+    amount?: Price;
     /**
-     * The read-only percentage value of the deposit.
-     * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
-     * @readonly
+     * Whether refund is made externally and manually (on the payment provider's side)
+     * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
+     * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
      */
-    percentage?: string;
-    /** The type of the deposit. The default is FLAT. */
-    type?: DepositType;
+    externalRefund?: boolean;
 }
-export declare enum DepositType {
-    UNKNOWN = "UNKNOWN",
-    FLAT = "FLAT",
-    PERCENTAGE = "PERCENTAGE"
+export interface RefundSideEffects {
+    /** Inventory restock details as part of this refund. */
+    restockInfo?: RestockInfo;
+    /** Whether to send a refund confirmation email to the customer. */
+    sendOrderRefundedEmail?: boolean;
+    /** Custom message added to the refund confirmation email. */
+    customMessage?: string | null;
 }
-/**
- * InvoiceStatus allowed transitions based on current status:
- * Draft -> Deleted, Paid, Partially Paid, Sent
- * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
- * Processing -> PartiallyPaid, Paid, Sent
- * Paid -> Void
- * PartiallyPaid -> Void, (PartialAndOverdue)
- * Void -> Deleted
- * Deleted
- */
-export declare enum InvoiceStatus {
-    Draft = "Draft",
-    Sent = "Sent",
-    Processing = "Processing",
-    Paid = "Paid",
-    Overdue = "Overdue",
-    Void = "Void",
-    Deleted = "Deleted",
-    PartiallyPaid = "PartiallyPaid",
-    PartialAndOverdue = "PartialAndOverdue"
+export interface RestockInfo {
+    /** Restock type. */
+    type?: RestockType;
+    /** Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`. */
+    items?: V1RestockItem[];
 }
-export interface PreparePaymentCollectionRequest {
-    /** Ecom order ID. */
-    ecomOrderId?: string;
-    /** Amount to collect */
-    amount?: Price;
-    /**
-     * Optional parameter. When present, payment collection will be performed using given payment gateway order.
-     * Existing payment gateway order will be updated with a new amount.
-     * When parameter is absent, new payment gateway order will be created and used for payment collection.
-     */
-    paymentGatewayOrderId?: string | null;
+export declare enum RestockType {
+    NO_ITEMS = "NO_ITEMS",
+    ALL_ITEMS = "ALL_ITEMS",
+    SOME_ITEMS = "SOME_ITEMS"
 }
-export interface PreparePaymentCollectionResponse {
-    /** Payment gateway order id which is associated with given payment */
-    paymentGatewayOrderId?: string;
+export interface V1RestockItem {
+    /** ID of the line item being restocked. */
+    lineItemId?: string;
+    /** Line item quantity being restocked. */
+    quantity?: number;
 }
-export interface GetPaymentCollectabilityStatusRequest {
-    /** Ecom order ID. */
+export interface TriggerRefundResponse {
+    /** All order's transactions after the refunds were added */
+    orderTransactions?: OrderTransactions;
+    /** Created refund ID */
+    refundId?: string | null;
+    /** Payment ID's that the refund execution had failed for */
+    failedPaymentIds?: ItemMetadata[];
+}
+/** Triggered when a refund is created. */
+export interface RefundCreated {
+    /** Updated order transactions. */
+    orderTransactions?: OrderTransactions;
+    /** ID of the created refund. */
+    refundId?: string;
+    /** Inventory restock details as part of this refund.. */
+    restockInfo?: RestockInfo;
+    /** Whether to send a refund confirmation email to the customer. */
+    sendOrderRefundedEmail?: boolean;
+    /** Custom message added to the refund confirmation email. */
+    customMessage?: string | null;
+    /** Refunded line items and quantities that are part of the created refund. */
+    refundItems?: RefundItem[];
+}
+export interface CalculateRefundRequest {
+    /** Order ID */
     ecomOrderId?: string;
+    /** Refunded line items and quantity */
+    refundItems?: CalculateRefundItemRequest[];
+    /** Should include shipping in refund calculation */
+    refundShipping?: boolean;
 }
-export interface GetPaymentCollectabilityStatusResponse {
-    /** Payment collectability status */
-    status?: PaymentCollectabilityStatus;
-    /** Collectable order amount */
-    amount?: Price;
+export interface CalculateRefundItemRequest {
+    /** ID of the line item being refunded */
+    id?: string;
+    /** How much of that line item is being refunded */
+    quantity?: number;
 }
-export declare enum PaymentCollectabilityStatus {
-    UNKNOWN = "UNKNOWN",
-    COLLECTABLE = "COLLECTABLE",
-    NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
-    NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
-    NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD"
+export interface CalculateRefundResponse {
+    /** Total refundable amount */
+    total?: Price;
+    /** Tax cost of the order */
+    tax?: Price;
+    /** Discount given for this order */
+    discount?: Price;
+    /** Total cost of the order (without tax) */
+    subtotal?: Price;
+    /** Total shipping cost for order */
+    shipping?: Price;
+    /** Previous refund given on that order */
+    previouslyRefundedAmount?: Price;
+    /** The refundable items of that order */
+    items?: CalculateRefundItemResponse[];
 }
-export interface RecordManuallyCollectedPaymentRequest {
-    /** Order ID. */
+export interface CalculateRefundItemResponse {
+    /** Line item ID */
+    id?: string;
+    /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
+    price?: Price;
+}
+export interface DiffmatokyPayload {
+    left?: string;
+    right?: string;
+    compareChannel?: string;
+    entityId?: string;
+    errorInformation?: ErrorInformation;
+    tags?: string[];
+}
+export interface ErrorInformation {
+    stackTrace?: string;
+}
+export interface ContinueSideEffectsFlowInLegacyData {
+    storeId?: string;
     orderId?: string;
-    /** Amount to be recorded as approved manual payment for given order */
-    amount?: Price;
+    ordersExperiments?: OrdersExperiments;
 }
-export interface RecordManuallyCollectedPaymentResponse {
+export interface OrdersExperiments {
+    epCommitTax?: boolean;
+    moveMerchantEmailToEp?: boolean;
+    moveBuyerOrderConfirmationEmailToEp?: boolean;
+    producedByEpBridge?: boolean;
+    enableRewrittenSideEffects?: boolean;
 }
-export interface V1MarkOrderAsPaidRequest {
-    /** Ecom order ID. */
-    ecomOrderId?: string;
+export interface IndexingMessage {
+    id?: string;
+    opType?: number;
+    requiredVersions?: string[];
 }
-export interface V1MarkOrderAsPaidResponse {
-    /** Updated order. */
-    order?: Order;
+export interface GetOrderRequest {
+    /** ID of the order to retrieve. */
+    id: string;
 }
-/** Triggered when the payment status of an order is updated */
-export interface PaymentStatusUpdated {
-    /** The order that was updated */
+export interface GetOrderResponse {
+    /** The requested order. */
     order?: Order;
-    /** The previous status (before the update) */
-    previousPaymentStatus?: PaymentStatus;
 }
-export interface V1BulkMarkOrdersAsPaidRequest {
-    /** IDs of orders to mark as paid. */
-    ecomOrderIds?: string[];
+export interface ListOrdersResponse {
+    /** The requested order. */
+    orders?: Order[];
+    /** Details on the paged set of results returned. */
+    pagingMetadata?: CursorPagingMetadata;
 }
-export interface V1BulkMarkOrdersAsPaidResponse {
-    /**
-     * Items updated by the bulk action.
-     * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
-     */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
+export interface InternalQueryOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Details on the paged set of results returned. */
+    metadata?: PlatformPagingMetadata;
 }
-export interface BulkOrderResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
-    /** Updated item. Optional - returned only if requested with `return_full_entity` set to `true`. */
-    item?: Order;
+export interface QueryOrderRequest {
+    /** Query options. */
+    query?: PlatformQuery;
 }
-export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
+export interface QueryOrderResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Details on the paged set of results returned. */
+    metadata?: PlatformPagingMetadata;
 }
-export interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
+export interface SearchOrdersRequest {
+    /** Search options. */
+    search?: CursorSearch;
 }
-export interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
+export interface CursorSearch extends CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
+     * `"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
+     *
+     * Learn more about the filter format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Array of sort objects that specify the order in which results should be sorted.
+     *
+     * For example, the following `sort` array will sort by `createdDate` in descending order:
+     * `"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
+     *
+     * Learn more about the sort format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
+     */
+    sort?: Sorting[];
 }
-export interface GetRefundabilityStatusRequest {
-    /** Order ID. */
-    ecomOrderId?: string;
+/** @oneof */
+export interface CursorSearchPagingMethodOneOf {
+    /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
+    cursorPaging?: CursorPaging;
 }
-export interface GetRefundabilityStatusResponse {
-    /** Refundability details. */
-    refundabilities?: Refundability[];
-    /** Whether the order supports refunding per item. */
-    refundablePerItem?: boolean;
+export interface SearchOrdersResponse {
+    /** List of orders. */
+    orders?: Order[];
+    /** Details on the paged set of results returned. */
+    metadata?: CursorPagingMetadata;
 }
-export interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
-    /** Reason why payment is not refundable. */
-    nonRefundableReason?: NonRefundableReason;
-    /** Reason why payment is only refundable manually. */
-    manuallyRefundableReason?: ManuallyRefundableReason;
-    /** Payment ID. */
-    paymentId?: string;
-    /** Payment refundability status. */
-    refundabilityStatus?: RefundableStatus;
-    /** Link to payment provider dashboard. */
-    providerLink?: string | null;
-}
-/** @oneof */
-export interface RefundabilityAdditionalRefundabilityInfoOneOf {
-    /** Reason why payment is not refundable. */
-    nonRefundableReason?: NonRefundableReason;
-    /** Reason why payment is only refundable manually. */
-    manuallyRefundableReason?: ManuallyRefundableReason;
-}
-export declare enum RefundableStatus {
-    NOT_REFUNDABLE = "NOT_REFUNDABLE",
-    MANUAL = "MANUAL",
-    REFUNDABLE = "REFUNDABLE"
+export interface CreateOrderRequest {
+    /** Order info. */
+    order: Order;
 }
-export declare enum NonRefundableReason {
-    NONE = "NONE",
-    ALREADY_REFUNDED = "ALREADY_REFUNDED",
-    PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
-    INTERNAL_ERROR = "INTERNAL_ERROR",
-    NOT_PAID = "NOT_PAID",
-    ACCESS_DENIED = "ACCESS_DENIED",
-    ZERO_PRICE = "ZERO_PRICE",
-    DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
-    PENDING_REFUND = "PENDING_REFUND",
-    FORBIDDEN = "FORBIDDEN",
-    TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND"
+export interface CreateOrderResponse {
+    /** Newly created order. */
+    order?: Order;
 }
-export declare enum ManuallyRefundableReason {
-    EXPIRED = "EXPIRED",
-    NOT_SUPPORTED = "NOT_SUPPORTED",
-    OFFLINE = "OFFLINE"
+export interface UpdateOrderRequest {
+    /** Order to be updated. */
+    order: Order;
 }
-export interface V1CreatePaymentGatewayOrderRequest {
-    /** Ecom order ID. */
-    ecomOrderId?: string;
-    /** Information about the user who initiated the payment. */
-    chargedBy?: ChargedBy;
+export interface UpdateOrderResponse {
+    /** Newly created order. */
+    order?: Order;
 }
-export interface ChargedBy {
-    /** ID - id of the user who initiated the payment */
+export interface CommitDeltasRequest {
+    /** Order id to be updated */
     id?: string;
-    /** Full name - name of the user who initiated the payment */
-    fullName?: string | null;
-}
-export interface V1CreatePaymentGatewayOrderResponse {
-    /** ID of the order created in the payment gateway */
-    paymentGatewayOrderId?: string;
-}
-export interface ChargeMembershipsRequest {
-    /** Order ID. */
-    ecomOrderId?: string;
     /**
-     * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
-     * but a user which is using the membership on behalf of the a member
+     * Draft order Id representing this change.
+     * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
      */
-    memberId?: string;
-    /** List of items to be paid by memberships */
-    membershipCharges?: MembershipChargeItem[];
+    draftOrderId?: string;
+    /** Draft order changes to be applied */
+    changes?: DraftOrderDiffs;
+    /** Side-effects to happen after order is updated */
+    commitSettings?: DraftOrderCommitSettings;
+    /** Reason for edit, given by user (optional). */
+    reason?: string | null;
 }
-export interface MembershipChargeItem {
-    /** The id of used membership */
-    membershipId?: string;
-    /** ID of the application providing this payment option */
-    appId?: string;
-    /** The name of used membership */
-    membershipName?: MembershipName;
-    /** Additional data about this membership */
-    membershipAdditionalData?: Record<string, any> | null;
-    /** Catalog and item reference info. */
-    catalogReference?: CatalogReference;
-    /** Properties of the service. When relevant, contains information such as date and number of participants. */
-    serviceProperties?: ServiceProperties;
+export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf {
+    /** Shipping info and selected shipping option details. */
+    changedShippingInfo?: ShippingInformation;
+    /** Remove existing shipping info. */
+    shippingInfoRemoved?: boolean;
+    /** Added/updated/removed order line items. */
+    lineItems?: LineItemDelta[];
     /**
-     * Usually would be the same as catalogReference.catalogItemId
-     * For cases when these are not the same, this field would return the actual id of the item in the catalog
-     * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
+     * Added/updated/removed discounts.
+     * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts
      */
-    rootCatalogItemId?: string | null;
-    /** line item id of Checkout/Order line item */
-    lineItemId?: string;
-}
-export interface ServiceProperties {
+    appliedDiscounts?: AppliedDiscountDelta[];
+    /** Added/updated/removed additional fee. */
+    additionalFees?: AdditionalFeeDelta[];
+    /** Updated Tax summary. overwrites existing tax summary. */
+    taxSummary?: TaxSummary;
     /**
-     * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-     * For example, the start time of a class.
+     * Updated order price summary. overwrites existing price summary.
+     * balance will be updated automatically.
      */
-    scheduledDate?: Date;
-    /** The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room. */
-    numberOfParticipants?: number | null;
+    priceSummary?: PriceSummary;
 }
-export interface ChargeMembershipsResponse {
+/** @oneof */
+export interface DraftOrderDiffsShippingUpdateInfoOneOf {
+    /** Shipping info and selected shipping option details. */
+    changedShippingInfo?: ShippingInformation;
+    /** Remove existing shipping info. */
+    shippingInfoRemoved?: boolean;
 }
-export interface TriggerRefundRequest {
-    /** The order this refund related to */
-    ecomOrderId?: string;
-    /** Refund operations information */
-    payments?: PaymentRefund[];
-    /** Business model of a refund */
-    details?: RefundDetails;
-    /** Side effect details related to refund */
-    sideEffects?: RefundSideEffects;
+export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
+    /** The line item was added. */
+    lineItemAdded?: boolean;
+    /** The line item was modified. */
+    changedDetails?: ItemChangedDetails;
+    /** The line item was added. */
+    lineItemRemoved?: boolean;
+    /** Line item ID. */
+    lineItemId?: string;
+    lineItem?: OrderLineItemChangedDetails;
 }
-export interface PaymentRefund {
-    /** Specific payment within the order to refund */
-    paymentId?: string;
-    /** Refund amount. Not relevant for membership refunds. */
-    amount?: Price;
+/** @oneof */
+export interface LineItemDeltaDeltaOneOf {
+    /** The line item was added. */
+    lineItemAdded?: boolean;
+    /** The line item was modified. */
+    changedDetails?: ItemChangedDetails;
+    /** The line item was added. */
+    lineItemRemoved?: boolean;
+}
+export interface OrderLineItemChangedDetails {
     /**
-     * Whether refund is made externally and manually (on the payment provider's side)
-     * When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
-     * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
+     * Item name.
+     * + Stores - `product.name`
+     * + Bookings - `service.info.name`
+     * + Events - `ticket.name`
      */
-    externalRefund?: boolean;
+    productName?: ProductName;
+    /**
+     * References to the line item's origin catalog.
+     * This field is empty in the case of a custom line item.
+     */
+    catalogReference?: CatalogReference;
+    /** Line item quantity. */
+    quantity?: number;
+    /** Total discount for this line item's entire quantity. */
+    totalDiscount?: Price;
+    /** Line item description lines. Used for display purposes for the cart, checkout and order. */
+    descriptionLines?: DescriptionLine[];
+    /** Line item image. */
+    image?: Image;
+    /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
+    physicalProperties?: PhysicalProperties;
+    /** Item type. Either a preset type or custom. */
+    itemType?: ItemType;
+    /**
+     * Fulfiller ID. Field is empty when the line item is self-fulfilled.
+     * To get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order).
+     */
+    fulfillerId?: string | null;
+    /** Line item price after line item discounts for display purposes. */
+    price?: Price;
+    /** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */
+    priceBeforeDiscounts?: Price;
+    /** Total price after all discounts and tax. */
+    totalPriceAfterTax?: Price;
+    /**
+     * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
+     * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
+     * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
+     */
+    paymentOption?: DeltaPaymentOptionType;
+    /** Tax details for this line item. */
+    taxDetails?: ItemTaxFullDetails;
+    /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
+    priceDescription?: PriceDescription;
+    /** Total price after all discounts excluding tax. */
+    totalPriceBeforeTax?: Price;
 }
-export interface RefundSideEffects {
-    /** Inventory restock details as part of this refund. */
-    restockInfo?: RestockInfo;
-    /** Whether to send a refund confirmation email to the customer. */
-    sendOrderRefundedEmail?: boolean;
-    /** Custom message added to the refund confirmation email. */
-    customMessage?: string | null;
+/** Type of selected payment option for catalog item */
+export declare enum DeltaPaymentOptionType {
+    /** irrelevant */
+    UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
+    /** The entire payment for given item will happen after the checkout. */
+    FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
+    /**
+     * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
+     * Note: when this option is used, price will be 0.
+     */
+    MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
 }
-export interface RestockInfo {
-    /** Restock type. */
-    type?: RestockType;
-    /** Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`. */
-    items?: V1RestockItem[];
+export interface ItemChangedDetails {
+    /** The quantity before the change. */
+    quantityBeforeChange?: number | null;
+    /** The price before the change. */
+    priceBeforeChange?: Price;
+    /** The price description before the change */
+    priceDescriptionBeforeChange?: PriceDescription;
 }
-export declare enum RestockType {
-    NO_ITEMS = "NO_ITEMS",
-    ALL_ITEMS = "ALL_ITEMS",
-    SOME_ITEMS = "SOME_ITEMS"
+export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
+    editedDiscount?: AppliedDiscount;
+    discountRemoved?: boolean;
+    /** Discount id. */
+    discountId?: string;
 }
-export interface V1RestockItem {
-    /** ID of the line item being restocked. */
-    lineItemId?: string;
-    /** Line item quantity being restocked. */
-    quantity?: number;
-}
-export interface TriggerRefundResponse {
-    /** All order's transactions after the refunds were added */
-    orderTransactions?: OrderTransactions;
-    /** Created refund ID */
-    refundId?: string | null;
-    /** Payment ID's that the refund execution had failed for */
-    failedPaymentIds?: ItemMetadata[];
-}
-/** Triggered when a refund is created. */
-export interface RefundCreated {
-    /** Updated order transactions. */
-    orderTransactions?: OrderTransactions;
-    /** ID of the created refund. */
-    refundId?: string;
-    /** Inventory restock details as part of this refund.. */
-    restockInfo?: RestockInfo;
-    /** Whether to send a refund confirmation email to the customer. */
-    sendOrderRefundedEmail?: boolean;
-    /** Custom message added to the refund confirmation email. */
-    customMessage?: string | null;
-    /** Refunded line items and quantities that are part of the created refund. */
-    refundItems?: RefundItem[];
-}
-export interface CalculateRefundRequest {
-    /** Order ID */
-    ecomOrderId?: string;
-    /** Refunded line items and quantity */
-    refundItems?: CalculateRefundItemRequest[];
-    /** Should include shipping in refund calculation */
-    refundShipping?: boolean;
-}
-export interface CalculateRefundItemRequest {
-    /** ID of the line item being refunded */
-    id?: string;
-    /** How much of that line item is being refunded */
-    quantity?: number;
-}
-export interface CalculateRefundResponse {
-    /** Total refundable amount */
-    total?: Price;
-    /** Tax cost of the order */
-    tax?: Price;
-    /** Discount given for this order */
-    discount?: Price;
-    /** Total cost of the order (without tax) */
-    subtotal?: Price;
-    /** Total shipping cost for order */
-    shipping?: Price;
-    /** Previous refund given on that order */
-    previouslyRefundedAmount?: Price;
-    /** The refundable items of that order */
-    items?: CalculateRefundItemResponse[];
-}
-export interface CalculateRefundItemResponse {
-    /** Line item ID */
-    id?: string;
-    /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
-    price?: Price;
-}
-export interface DiffmatokyPayload {
-    left?: string;
-    right?: string;
-    compareChannel?: string;
-    entityId?: string;
-    errorInformation?: ErrorInformation;
-    tags?: string[];
-}
-export interface ErrorInformation {
-    stackTrace?: string;
-}
-export interface ContinueSideEffectsFlowInLegacyData {
-    storeId?: string;
-    orderId?: string;
-    ordersExperiments?: OrdersExperiments;
-}
-export interface OrdersExperiments {
-    epCommitTax?: boolean;
-    moveMerchantEmailToEp?: boolean;
-    moveBuyerOrderConfirmationEmailToEp?: boolean;
-    producedByEpBridge?: boolean;
-    enableRewrittenSideEffects?: boolean;
-}
-export interface IndexingMessage {
-    id?: string;
-    opType?: number;
-    requiredVersions?: string[];
-}
-export interface GetOrderRequest {
-    /** ID of the order to retrieve. */
-    id: string;
-}
-export interface GetOrderResponse {
-    /** The requested order. */
-    order?: Order;
-}
-export interface ListOrdersResponse {
-    /** The requested order. */
-    orders?: Order[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: CursorPagingMetadata;
-}
-export interface InternalQueryOrdersResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Details on the paged set of results returned. */
-    metadata?: PlatformPagingMetadata;
-}
-export interface QueryOrderRequest {
-    /** Query options. */
-    query?: PlatformQuery;
-}
-export interface QueryOrderResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Details on the paged set of results returned. */
-    metadata?: PlatformPagingMetadata;
-}
-export interface SearchOrdersRequest {
-    /** Search options. */
-    search?: CursorSearch;
+/** @oneof */
+export interface AppliedDiscountDeltaDeltaOneOf {
+    editedDiscount?: AppliedDiscount;
+    discountRemoved?: boolean;
 }
-export interface CursorSearch extends CursorSearchPagingMethodOneOf {
-    /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
-    cursorPaging?: CursorPaging;
-    /**
-     * Filter object.
-     *
-     * For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
-     * `"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
-     *
-     * Learn more about the filter format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
-     */
-    filter?: Record<string, any> | null;
-    /**
-     * Array of sort objects that specify the order in which results should be sorted.
-     *
-     * For example, the following `sort` array will sort by `createdDate` in descending order:
-     * `"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
-     *
-     * Learn more about the sort format [here](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
-     */
-    sort?: Sorting[];
+export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
+    editedAdditionalFee?: AdditionalFee;
+    additionalFeeRemoved?: boolean;
+    /** Additional fee id. */
+    additionalFeeId?: string;
 }
 /** @oneof */
-export interface CursorSearchPagingMethodOneOf {
-    /** Cursor pointing to page of results. `cursorPaging.cursor` cannot be used with 'filter' or 'sort'. */
-    cursorPaging?: CursorPaging;
-}
-export interface SearchOrdersResponse {
-    /** List of orders. */
-    orders?: Order[];
-    /** Details on the paged set of results returned. */
-    metadata?: CursorPagingMetadata;
+export interface AdditionalFeeDeltaDeltaOneOf {
+    editedAdditionalFee?: AdditionalFee;
+    additionalFeeRemoved?: boolean;
 }
-export interface CreateOrderRequest {
-    /** Order info. */
-    order: Order;
+export interface DraftOrderCommitSettings {
+    /** If false, do not send notifications to buyer. Default is true. */
+    sendNotificationsToBuyer?: boolean | null;
+    /** If false, do not send notifications to business. Default is true. */
+    sendNotificationsToBusiness?: boolean | null;
+    /** If false,do not add activities to the order. Default is true. */
+    addActivitiesToOrder?: boolean | null;
+    /** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */
+    sendNotificationsToCustomFulfillers?: boolean | null;
+    /** Inventory changes to be applied. Either to restock, or decrease. */
+    inventoryUpdates?: InventoryUpdateDetails[];
 }
-export interface CreateOrderResponse {
-    /** Newly created order. */
-    order?: Order;
+export interface InventoryUpdateDetails {
+    /** Action to be applied - decrease or restock */
+    actionType?: InventoryAction;
+    /** Order line item id */
+    lineItemId?: string;
+    /** The amount to be increased or restocked */
+    quantityChange?: number;
 }
-export interface UpdateOrderRequest {
-    /** Order to be updated. */
-    order: Order;
+export declare enum InventoryAction {
+    /** Restock inventory */
+    RESTOCK = "RESTOCK",
+    /** Decrease inventory. Without failing on negative inventory. */
+    DECREASE = "DECREASE"
 }
-export interface UpdateOrderResponse {
-    /** Newly created order. */
+export interface CommitDeltasResponse {
+    /** Order after deltas are applied */
     order?: Order;
 }
-export interface CommitDeltasRequest {
-    /** Order id to be updated */
-    id?: string;
-    /**
-     * Draft order Id representing this change.
-     * Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
-     */
+/** Triggered when order is edited by draftOrders */
+export interface OrderDeltasCommitted {
+    /** The order after committed changes. */
+    order?: Order;
+    /** Draft order Id representing this change. */
     draftOrderId?: string;
-    /** Draft order changes to be applied */
-    changes?: DraftOrderDiffs;
-    /** Side-effects to happen after order is updated */
+    /** Applied changes. */
+    changes?: CommittedDiffs;
+    /** Side-effects requested to happen as a result of this edit. */
     commitSettings?: DraftOrderCommitSettings;
-    /** Reason for edit, given by user (optional). */
-    reason?: string | null;
+    /**
+     * Date and time when order deltas were committed.
+     * @readonly
+     */
+    commitDate?: Date;
 }
-export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf {
+export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
     /** Shipping info and selected shipping option details. */
     changedShippingInfo?: ShippingInformation;
     /** Remove existing shipping info. */
     shippingInfoRemoved?: boolean;
     /** Added/updated/removed order line items. */
-    lineItems?: LineItemDelta[];
+    lineItems?: CommittedDiffsLineItemDelta[];
     /**
      * Added/updated/removed discounts.
      * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts
@@ -2830,212 +2681,26 @@ export interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf
     appliedDiscounts?: AppliedDiscountDelta[];
     /** Added/updated/removed additional fee. */
     additionalFees?: AdditionalFeeDelta[];
-    /** Updated Tax summary. overwrites existing tax summary. */
-    taxSummary?: TaxSummary;
-    /**
-     * Updated order price summary. overwrites existing price summary.
-     * balance will be updated automatically.
-     */
-    priceSummary?: PriceSummary;
 }
 /** @oneof */
-export interface DraftOrderDiffsShippingUpdateInfoOneOf {
+export interface CommittedDiffsShippingUpdateInfoOneOf {
     /** Shipping info and selected shipping option details. */
     changedShippingInfo?: ShippingInformation;
     /** Remove existing shipping info. */
     shippingInfoRemoved?: boolean;
 }
-export interface LineItemDelta extends LineItemDeltaDeltaOneOf {
-    /** The line item was added. */
+export interface CommittedDiffsLineItemDelta extends CommittedDiffsLineItemDeltaDeltaOneOf {
     lineItemAdded?: boolean;
-    /** The line item was modified. */
     changedDetails?: ItemChangedDetails;
-    /** The line item was added. */
-    lineItemRemoved?: boolean;
+    lineItemRemoved?: OrderLineItemChangedDetails;
     /** Line item ID. */
     lineItemId?: string;
-    lineItem?: OrderLineItemChangedDetails;
 }
 /** @oneof */
-export interface LineItemDeltaDeltaOneOf {
-    /** The line item was added. */
+export interface CommittedDiffsLineItemDeltaDeltaOneOf {
     lineItemAdded?: boolean;
-    /** The line item was modified. */
     changedDetails?: ItemChangedDetails;
-    /** The line item was added. */
-    lineItemRemoved?: boolean;
-}
-export interface OrderLineItemChangedDetails {
-    /**
-     * Item name.
-     * + Stores - `product.name`
-     * + Bookings - `service.info.name`
-     * + Events - `ticket.name`
-     */
-    productName?: ProductName;
-    /**
-     * References to the line item's origin catalog.
-     * This field is empty in the case of a custom line item.
-     */
-    catalogReference?: CatalogReference;
-    /** Line item quantity. */
-    quantity?: number;
-    /** Total discount for this line item's entire quantity. */
-    totalDiscount?: Price;
-    /** Line item description lines. Used for display purposes for the cart, checkout and order. */
-    descriptionLines?: DescriptionLine[];
-    /** Line item image. */
-    image?: Image;
-    /** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
-    physicalProperties?: PhysicalProperties;
-    /** Item type. Either a preset type or custom. */
-    itemType?: ItemType;
-    /**
-     * Fulfiller ID. Field is empty when the line item is self-fulfilled.
-     * To get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order).
-     */
-    fulfillerId?: string | null;
-    /** Line item price after line item discounts for display purposes. */
-    price?: Price;
-    /** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */
-    priceBeforeDiscounts?: Price;
-    /** Total price after all discounts and tax. */
-    totalPriceAfterTax?: Price;
-    /**
-     * Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
-     * + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
-     * + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
-     */
-    paymentOption?: DeltaPaymentOptionType;
-    /** Tax details for this line item. */
-    taxDetails?: ItemTaxFullDetails;
-    /** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
-    priceDescription?: PriceDescription;
-    /** Total price after all discounts excluding tax. */
-    totalPriceBeforeTax?: Price;
-}
-/** Type of selected payment option for catalog item */
-export declare enum DeltaPaymentOptionType {
-    /** irrelevant */
-    UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
-    /** The entire payment for given item will happen after the checkout. */
-    FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
-    /**
-     * Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
-     * Note: when this option is used, price will be 0.
-     */
-    MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
-}
-export interface ItemChangedDetails {
-    /** The quantity before the change. */
-    quantityBeforeChange?: number | null;
-    /** The price before the change. */
-    priceBeforeChange?: Price;
-    /** The price description before the change */
-    priceDescriptionBeforeChange?: PriceDescription;
-}
-export interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
-    editedDiscount?: AppliedDiscount;
-    discountRemoved?: boolean;
-    /** Discount id. */
-    discountId?: string;
-}
-/** @oneof */
-export interface AppliedDiscountDeltaDeltaOneOf {
-    editedDiscount?: AppliedDiscount;
-    discountRemoved?: boolean;
-}
-export interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
-    editedAdditionalFee?: AdditionalFee;
-    additionalFeeRemoved?: boolean;
-    /** Additional fee id. */
-    additionalFeeId?: string;
-}
-/** @oneof */
-export interface AdditionalFeeDeltaDeltaOneOf {
-    editedAdditionalFee?: AdditionalFee;
-    additionalFeeRemoved?: boolean;
-}
-export interface DraftOrderCommitSettings {
-    /** If false, do not send notifications to buyer. Default is true. */
-    sendNotificationsToBuyer?: boolean | null;
-    /** If false, do not send notifications to business. Default is true. */
-    sendNotificationsToBusiness?: boolean | null;
-    /** If false,do not add activities to the order. Default is true. */
-    addActivitiesToOrder?: boolean | null;
-    /** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */
-    sendNotificationsToCustomFulfillers?: boolean | null;
-    /** Inventory changes to be applied. Either to restock, or decrease. */
-    inventoryUpdates?: InventoryUpdateDetails[];
-}
-export interface InventoryUpdateDetails {
-    /** Action to be applied - decrease or restock */
-    actionType?: InventoryAction;
-    /** Order line item id */
-    lineItemId?: string;
-    /** The amount to be increased or restocked */
-    quantityChange?: number;
-}
-export declare enum InventoryAction {
-    /** Restock inventory */
-    RESTOCK = "RESTOCK",
-    /** Decrease inventory. Without failing on negative inventory. */
-    DECREASE = "DECREASE"
-}
-export interface CommitDeltasResponse {
-    /** Order after deltas are applied */
-    order?: Order;
-}
-/** Triggered when order is edited by draftOrders */
-export interface OrderDeltasCommitted {
-    /** The order after committed changes. */
-    order?: Order;
-    /** Draft order Id representing this change. */
-    draftOrderId?: string;
-    /** Applied changes. */
-    changes?: CommittedDiffs;
-    /** Side-effects requested to happen as a result of this edit. */
-    commitSettings?: DraftOrderCommitSettings;
-    /**
-     * Date and time when order deltas were committed.
-     * @readonly
-     */
-    commitDate?: Date;
-}
-export interface CommittedDiffs extends CommittedDiffsShippingUpdateInfoOneOf {
-    /** Shipping info and selected shipping option details. */
-    changedShippingInfo?: ShippingInformation;
-    /** Remove existing shipping info. */
-    shippingInfoRemoved?: boolean;
-    /** Added/updated/removed order line items. */
-    lineItems?: CommittedDiffsLineItemDelta[];
-    /**
-     * Added/updated/removed discounts.
-     * todo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts
-     */
-    appliedDiscounts?: AppliedDiscountDelta[];
-    /** Added/updated/removed additional fee. */
-    additionalFees?: AdditionalFeeDelta[];
-}
-/** @oneof */
-export interface CommittedDiffsShippingUpdateInfoOneOf {
-    /** Shipping info and selected shipping option details. */
-    changedShippingInfo?: ShippingInformation;
-    /** Remove existing shipping info. */
-    shippingInfoRemoved?: boolean;
-}
-export interface CommittedDiffsLineItemDelta extends CommittedDiffsLineItemDeltaDeltaOneOf {
-    lineItemAdded?: boolean;
-    changedDetails?: ItemChangedDetails;
-    lineItemRemoved?: OrderLineItemChangedDetails;
-    /** Line item ID. */
-    lineItemId?: string;
-}
-/** @oneof */
-export interface CommittedDiffsLineItemDeltaDeltaOneOf {
-    lineItemAdded?: boolean;
-    changedDetails?: ItemChangedDetails;
-    lineItemRemoved?: OrderLineItemChangedDetails;
+    lineItemRemoved?: OrderLineItemChangedDetails;
 }
 export interface ArchiveOrderRequest {
     /** Order ID. */
@@ -3527,115 +3192,477 @@ export interface BulkMarkOrdersAsPaidRequest {
 }
 export interface BulkMarkOrdersAsPaidResponse {
     /**
-     * Items updated by the bulk action.
-     * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
+     * Items updated by the bulk action.
+     * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
+     */
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface CreatePaymentGatewayOrderRequest {
+    /** eCom Order ID */
+    ecomOrderId?: string;
+}
+export interface CreatePaymentGatewayOrderResponse {
+    /** ID of the order created in the payment gateway */
+    paymentGatewayOrderId?: string;
+}
+export interface GetShipmentsRequest {
+    id?: string;
+}
+export interface GetShipmentsResponse {
+    shipmentIds?: string[];
+}
+export interface AggregateOrdersRequest {
+    /** Filter applied to original data */
+    filter?: Record<string, any> | null;
+    /** This is an object defining aggregation itself */
+    aggregation?: Record<string, any> | null;
+    /**
+     * Optional custom separator string that can be used to override default separator value '|'
+     * for hierarchical responses of multifaceted aggregation requests like:
+     * '{"aggregation": {"example_request_key": {"$count" : ["deliveryMethod", "shippingRegion"]}}}'
+     * with example response for default '|' separator like:
+     * '{"aggregates" :{"example_request_key": {"(Mail|Region 1)": 5, "(Pickup|Region 2)": 10}}}'
+     */
+    hierarchySeparatorOverride?: string | null;
+}
+export interface AggregateOrdersResponse {
+    aggregates?: Record<string, any> | null;
+}
+export interface DecrementItemsQuantityRequest {
+    /** Order ID */
+    id?: string;
+    /** Which items to decrement, and how much to decrement from each one */
+    decrementData?: DecrementData[];
+}
+export interface DecrementData {
+    /** ID of the line item being decremented. */
+    lineItemId?: string;
+    /** Line item quantity being decremented. */
+    decrementBy?: number;
+    /** Whether to restock the line item (triggers inventory update). */
+    restock?: boolean;
+}
+export interface DecrementItemsQuantityResponse {
+    /** Updated order data */
+    order?: Order;
+}
+/** Triggered when order items are marked as restocked */
+export interface OrderItemsRestocked {
+    /** The order which items were restocked */
+    order?: Order;
+    /** Restocked items and quantities */
+    restockItems?: RestockItem[];
+}
+export interface RestockItem {
+    /** ID of the line item being restocked. */
+    lineItemId?: string;
+    /** Line item quantity being restocked. */
+    quantity?: number;
+}
+/** Triggered when the the order status changes to approved */
+export interface OrderApproved {
+    /** The order that was updated */
+    order?: Order;
+}
+export interface Task {
+    key?: TaskKey;
+    executeAt?: Date;
+    payload?: string | null;
+}
+export interface TaskKey {
+    appId?: string;
+    instanceId?: string;
+    subjectId?: string | null;
+}
+export interface TaskAction extends TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+/** @oneof */
+export interface TaskActionActionOneOf {
+    complete?: Complete;
+    cancel?: Cancel;
+    reschedule?: Reschedule;
+}
+export interface Complete {
+}
+export interface Cancel {
+}
+export interface Reschedule {
+    executeAt?: Date;
+    payload?: string | null;
+}
+export interface InvoiceSentEvent {
+    id?: IdAndVersion;
+    /** @readonly */
+    data?: InvoiceFields;
+    /** @readonly */
+    status?: InvoiceStatus;
+}
+export interface IdAndVersion {
+    id?: string | null;
+    version?: number | null;
+}
+export interface InvoiceFields {
+    /** The invoice number allocated the invoice by the server. The number is limited to at most 11 digits. */
+    number?: string | null;
+    /** The invoice 3-letter currency code in [ISO-4217 alphabetic](https://www.iso.org/iso-4217-currency-codes.html) format. */
+    currencyCode?: string | null;
+    /** The invoice customer. The customer must be a contact of the site, with an email. */
+    customer?: Customer;
+    /**
+     * Invoice dates: issue date and due date are mandatory and provided when the invoice is created.
+     * Last seen date is the optional date when the invoice was last seen be UoU.
+     */
+    dates?: InvoiceDates;
+    /**
+     * Line items containing the details of the products or services relevant to the invoice, with their name, prices,
+     * and quantity. There must be at least one line item on the invoice.
+     */
+    lineItems?: LineItems;
+    /**
+     * Locale of the invoice, containing the language.
+     * This field is not mandatory but is used for display purposes, to determine the appearance of numbers and dates
+     * on the invoice.
+     */
+    locale?: Locale;
+    /**
+     * The totals on the invoice.
+     * The totals.subtotal, totals.total and totals.taxed_amount are calculated by the server based on the line items.
+     * Alternatively, these fields can be provided in the invoice creation request, in this case, these values are fixed.
+     * The totals contain fees and a discount, that apply to the invoice.
+     */
+    totals?: TotalPrice;
+    /** An optional discount on the invoice. */
+    discount?: Discount;
+    /** The taxes of the invoice. */
+    taxes?: CalculatedTaxes;
+    /** The payments on the invoice. The invoice has status paid if its payments cover the invoice total. */
+    payments?: Payments;
+    /** Invoice metadata */
+    metaData?: MetaData;
+    /** Not used */
+    creationAdditional_BIInformation?: string | null;
+    /**
+     * The balance and amount paid on the invoice.
+     * This read-only field is calculated based on the invoice totals and payments.
+     * @readonly
+     */
+    dynamicTotals?: InvoiceDynamicPriceTotals;
+    /** The invoice title */
+    title?: string | null;
+    /** Invoice custom fields */
+    customFields?: CustomFieldValue[];
+    /** Not used */
+    designTemplateId?: string | null;
+    /** Not used */
+    createOrder?: boolean | null;
+    /** The optional deposit of the invoice */
+    deposit?: Deposit;
+    /** associated checkout for this invoice */
+    ecomCheckoutId?: string | null;
+}
+export interface Customer {
+    contactId?: string | null;
+    name?: string | null;
+    email?: Email;
+    address?: QuotesAddress;
+    phone?: Phone;
+    company?: Company;
+    firstName?: string | null;
+    lastName?: string | null;
+    billingAddress?: CommonAddress;
+    shippingAddress?: CommonAddress;
+}
+export interface Email {
+    address?: string;
+}
+export interface QuotesAddress {
+    street?: string | null;
+    city?: string | null;
+    zip?: string | null;
+    state?: string | null;
+    country?: string | null;
+    /** @readonly */
+    description?: AddressDescription;
+}
+export interface AddressDescription {
+    content?: string;
+    placement?: Placement;
+}
+export declare enum Placement {
+    Unknown = "Unknown",
+    Replace = "Replace",
+    Before = "Before",
+    After = "After"
+}
+export interface Phone {
+    number?: string;
+}
+export interface Company {
+    name?: string;
+    id?: string | null;
+}
+/** Physical address */
+export interface CommonAddress extends CommonAddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+    /** Country code. */
+    country?: string | null;
+    /** Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2). */
+    subdivision?: string | null;
+    /** City name. */
+    city?: string | null;
+    /** Zip/postal code. */
+    postalCode?: string | null;
+    /** Free text providing more detailed address info. Usually contains Apt, Suite, and Floor. */
+    addressLine2?: string | null;
+}
+/** @oneof */
+export interface CommonAddressStreetOneOf {
+    /** Street name and number. */
+    streetAddress?: StreetAddress;
+    /** Main address line, usually street and number as free text. */
+    addressLine?: string | null;
+}
+export interface Subdivision {
+    /** Short subdivision code. */
+    code?: string;
+    /** Subdivision full name. */
+    name?: string;
+}
+export declare enum SubdivisionType {
+    UNKNOWN_SUBDIVISION_TYPE = "UNKNOWN_SUBDIVISION_TYPE",
+    /** State */
+    ADMINISTRATIVE_AREA_LEVEL_1 = "ADMINISTRATIVE_AREA_LEVEL_1",
+    /** County */
+    ADMINISTRATIVE_AREA_LEVEL_2 = "ADMINISTRATIVE_AREA_LEVEL_2",
+    /** City/town */
+    ADMINISTRATIVE_AREA_LEVEL_3 = "ADMINISTRATIVE_AREA_LEVEL_3",
+    /** Neighborhood/quarter */
+    ADMINISTRATIVE_AREA_LEVEL_4 = "ADMINISTRATIVE_AREA_LEVEL_4",
+    /** Street/block */
+    ADMINISTRATIVE_AREA_LEVEL_5 = "ADMINISTRATIVE_AREA_LEVEL_5",
+    /** ADMINISTRATIVE_AREA_LEVEL_0. Indicates the national political entity, and is typically the highest order type returned by the Geocoder. */
+    COUNTRY = "COUNTRY"
+}
+export interface InvoiceDates {
+    /** use UTC midnight date to set the issue date according to the site time zone */
+    issueDate?: Date;
+    /** use UTC midnight date to set the due date according to the site time zone */
+    dueDate?: Date;
+    /** <a href="http://joda-time.sourceforge.net/timezones.html">Valid time zones</a> */
+    timeZoneCode?: string | null;
+    /**
+     * ignored in request use in response to get the site time zone
+     * @readonly
+     */
+    lastSeenDate?: Date;
+}
+export interface LineItems {
+    lineItems?: LineItem[];
+}
+export interface LineItem {
+    id?: string;
+    name?: string;
+    description?: string | null;
+    price?: BigDecimalWrapper;
+    taxedTotal?: BigDecimalWrapper;
+    quantity?: BigDecimalWrapper;
+    taxes?: LineItemTax[];
+    /** The source of the line item */
+    source?: Source;
+    /** The line-item level metadata. */
+    metadata?: LineItemMetaData;
+}
+export interface BigDecimalWrapper {
+    serializedValue?: number;
+}
+export interface LineItemTax {
+    name?: string;
+    rate?: BigDecimalWrapper;
+    code?: string | null;
+}
+export interface Source {
+    /**
+     * Source app or service ID.
+     * @readonly
      */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
+    sourceId?: string;
+    /**
+     * App or service type.
+     * @readonly
+     */
+    sourceType?: SourceType;
 }
-export interface CreatePaymentGatewayOrderRequest {
-    /** eCom Order ID */
-    ecomOrderId?: string;
+export declare enum SourceType {
+    UNKNOWN_SOURCE_TYPE = "UNKNOWN_SOURCE_TYPE",
+    WIX_APP = "WIX_APP",
+    EXTERNAL = "EXTERNAL",
+    ADMIN = "ADMIN",
+    OTHER = "OTHER"
 }
-export interface CreatePaymentGatewayOrderResponse {
-    /** ID of the order created in the payment gateway */
-    paymentGatewayOrderId?: string;
+export interface LineItemMetaData {
+    metadata?: Record<string, string>;
 }
-export interface GetShipmentsRequest {
-    id?: string;
+export interface Locale {
+    /** ISO 639 alpha-2 or alpha-3 language code, or a language subtag */
+    language?: string;
+    /** An ISO 3166 alpha-2 country code or a UN M.49 numeric-3 area code. */
+    country?: string | null;
+    invariant?: string | null;
 }
-export interface GetShipmentsResponse {
-    shipmentIds?: string[];
+export interface TotalPrice {
+    /** the subtotal of the line items without the tax reduction */
+    subtotal?: BigDecimalWrapper;
+    /** the total price taking into account the itemized fees and the taxes */
+    total?: BigDecimalWrapper;
+    fees?: ItemizedFee[];
+    discountAmount?: BigDecimalWrapper;
+    taxedAmount?: BigDecimalWrapper;
 }
-export interface AggregateOrdersRequest {
-    /** Filter applied to original data */
-    filter?: Record<string, any> | null;
-    /** This is an object defining aggregation itself */
-    aggregation?: Record<string, any> | null;
-    /**
-     * Optional custom separator string that can be used to override default separator value '|'
-     * for hierarchical responses of multifaceted aggregation requests like:
-     * '{"aggregation": {"example_request_key": {"$count" : ["deliveryMethod", "shippingRegion"]}}}'
-     * with example response for default '|' separator like:
-     * '{"aggregates" :{"example_request_key": {"(Mail|Region 1)": 5, "(Pickup|Region 2)": 10}}}'
-     */
-    hierarchySeparatorOverride?: string | null;
+export interface ItemizedFee {
+    name?: string;
+    price?: BigDecimalWrapper;
 }
-export interface AggregateOrdersResponse {
-    aggregates?: Record<string, any> | null;
+export interface Discount extends DiscountOneDiscountTypeOneOf {
+    /** Discount as percentage value. */
+    percentage?: BigDecimalWrapper;
 }
-export interface DecrementItemsQuantityRequest {
-    /** Order ID */
-    id?: string;
-    /** Which items to decrement, and how much to decrement from each one */
-    decrementData?: DecrementData[];
+/** @oneof */
+export interface DiscountOneDiscountTypeOneOf {
+    /** Discount as percentage value. */
+    percentage?: BigDecimalWrapper;
 }
-export interface DecrementData {
-    /** ID of the line item being decremented. */
-    lineItemId?: string;
-    /** Line item quantity being decremented. */
-    decrementBy?: number;
-    /** Whether to restock the line item (triggers inventory update). */
-    restock?: boolean;
+export interface CalculatedTaxes {
+    /** consider calculated or not - cannot enforce set */
+    taxes?: CalculatedTax[];
 }
-export interface DecrementItemsQuantityResponse {
-    /** Updated order data */
-    order?: Order;
+export interface CalculatedTax {
+    name?: string;
+    rate?: BigDecimalWrapper;
+    /** the costs on which the taxes are applied */
+    taxable?: BigDecimalWrapper;
+    /** the taxes as a result of the */
+    taxed?: BigDecimalWrapper;
+    code?: string | null;
 }
-/** Triggered when order items are marked as restocked */
-export interface OrderItemsRestocked {
-    /** The order which items were restocked */
-    order?: Order;
-    /** Restocked items and quantities */
-    restockItems?: RestockItem[];
+export interface Payments {
+    payments?: Payment[];
 }
-export interface RestockItem {
-    /** ID of the line item being restocked. */
-    lineItemId?: string;
-    /** Line item quantity being restocked. */
-    quantity?: number;
+export interface Payment {
+    /** document */
+    id?: string;
+    type?: string;
+    amount?: BigDecimalWrapper;
+    date?: Date;
+    /**
+     * The orderId of the order in cashier associated with the payment.
+     * This field is populated for external payments that are charged by invoices via AddPayment endpoint.
+     */
+    orderId?: string | null;
+    /**
+     * The transactionId corresponding to the orderId of the payment which are returned by cashier.
+     * This field is populated for external payments that are charged by invoices via AddPayment endpoint as well.
+     */
+    transactionId?: string | null;
 }
-/** Triggered when the the order status changes to approved */
-export interface OrderApproved {
-    /** The order that was updated */
-    order?: Order;
+export interface MetaData {
+    notes?: string | null;
+    legalTerms?: string | null;
+    sourceUrl?: string | null;
+    sourceProperties?: Record<string, string>;
+    source?: string | null;
+    sourceRefId?: string | null;
+    /** Optional indicator whether to allow editing of the invoice by other applications other than the source. Default is true. */
+    allowEditByOthers?: boolean | null;
 }
-export interface Task {
-    key?: TaskKey;
-    executeAt?: Date;
-    payload?: string | null;
+export interface InvoiceDynamicPriceTotals {
+    paidAmount?: BigDecimalWrapper;
+    balance?: BigDecimalWrapper;
 }
-export interface TaskKey {
-    appId?: string;
-    instanceId?: string;
-    subjectId?: string | null;
+/**
+ * A custom field value is used to add additional data to a financial document or to a financial document template.
+ * The custom field value may be based on a custom field definition.
+ */
+export interface CustomFieldValue {
+    /**
+     * The unique id of the custom field value
+     * @readonly
+     */
+    id?: string | null;
+    /** The display name of the custom field value */
+    displayName?: string;
+    /** The optional namespace of the custom field value. This field may be used to indicate intended usage or source. */
+    namespace?: string | null;
+    /** The group of the custom field indicates its intended placement in the financial document */
+    group?: CustomFieldGroup;
+    /** The value of the custom field */
+    value?: Value;
+    /** The optional key of the custom field definition on which the custom field value is based */
+    originCustomFieldKey?: string | null;
 }
-export interface TaskAction extends TaskActionActionOneOf {
-    complete?: Complete;
-    cancel?: Cancel;
-    reschedule?: Reschedule;
+export declare enum CustomFieldGroup {
+    UNKNOWN_CUSTOM_FIELD_GROUP = "UNKNOWN_CUSTOM_FIELD_GROUP",
+    BUSINESS_DETAILS = "BUSINESS_DETAILS",
+    CUSTOMER_DETAILS = "CUSTOMER_DETAILS",
+    DOCUMENT = "DOCUMENT",
+    FOOTER = "FOOTER",
+    OTHER = "OTHER"
 }
-/** @oneof */
-export interface TaskActionActionOneOf {
-    complete?: Complete;
-    cancel?: Cancel;
-    reschedule?: Reschedule;
+export interface Value {
+    value?: string;
+    valueType?: ValueType;
 }
-export interface Complete {
+export declare enum ValueType {
+    UNKNOWN_VALUE_TYPE = "UNKNOWN_VALUE_TYPE",
+    STRING = "STRING",
+    DATE = "DATE",
+    BOOLEAN = "BOOLEAN",
+    NUMBER = "NUMBER"
 }
-export interface Cancel {
+export interface Deposit {
+    /** The flat amount of the deposit. The flat amount of the deposit must be less than the invoice total. */
+    flatAmount?: string;
+    /**
+     * The read-only percentage value of the deposit.
+     * It is computed according to the flat_amount and the invoice total and is rounded to 2 digits precision.
+     * @readonly
+     */
+    percentage?: string;
+    /** The type of the deposit. The default is FLAT. */
+    type?: DepositType;
 }
-export interface Reschedule {
-    executeAt?: Date;
-    payload?: string | null;
+export declare enum DepositType {
+    UNKNOWN = "UNKNOWN",
+    FLAT = "FLAT",
+    PERCENTAGE = "PERCENTAGE"
 }
-export interface InvoiceSentEvent {
-    id?: IdAndVersion;
-    /** @readonly */
-    data?: InvoiceFields;
-    /** @readonly */
-    status?: InvoiceStatus;
+/**
+ * InvoiceStatus allowed transitions based on current status:
+ * Draft -> Deleted, Paid, Partially Paid, Sent
+ * Sent -> Draft, Deleted, Void, Paid, Partially Paid, Processing, (Overdue)
+ * Processing -> PartiallyPaid, Paid, Sent
+ * Paid -> Void
+ * PartiallyPaid -> Void, (PartialAndOverdue)
+ * Void -> Deleted
+ * Deleted
+ */
+export declare enum InvoiceStatus {
+    Draft = "Draft",
+    Sent = "Sent",
+    Processing = "Processing",
+    Paid = "Paid",
+    Overdue = "Overdue",
+    Void = "Void",
+    Deleted = "Deleted",
+    PartiallyPaid = "PartiallyPaid",
+    PartialAndOverdue = "PartialAndOverdue"
 }
 export interface TriggerSideEffectsFromLegacyData {
     storeId?: string;
@@ -4164,6 +4191,14 @@ export interface GetOrderResponseNonNullableFields {
                 };
             };
         };
+        tags?: {
+            privateTags?: {
+                tagIds: string[];
+            };
+            tags?: {
+                tagIds: string[];
+            };
+        };
     };
 }
 export interface SearchOrdersResponseNonNullableFields {
@@ -4688,6 +4723,14 @@ export interface SearchOrdersResponseNonNullableFields {
                 };
             };
         };
+        tags?: {
+            privateTags?: {
+                tagIds: string[];
+            };
+            tags?: {
+                tagIds: string[];
+            };
+        };
     }[];
 }
 export interface CreateOrderResponseNonNullableFields {
@@ -5212,6 +5255,14 @@ export interface CreateOrderResponseNonNullableFields {
                 };
             };
         };
+        tags?: {
+            privateTags?: {
+                tagIds: string[];
+            };
+            tags?: {
+                tagIds: string[];
+            };
+        };
     };
 }
 export interface UpdateOrderResponseNonNullableFields {
@@ -5736,6 +5787,14 @@ export interface UpdateOrderResponseNonNullableFields {
                 };
             };
         };
+        tags?: {
+            privateTags?: {
+                tagIds: string[];
+            };
+            tags?: {
+                tagIds: string[];
+            };
+        };
     };
 }
 export interface CancelOrderResponseNonNullableFields {
@@ -6260,5 +6319,13 @@ export interface CancelOrderResponseNonNullableFields {
                 };
             };
         };
+        tags?: {
+            privateTags?: {
+                tagIds: string[];
+            };
+            tags?: {
+                tagIds: string[];
+            };
+        };
     };
 }