@wix/stores 1.0.22 → 1.0.24

package/build/cjs/src/stores-v2-orders.types.d.ts

@@ -0,0 +1,1075 @@
+export interface Order {
+    /**
+     * Order ID (auto-generated upon order creation).
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Order number displayed in the owner's store (auto-generated).
+     * @readonly
+     */
+    number?: number;
+    /**
+     * Order creation date and time.
+     * @readonly
+     */
+    dateCreated?: Date;
+    /** Buyer information. */
+    buyerInfo?: BuyerInfo;
+    /** Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format. */
+    currency?: string | null;
+    /** Weight unit used in this store. */
+    weightUnit?: WeightUnit;
+    /** Totals for order's line items. */
+    totals?: Totals;
+    /** Billing information. */
+    billingInfo?: BillingInfo;
+    /** Shipping information. */
+    shippingInfo?: ShippingInfo;
+    /** A note added by the buyer. */
+    buyerNote?: string | null;
+    /**
+     * Deprecated.
+     * @readonly
+     */
+    read?: boolean;
+    /**
+     * Whether or not the order was archived.
+     * @readonly
+     */
+    archived?: boolean;
+    /** Current status of the payment. */
+    paymentStatus?: PaymentStatus;
+    /**
+     * Order's current fulfillment status (whether the order received a tracking number or was delivered/picked up).
+     * @readonly
+     */
+    fulfillmentStatus?: FulfillmentStatus;
+    /** Line items ordered. */
+    lineItems?: LineItem[];
+    /**
+     * Log of updates related to the order.
+     * @readonly
+     */
+    activities?: Activity[];
+    /** Invoice information. */
+    invoiceInfo?: InvoiceInfo;
+    /**
+     * Order fulfillment information.
+     * @readonly
+     */
+    fulfillments?: Fulfillment[];
+    /** Discount information. */
+    discount?: Discount;
+    /** Custom field information. */
+    customField?: CustomField;
+    /** Shopping cart ID. */
+    cartId?: string | null;
+    /**
+     * Language for communication with the buyer. Defaults to the site language.
+     * For a site that supports multiple languages, this is the language the buyer selected.
+     */
+    buyerLanguage?: string | null;
+    /** Information about the sales channel that submitted this order. */
+    channelInfo?: ChannelInfo;
+    /**
+     * Identity of the order's initiator.
+     * @readonly
+     */
+    enteredBy?: EnteredBy;
+    /**
+     * Date and time of latest update.
+     * @readonly
+     */
+    lastUpdated?: Date;
+    /** Subscription information. */
+    subscriptionInfo?: SubscriptionInfo;
+    /**
+     * Order’s unique numeric ID.
+     * Primarily used for sorting and filtering when crawling all orders.
+     * @readonly
+     */
+    numericId?: string;
+    /**
+     * Refund information.
+     * @readonly
+     */
+    refunds?: Refund[];
+}
+/** Buyer Info */
+export interface BuyerInfo {
+    /** Wix customer ID */
+    id?: string | null;
+    /**
+     * Deprecated (use identityType instead)
+     * @readonly
+     */
+    type?: IdentityType;
+    /** Customer type */
+    identityType?: IdentityType;
+    /**
+     * Customer's first name
+     * @readonly
+     */
+    firstName?: string;
+    /**
+     * Customer's last name
+     * @readonly
+     */
+    lastName?: string;
+    /**
+     * Customer's phone number
+     * @readonly
+     */
+    phone?: string | null;
+    /**
+     * Customer's email address
+     * @readonly
+     */
+    email?: string;
+}
+export declare enum IdentityType {
+    UNSPECIFIED_IDENTITY_TYPE = "UNSPECIFIED_IDENTITY_TYPE",
+    /** Site member */
+    MEMBER = "MEMBER",
+    /** Contact */
+    CONTACT = "CONTACT"
+}
+export declare enum WeightUnit {
+    /** Weight unit can't be classified, due to an error */
+    UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
+    /** Kilograms */
+    KG = "KG",
+    /** Pounds */
+    LB = "LB"
+}
+export interface Totals {
+    /** Subtotal of all the line items, before tax. */
+    subtotal?: string;
+    /** Total shipping price, before tax. */
+    shipping?: string | null;
+    /** Total tax. */
+    tax?: string | null;
+    /** Total calculated discount value. */
+    discount?: string | null;
+    /** Total price charged. */
+    total?: string;
+    /**
+     * Total items weight.
+     * @readonly
+     */
+    weight?: string;
+    /**
+     * Total number of line items.
+     * @readonly
+     */
+    quantity?: number;
+    /**
+     * Total refund.
+     * @readonly
+     */
+    refund?: string | null;
+    /** Total calculated gift card value. */
+    giftCard?: string | null;
+}
+export interface BillingInfo {
+    /** Payment method used for this order */
+    paymentMethod?: string | null;
+    /**
+     * Deprecated (use paymentProviderTransactionId instead)
+     * @readonly
+     */
+    externalTransactionId?: string | null;
+    /** Transaction ID from payment provider (e.g., PayPal, Square, Stripe) transaction ID */
+    paymentProviderTransactionId?: string | null;
+    /** Transaction ID from payment gateway (e.g., Wix Payments) */
+    paymentGatewayTransactionId?: string | null;
+    /** Full billing address */
+    address?: Address;
+    /**
+     * Payment date
+     * @readonly
+     */
+    paidDate?: Date;
+    /** Whether order can be refunded by payment provider (manually or automatic) */
+    refundableByPaymentProvider?: boolean | null;
+}
+export interface Address extends AddressAddressLine1OptionsOneOf {
+    /** Addressee name */
+    fullName?: FullName;
+    /** Country code (2 letters) */
+    country?: string | null;
+    /** State or district */
+    subdivision?: string | null;
+    /** City name */
+    city?: string | null;
+    /** ZIP/postal code */
+    zipCode?: string | null;
+    /** Phone number */
+    phone?: string | null;
+    /** Company name */
+    company?: string | null;
+    /** Email address */
+    email?: string | null;
+    /** address line */
+    addressLine2?: string | null;
+    /** Tax information (for Brazil only) */
+    vatId?: VatId;
+    /** Address line 1 (free text) */
+    addressLine1?: string;
+    /** Address line 1 (street) */
+    street?: Street;
+}
+/** @oneof */
+export interface AddressAddressLine1OptionsOneOf {
+    /** Address line 1 (free text) */
+    addressLine1?: string;
+    /** Address line 1 (street) */
+    street?: Street;
+}
+export interface FullName {
+    /** Customer's first name */
+    firstName?: string;
+    /** Customer's last name */
+    lastName?: string;
+}
+export interface Street {
+    /** Street number */
+    number?: string;
+    /** Street name */
+    name?: string;
+}
+export interface VatId {
+    /** Customer's tax ID */
+    number?: string;
+    /** tax type */
+    type?: VatType;
+}
+/** Brazilian tax info types */
+export declare enum VatType {
+    /** When the tax info type can't be classified, due to an error */
+    UNSPECIFIED_TAX_TYPE = "UNSPECIFIED_TAX_TYPE",
+    /** CPF - for individual tax payers */
+    CPF = "CPF",
+    /** CNPJ - for corporations */
+    CNPJ = "CNPJ"
+}
+export interface ShippingInfo extends ShippingInfoDetailsOneOf {
+    /** Shipping option name. */
+    deliveryOption?: string;
+    /** Shipping option delivery time. */
+    estimatedDeliveryTime?: string | null;
+    /** Latest expected delivery date. */
+    deliverByDate?: Date;
+    /** Shipping region. */
+    shippingRegion?: string | null;
+    /**
+     * Unique code of provided shipping option. For example, `"usps_std_overnight"`.
+     * @readonly
+     */
+    code?: string | null;
+    /** Shipment details (when this object describes shipment). */
+    shipmentDetails?: ShipmentDetails;
+    /** Pickup details (when this object describes pickup). */
+    pickupDetails?: PickupDetails;
+}
+/** @oneof */
+export interface ShippingInfoDetailsOneOf {
+    /** Shipment details (when this object describes shipment). */
+    shipmentDetails?: ShipmentDetails;
+    /** Pickup details (when this object describes pickup). */
+    pickupDetails?: PickupDetails;
+}
+export interface ShipmentDetails {
+    /** Shipping destination address. */
+    address?: Address;
+    /**
+     * Deprecated (use fulfillments instead).
+     * @readonly
+     */
+    trackingInfo?: TrackingInfo;
+    /** Discount applied for shipping. */
+    discount?: string | null;
+    /** Tax applied for shipping. */
+    tax?: string | null;
+    /** Price data. */
+    priceData?: ShippingPriceData;
+}
+export interface TrackingInfo {
+    /**
+     * Tracking number
+     * @readonly
+     */
+    trackingNumber?: string | null;
+    /**
+     * Shipping provider
+     * @readonly
+     */
+    shippingProvider?: string | null;
+    /**
+     * Tracking link
+     * @readonly
+     */
+    trackingLink?: string | null;
+}
+export interface ShippingPriceData {
+    /** Whether tax is included in the price. */
+    taxIncludedInPrice?: boolean;
+    /** Shipping price. */
+    price?: string | null;
+}
+export interface PickupDetails {
+    /** Pickup address. */
+    pickupAddress?: PickupAddress;
+    /**
+     * Deprecated (use billingInfo instead).
+     * @readonly
+     */
+    buyerDetails?: BuyerDetails;
+    /** Store owner's pickup instructions. */
+    pickupInstructions?: string | null;
+}
+export interface PickupAddress {
+    /** Country code (3 letters) */
+    country?: string;
+    /** State/District */
+    subdivision?: string | null;
+    /** Address */
+    addressLine1?: string;
+    /** City */
+    city?: string;
+    /** ZIP/postal code */
+    zipCode?: string;
+}
+export interface BuyerDetails {
+    /** Addressee name */
+    fullName?: FullName;
+    /** Email address */
+    email?: string;
+    /** Phone number */
+    phone?: string;
+}
+/** This might be extended in the future with pending orders statuses */
+export declare enum PaymentStatus {
+    /** Payment status can't be classified, due to an error */
+    UNSPECIFIED_PAYMENT_STATUS = "UNSPECIFIED_PAYMENT_STATUS",
+    /** Order is pending response from the payment provider */
+    PENDING = "PENDING",
+    /** Order is marked as not paid, and can be marked as paid later on. This is relevant for POS and offline orders */
+    NOT_PAID = "NOT_PAID",
+    /** The order is marked as paid */
+    PAID = "PAID",
+    /** Order was refunded, refund amount less than order total price */
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    /** Full order total price was refunded */
+    FULLY_REFUNDED = "FULLY_REFUNDED",
+    /** At least one payment was received and approved, covering less than total price amount */
+    PARTIALLY_PAID = "PARTIALLY_PAID"
+}
+export declare enum FulfillmentStatus {
+    /** None of the order items are fulfilled */
+    NOT_FULFILLED = "NOT_FULFILLED",
+    /**
+     * All of the order items are fulfilled
+     * Orders without shipping info are fulfilled automatically
+     */
+    FULFILLED = "FULFILLED",
+    /** Order is canceled */
+    CANCELED = "CANCELED",
+    /** Some, but not all of the order items are fulfilled */
+    PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
+}
+export interface LineItem {
+    /**
+     * Line item ID (auto-generated, stable within this order only)
+     * @readonly
+     */
+    index?: number | null;
+    /** Line item quantity */
+    quantity?: number;
+    /**
+     * Deprecated (use priceData instead)
+     * @readonly
+     */
+    price?: string | null;
+    /** Line item name */
+    name?: string | null;
+    /** Product name, translated into the customer's language */
+    translatedName?: string | null;
+    /** Line item product ID (optional for POS orders) */
+    productId?: string | null;
+    /**
+     * Deprecated (use priceData instead)
+     * @readonly
+     */
+    totalPrice?: string | null;
+    /** Line item type (may be extended) */
+    lineItemType?: LineItemType;
+    /** Line item options ordered */
+    options?: OptionSelection[];
+    /** Line item custom text field entry */
+    customTextFields?: CustomTextFieldSelection[];
+    /** Line item weight */
+    weight?: string | null;
+    /** Primary media for preview of the line item */
+    mediaItem?: MediaItem;
+    /** Line item SKU */
+    sku?: string | null;
+    /** Line item notes */
+    notes?: string | null;
+    /** Line item variantId (from Stores Catalog) */
+    variantId?: string | null;
+    /** Line item fulfillerId from stores fulfillers. No value equals self fulfilled */
+    fulfillerId?: string | null;
+    /** Discount applied for this line item */
+    discount?: string | null;
+    /** Tax applied for this line item */
+    tax?: string | null;
+    /**
+     * Deprecated (use priceData instead)
+     * @readonly
+     */
+    taxIncludedInPrice?: boolean;
+    /** Tax group ID */
+    taxGroupId?: string | null;
+    /** Price data */
+    priceData?: LineItemPriceData;
+}
+export declare enum LineItemType {
+    /** Line item type can't be classified, due to an error */
+    UNSPECIFIED_LINE_ITEM_TYPE = "UNSPECIFIED_LINE_ITEM_TYPE",
+    /** Physical item type */
+    PHYSICAL = "PHYSICAL",
+    /** Digital item type */
+    DIGITAL = "DIGITAL",
+    /** Custom item price */
+    CUSTOM_AMOUNT_ITEM = "CUSTOM_AMOUNT_ITEM"
+}
+export interface OptionSelection {
+    /** Option name */
+    option?: string;
+    /** Selected choice for this option */
+    selection?: string;
+}
+export interface CustomTextFieldSelection {
+    /** Custom text field name */
+    title?: string;
+    /** Custom text field value */
+    value?: string;
+}
+export interface MediaItem {
+    /**
+     * Media type
+     * @readonly
+     */
+    mediaType?: MediaItemType;
+    /**
+     * Media URL
+     * @readonly
+     */
+    url?: string;
+    /**
+     * Media item width
+     * @readonly
+     */
+    width?: number;
+    /**
+     * Media item height
+     * @readonly
+     */
+    height?: number;
+    /** Deprecated */
+    mediaId?: string | null;
+    /** Media ID (for media items previously saved in Wix Media) */
+    id?: string | null;
+    /** Media external URL */
+    externalImageUrl?: string | null;
+    /** Alternative text for presentation when media cannot be displayed */
+    altText?: string | null;
+}
+export declare enum MediaItemType {
+    /** Media item type can't be classified, due to an error */
+    UNSPECIFIED_MEDIA_TYPE_ITEM = "UNSPECIFIED_MEDIA_TYPE_ITEM",
+    /** Image item type */
+    IMAGE = "IMAGE"
+}
+export interface LineItemPriceData {
+    /** Whether tax is included in the price set for this line item */
+    taxIncludedInPrice?: boolean;
+    /** Line item price */
+    price?: string;
+    /**
+     * Total price charged to the customer (per line item) after computation of quantity and discount
+     * @readonly
+     */
+    totalPrice?: string | null;
+}
+export interface DigitalFile {
+    /** id of the secure file in media */
+    fileId?: string;
+}
+export interface Activity {
+    /**
+     * Activity item type
+     * @readonly
+     */
+    type?: ActivityType;
+    /**
+     * Activity item author
+     * @readonly
+     */
+    author?: string | null;
+    /**
+     * Comment added to activity item
+     * @readonly
+     */
+    message?: string | null;
+    /**
+     * Activity item timestamp
+     * @readonly
+     */
+    timestamp?: Date;
+}
+export declare enum ActivityType {
+    /** Activity item type can't be classified, due to an error */
+    UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE = "UNSPECIFIED_ORDER_HISTORY_ITEM_TYPE",
+    /** Store owner added a comment */
+    MERCHANT_COMMENT = "MERCHANT_COMMENT",
+    /** Order placed */
+    ORDER_PLACED = "ORDER_PLACED",
+    /** Order marked as paid, either by the store owner (for offline orders), or when an online transaction was confirmed */
+    ORDER_PAID = "ORDER_PAID",
+    /** Order shipping status set as fulfilled */
+    ORDER_FULFILLED = "ORDER_FULFILLED",
+    /** Order shipping status set as not fulfilled */
+    ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
+    /** A download link was sent (relevant for orders with digital line items) */
+    DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
+    /** An email notification for pickup was sent */
+    PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
+    /** Shipping tracking number was set */
+    TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
+    /** Shipping tracking number was edited */
+    TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
+    /** Shipping tracking link was set */
+    TRACKING_LINK_WAS_SET = "TRACKING_LINK_WAS_SET",
+    /** An email confirmation of order shipment was sent */
+    SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
+    /** Invoice was set in the order */
+    INVOICE_WAS_SET = "INVOICE_WAS_SET",
+    /** Invoice was removed from the order */
+    INVOICE_WAS_REMOVED = "INVOICE_WAS_REMOVED",
+    /** Invoice was sent to customer via email */
+    INVOICE_WAS_SENT = "INVOICE_WAS_SENT",
+    /** Email was sent to fulfiller */
+    FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
+    /** Shipping address was updated */
+    SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
+    /** Order email was updated */
+    EMAIL_EDITED = "EMAIL_EDITED",
+    /** Order partially paid. During the checkout for orders with deposit items. */
+    ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID"
+}
+export interface InvoiceInfo {
+    /** Invoice ID */
+    id?: string;
+    /** Invoice source */
+    source?: InvoiceSource;
+}
+export declare enum InvoiceSource {
+    /** Invoice source can't be classified, due to an error */
+    UNSPECIFIED_INVOICE_SOURCE = "UNSPECIFIED_INVOICE_SOURCE",
+    /** Invoice created using the Invoices API */
+    WIX = "WIX"
+}
+export interface Fulfillment {
+    /**
+     * Fulfillment ID (auto generated upon fulfillment creation).
+     * @readonly
+     */
+    id?: string | null;
+    /**
+     * Fulfillment creation date and time.
+     * @readonly
+     */
+    dateCreated?: Date;
+    /** Information about the line items in the fulfilled order. */
+    lineItems?: FulfillmentLineItem[];
+    /** Tracking information. */
+    trackingInfo?: FulfillmentTrackingInfo;
+}
+export interface FulfillmentLineItem {
+    /** Line item ID (mirrors the line item index of the order). */
+    index?: number;
+    /**
+     * Line item quantity.
+     * On creation, if this parameter isn't passed, the new fulfillment will automatically include all items of this line item that have not already been linked to a fulfillment.
+     * If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error will be returned.
+     * This property will always have a value when returned.
+     */
+    quantity?: number | null;
+}
+export interface FulfillmentTrackingInfo {
+    /** Tracking number. */
+    trackingNumber?: string;
+    /**
+     * Shipping provider. Using the following shipping providers will allow for autofilling the tracking link:
+     * * `fedex`
+     * * `ups`
+     * * `usps`
+     * * `dhl`
+     * * `canadaPost`
+     */
+    shippingProvider?: string;
+    /** Tracking link - autofilled if using a predefined shipping provider, otherwise provided on creation. */
+    trackingLink?: string | null;
+}
+export interface Discount {
+    /**
+     * Deprecated (use Totals.discount instead)
+     * @readonly
+     */
+    value?: string;
+    /** Applied coupon */
+    appliedCoupon?: AppliedCoupon;
+}
+export interface AppliedCoupon {
+    /** Coupon ID */
+    couponId?: string;
+    /** Coupon name */
+    name?: string;
+    /** Coupon code */
+    code?: string;
+}
+/** Custom field */
+export interface CustomField {
+    /** Free text that the customer entered in the custom field during the checkout process */
+    value?: string;
+    /** Title for the custom field */
+    title?: string;
+    /** The title translated according to the buyer language */
+    translatedTitle?: string;
+}
+export interface ChannelInfo {
+    /** Sales channel that submitted the order */
+    type?: ChannelType;
+    /** Reference to an order ID from an external system, as defined in channelInfo (e.g., eBay or Amazon) */
+    externalOrderId?: string | null;
+    /** URL to the order in the external system, as defined in channelInfo (e.g., eBay or Amazon) */
+    externalOrderUrl?: string | null;
+}
+export declare enum ChannelType {
+    UNSPECIFIED = "UNSPECIFIED",
+    WEB = "WEB",
+    POS = "POS",
+    EBAY = "EBAY",
+    AMAZON = "AMAZON",
+    OTHER_PLATFORM = "OTHER_PLATFORM",
+    WIX_APP_STORE = "WIX_APP_STORE",
+    WIX_INVOICES = "WIX_INVOICES",
+    BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
+    WISH = "WISH"
+}
+export interface EnteredBy {
+    id?: string;
+    identityType?: EnteredByIdentityType;
+}
+export declare enum EnteredByIdentityType {
+    USER = "USER",
+    MEMBER = "MEMBER",
+    CONTACT = "CONTACT",
+    APP = "APP"
+}
+export interface SubscriptionInfo {
+    /** Subscription ID. */
+    id?: string | null;
+    /** Current cycle number. For example, if the subscription is in the 3rd month of a 4-month subscription, the value will be `3`. */
+    cycleNumber?: number;
+    /** Subscription settings. */
+    subscriptionSettings?: SubscriptionSettings;
+    /** Subscription options info. */
+    subscriptionOptionInfo?: SubscriptionOptionInfo;
+}
+export interface SubscriptionSettings {
+    /** Frequency of recurring payment. */
+    frequency?: SubscriptionFrequency;
+    /** Whether subscription is renewed automatically at the end of each period. */
+    autoRenewal?: boolean;
+    /** Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`. */
+    billingCycles?: number | null;
+}
+/** Frequency unit of recurring payment */
+export declare enum SubscriptionFrequency {
+    UNDEFINED = "UNDEFINED",
+    DAY = "DAY",
+    WEEK = "WEEK",
+    MONTH = "MONTH",
+    YEAR = "YEAR"
+}
+export interface SubscriptionOptionInfo {
+    /** Subscription option title. */
+    title?: string;
+    /** Subscription option description. */
+    description?: string | null;
+}
+export interface Refund {
+    /** Refund created timestamp. */
+    dateCreated?: Date;
+    /** Refund amount. */
+    amount?: string;
+    /** Reason for refund, given by user (optional). */
+    reason?: string | null;
+    /** Payment provider transaction ID. Used to find refund transaction info on the payment provider's side. */
+    paymentProviderTransactionId?: string | null;
+    /** Refund ID. */
+    id?: string;
+    /** Whether refund was made externally (on the payment provider's side). */
+    externalRefund?: boolean;
+}
+export interface GiftCard {
+    transactionId?: string;
+    /** giftcard internal ID */
+    id?: string;
+    /** giftcard provider appid */
+    providerId?: string;
+    /** giftcard amount */
+    amount?: string;
+}
+export interface OrderAddressUpdated {
+    /**
+     * Updated order data.
+     * @readonly
+     */
+    order?: Order;
+}
+export interface CreateOrderRequest {
+    order: Order;
+}
+export interface AdditionalOrderSettings {
+    /** ID of the line item this setting applies to */
+    lineItemId?: string | null;
+    /** Whether this line item purchase was made as part of a purchase that includes preorder items. */
+    preorderRequest?: boolean;
+}
+export interface CreateOrderResponse {
+    order?: Order;
+}
+export interface BulkFulfillOrdersRequest {
+    filter?: Record<string, any> | null;
+    /** when true shipping confirmation email will be sent to the buyer for all orders with shipment delivery */
+    sendShippingConfirmationEmail?: boolean;
+    /** when true pickup ready email will be sent to the buyer for all orders with pickup delivery */
+    sendPickupReadyEmail?: boolean;
+}
+export interface BulkFulfillOrdersResponse {
+}
+export interface BulkMarkOrdersAsPaidRequest {
+    filter?: Record<string, any> | null;
+}
+export interface BulkMarkOrdersAsPaidResponse {
+}
+export interface BulkArchiveOrdersRequest {
+    filter?: Record<string, any> | null;
+}
+export interface BulkArchiveOrdersResponse {
+}
+export interface BulkUnarchiveOrdersRequest {
+    filter?: Record<string, any> | null;
+}
+export interface BulkUnarchiveOrdersResponse {
+}
+export interface AddFulfillerEmailWasSentActivityRequest {
+    orderId?: string;
+}
+export interface AddFulfillerEmailWasSentActivityResponse {
+}
+export interface DeclineOrderRequest {
+    orderId?: string;
+    eventTime?: Date;
+    reason?: string | null;
+}
+export interface DeclineOrderResponse {
+}
+export interface UpdateOrderEmailRequest {
+    /**
+     * Order ID.
+     * @readonly
+     */
+    orderId: string;
+    /** New email address for billing and shipping info. */
+    email?: string;
+}
+export interface UpdateOrderEmailResponse {
+    /** Updated order data. */
+    order?: Order;
+}
+export interface UpdateOrderShippingAddressRequest {
+    /**
+     * Order ID.
+     * @readonly
+     */
+    orderId: string;
+    /** New order shipping address. */
+    shippingAddress?: Address;
+}
+export interface UpdateOrderShippingAddressResponse {
+    /** Updated order data. */
+    order?: Order;
+}
+export interface DiffmatokyPayload {
+    left?: string;
+    right?: string;
+    compareChannel?: string;
+    entityId?: string;
+    errorInformation?: ErrorInformation;
+    tags?: string[];
+}
+export interface ErrorInformation {
+    stackTrace?: string;
+}
+export interface OrderCreated {
+    /** Order ID (auto generated upon order creation) */
+    orderId?: string;
+    /** ID displayed in the owner's store (auto generated) */
+    number?: string;
+    /** Order creation date */
+    dateCreated?: Date;
+    /** Customer information */
+    buyerInfo?: BuyerInfo;
+    /** Currency used for pricing in this store */
+    currency?: string;
+    /** Weight unit used in this store */
+    weightUnit?: WeightUnit;
+    /** Totals for order's line items */
+    totals?: Totals;
+    /** Whether the order was read by the store owner */
+    read?: boolean;
+    /** Order archive status */
+    archived?: boolean;
+    /** Order payment status */
+    paymentStatus?: PaymentStatus;
+    /** Order fulfillment status */
+    fulfillmentStatus?: FulfillmentStatus;
+}
+export interface OrdersExperiments {
+    epCommitTax?: boolean;
+    moveMerchantEmailToEp?: boolean;
+    moveBuyerOrderConfirmationEmailToEp?: boolean;
+    producedByEpBridge?: boolean;
+}
+export interface OrderPaid {
+    /** Paid order data. */
+    order?: Order;
+}
+export interface OrderCancelRefundEvent {
+    /** @readonly */
+    isCancel?: boolean;
+    /**
+     * date when cancel/refund was issued
+     * @readonly
+     */
+    issueDate?: Date;
+    /** will be defined if order was refunded */
+    refund?: Refund;
+    orderData?: OrderData;
+}
+export interface OrderData {
+    /**
+     * Order ID (auto generated upon order creation)
+     * @readonly
+     */
+    orderId?: string;
+    /**
+     * means that order paid with cash, such orders might be not paid
+     * @readonly
+     */
+    isOffline?: boolean;
+    /**
+     * Order payment status
+     * @readonly
+     */
+    paymentStatus?: PaymentStatus;
+    /** Total price charged when order placed, this value isn't affected by refunds */
+    originalTotal?: string;
+    /**
+     * Order creation date
+     * @readonly
+     */
+    dateCreated?: Date;
+}
+export interface OrderCanceled {
+    /**
+     * Canceled order data.
+     * @readonly
+     */
+    order?: Order;
+}
+export interface OrderRefunded {
+    /**
+     * Refund ID.
+     * @readonly
+     */
+    refundId?: string;
+    /**
+     * Refunded order data.
+     * @readonly
+     */
+    order?: Order;
+}
+export interface FulfillmentCreated {
+    /** Order ID (auto generated upon order creation). */
+    orderId?: string;
+    /** ID of the newly created fulfillment. */
+    fulfillmentId?: string;
+    /** Fulfillment creation date and time. */
+    dateCreated?: Date;
+    /** Buyer information. */
+    buyerInfo?: BuyerInfo;
+    /** Order fulfillment status. */
+    fulfillmentStatus?: FulfillmentStatus;
+    /** Fulfillment tracking information. */
+    trackingInfo?: FulfillmentTrackingInfo;
+}
+export interface FulfillmentUpdated {
+    /** Order ID (auto generated upon order creation). */
+    orderId?: string;
+    /** ID of the updated fulfillment. */
+    fulfillmentId?: string;
+    /** Fulfillment tracking information. */
+    trackingInfo?: FulfillmentTrackingInfo;
+}
+export interface FulfillmentDeleted {
+    /** Order ID (auto generated upon order creation). */
+    orderId?: string;
+    /** ID of the deleted fulfillment. */
+    fulfillmentId?: string;
+    /** Order fulfillment status. */
+    fulfillmentStatus?: FulfillmentStatus;
+}
+export interface OrderDeclined {
+    order?: Order;
+}
+export interface GetOrderRequestV2 {
+    /** Requested order ID */
+    id: string;
+}
+export interface GetOrderResponseV2 {
+    /** Order data */
+    order?: Order;
+}
+export interface QueryOrdersRequestV2 {
+    /** Query */
+    query?: Query;
+}
+export interface Query {
+    paging?: Paging;
+    /** A filter string */
+    filter?: string | null;
+    /** A sort string */
+    sort?: string | null;
+}
+export interface Paging {
+    /** Number of items to load */
+    limit?: number | null;
+    /** The offset since the beginning of the collection */
+    offset?: number | null;
+}
+export interface QueryOrdersResponseV2 {
+    /** Order data */
+    orders?: Order[];
+    /** Paging metadata */
+    metadata?: PagingMetadata;
+    /** Total results */
+    totalResults?: number;
+}
+export interface PagingMetadata {
+    /** Requested number of items to load */
+    items?: number;
+    /** Requested offset since the beginning of the collection */
+    offset?: number;
+}
+export interface CreateFulfillmentRequest {
+    /** Order ID (to which the fulfillment will be related). */
+    orderId: string;
+    /** Fulfillment info. */
+    fulfillment: Fulfillment;
+}
+export interface CreateFulfillmentResponse {
+    /** Fulfillment ID. */
+    id?: string;
+    /** Updated order data. */
+    order?: Order;
+}
+export interface UpdateFulfillmentRequest {
+    /** Order ID. */
+    orderId: string;
+    /** Fulfillment ID */
+    fulfillmentId: string;
+    /** Updated tracking info. */
+    fulfillmentTrackingInfo?: FulfillmentTrackingInfo;
+}
+export interface UpdateFulfillmentResponse {
+    /** Updated order data. */
+    order?: Order;
+}
+export interface DeleteFulfillmentRequest {
+    /** Order ID. */
+    orderId: string;
+    /** Fulfillment ID. */
+    fulfillmentId: string;
+}
+export interface DeleteFulfillmentResponse {
+    /** Updated order data. */
+    order?: Order;
+}
+export interface MarkAsPaidRequest {
+    /** The order id */
+    id?: string;
+    /** The payment info */
+    paymentInfo?: RequestPaymentInfo;
+}
+export interface RequestPaymentInfo {
+    /** Payment method used for this order */
+    paymentMethod?: string;
+    /** External transaction ID */
+    externalTransactionId?: string;
+}
+export interface MarkAsPaidResponse {
+}
+export interface SetShippingFulfillmentRequest {
+    /** The order id */
+    id?: string;
+    /** Shipment fulfillment status */
+    status?: ShipmentFulfillmentStatus;
+}
+/** This may be expanded in the future to include partial fulfillments */
+export declare enum ShipmentFulfillmentStatus {
+    /** Shipment fulfillment status can't be classified, due to an error */
+    UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS = "UNSPECIFIED_SHIPMENT_FULFILLMENT_STATUS",
+    /** Entire order's shipment is not fulfilled */
+    SHIPMENT_NOT_FULFILLED = "SHIPMENT_NOT_FULFILLED",
+    /** Entire order's shipment is fulfilled */
+    SHIPMENT_FULFILLED = "SHIPMENT_FULFILLED"
+}
+export interface SetShippingFulfillmentResponse {
+}
+export interface SendFulfillmentConfirmationRequest {
+    /** The order id */
+    id?: string;
+}
+export interface SendFulfillmentConfirmationResponse {
+}
+export interface MarkAsReadRequest {
+    /** The order id */
+    id?: string;
+}
+export interface MarkAsReadResponse {
+}
+export interface SetArchiveStatusRequest {
+    /** The order id */
+    id?: string;
+    /** New archive status */
+    archived?: boolean;
+}
+export interface SetArchiveStatusResponse {
+}