@wix/auto_sdk_ecom_checkout-templates 1.0.66 → 1.0.67

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -258,6 +258,16 @@ interface Color {
258
258
  /** HEX or RGB color code for display. */
259
259
  code?: string | null;
260
260
  }
261
+ declare enum DescriptionLineType {
262
+ /** Unrecognized type. */
263
+ UNRECOGNISED = "UNRECOGNISED",
264
+ /** Plain text type. */
265
+ PLAIN_TEXT = "PLAIN_TEXT",
266
+ /** Color type. */
267
+ COLOR = "COLOR"
268
+ }
269
+ /** @enumType */
270
+ type DescriptionLineTypeWithLiterals = DescriptionLineType | 'UNRECOGNISED' | 'PLAIN_TEXT' | 'COLOR';
261
271
  interface PhysicalProperties {
262
272
  /** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
263
273
  weight?: number | null;
@@ -483,6 +493,115 @@ declare enum ItemTypeItemType {
483
493
  }
484
494
  /** @enumType */
485
495
  type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
496
+ interface SubscriptionOptionInfo {
497
+ /** Subscription option settings. */
498
+ subscriptionSettings?: SubscriptionSettings;
499
+ /** Subscription option title. */
500
+ title?: Title;
501
+ /** Subscription option description. */
502
+ description?: Description;
503
+ }
504
+ interface SubscriptionSettings {
505
+ /** Frequency of recurring payment. */
506
+ frequency?: SubscriptionFrequencyWithLiterals;
507
+ /**
508
+ * Interval of recurring payment.
509
+ *
510
+ * Default: `1`.
511
+ * If SubscriptionFrequency is Day the minimum interval is 7
512
+ * @min 1
513
+ * @max 3650
514
+ */
515
+ interval?: number | null;
516
+ /** Whether subscription is renewed automatically at the end of each period. */
517
+ autoRenewal?: boolean;
518
+ /**
519
+ * Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`.
520
+ * @min 1
521
+ */
522
+ billingCycles?: number | null;
523
+ /** Whether to allow the customer to cancel the subscription.. */
524
+ enableCustomerCancellation?: boolean;
525
+ /**
526
+ * Period until first cycle starts. If applied payNow will be 0
527
+ * If None => no free trial
528
+ */
529
+ freeTrialPeriod?: FreeTrialPeriod;
530
+ }
531
+ /** Frequency unit of recurring payment */
532
+ declare enum SubscriptionFrequency {
533
+ UNDEFINED = "UNDEFINED",
534
+ DAY = "DAY",
535
+ WEEK = "WEEK",
536
+ MONTH = "MONTH",
537
+ YEAR = "YEAR"
538
+ }
539
+ /** @enumType */
540
+ type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
541
+ interface FreeTrialPeriod {
542
+ /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
543
+ frequency?: SubscriptionFrequencyWithLiterals;
544
+ /**
545
+ * interval of period
546
+ * @min 1
547
+ * @max 999
548
+ */
549
+ interval?: number;
550
+ }
551
+ interface Title {
552
+ /**
553
+ * Subscription option name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
554
+ * @minLength 1
555
+ * @maxLength 150
556
+ */
557
+ original?: string;
558
+ /**
559
+ * Subscription option name translated into the buyer's language.
560
+ *
561
+ * Default: Same as `original`.
562
+ * @minLength 1
563
+ * @maxLength 150
564
+ */
565
+ translated?: string | null;
566
+ }
567
+ interface Description {
568
+ /**
569
+ * Subscription option description.
570
+ * @maxLength 500
571
+ */
572
+ original?: string;
573
+ /**
574
+ * Translated subscription option description.
575
+ * @maxLength 500
576
+ */
577
+ translated?: string | null;
578
+ }
579
+ interface SecuredMedia {
580
+ /**
581
+ * Media ID in Wix Media Manager.
582
+ * @minLength 1
583
+ * @maxLength 100
584
+ */
585
+ id?: string;
586
+ /**
587
+ * Original filename.
588
+ * @minLength 1
589
+ * @maxLength 1000
590
+ */
591
+ fileName?: string;
592
+ /** File type. */
593
+ fileType?: FileTypeWithLiterals;
594
+ }
595
+ declare enum FileType {
596
+ UNSPECIFIED = "UNSPECIFIED",
597
+ SECURE_PICTURE = "SECURE_PICTURE",
598
+ SECURE_VIDEO = "SECURE_VIDEO",
599
+ SECURE_DOCUMENT = "SECURE_DOCUMENT",
600
+ SECURE_MUSIC = "SECURE_MUSIC",
601
+ SECURE_ARCHIVE = "SECURE_ARCHIVE"
602
+ }
603
+ /** @enumType */
604
+ type FileTypeWithLiterals = FileType | 'UNSPECIFIED' | 'SECURE_PICTURE' | 'SECURE_VIDEO' | 'SECURE_DOCUMENT' | 'SECURE_MUSIC' | 'SECURE_ARCHIVE';
486
605
  interface ServiceProperties {
487
606
  /**
488
607
  * 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.
@@ -587,6 +706,17 @@ interface V1ItemModifier {
587
706
  */
588
707
  price?: string | null;
589
708
  }
709
+ interface ExtendedFields {
710
+ /**
711
+ * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
712
+ * The value of each key is structured according to the schema defined when the extended fields were configured.
713
+ *
714
+ * You can only access fields for which you have the appropriate permissions.
715
+ *
716
+ * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
717
+ */
718
+ namespaces?: Record<string, Record<string, any>>;
719
+ }
590
720
  interface CustomContentReference {
591
721
  /**
592
722
  * ID of the app providing the content.
@@ -620,160 +750,1930 @@ interface ExternalReference {
620
750
  */
621
751
  resourceId?: string | null;
622
752
  }
623
- interface CreateCheckoutTemplateRequest {
624
- /** Checkout template to create. */
625
- checkoutTemplate: CheckoutTemplate;
626
- }
627
- interface CreateCheckoutTemplateResponse {
628
- /** Created checkout template. */
753
+ /** Triggered when newly checkout created successfully from checkout template */
754
+ interface CheckoutTemplateUsed {
755
+ /** checkout template */
629
756
  checkoutTemplate?: CheckoutTemplate;
757
+ /** newly created checkout */
758
+ checkout?: Checkout;
630
759
  }
631
- interface GetCheckoutTemplateRequest {
760
+ interface Checkout {
632
761
  /**
633
- * ID of the checkout template to retrieve.
762
+ * Checkout ID.
634
763
  * @format GUID
764
+ * @readonly
635
765
  */
636
- checkoutTemplateId: string;
637
- }
638
- interface GetCheckoutTemplateResponse {
639
- /** Retrieved checkout template. */
640
- checkoutTemplate?: CheckoutTemplate;
641
- }
642
- interface UpdateCheckoutTemplateRequest {
643
- /** Checkout template info to update. */
644
- checkoutTemplate: CheckoutTemplate;
645
- }
646
- interface UpdateCheckoutTemplateResponse {
647
- /** Updated checkout template. */
648
- checkoutTemplate?: CheckoutTemplate;
649
- }
650
- interface DeleteCheckoutTemplateRequest {
766
+ id?: string | null;
651
767
  /**
652
- * ID of the checkout template to delete.
653
- * @format GUID
768
+ * Line items.
769
+ *
770
+ * Max: 300 items
771
+ * @minSize 1
772
+ * @maxSize 300
773
+ * @readonly
654
774
  */
655
- checkoutTemplateId: string;
656
- }
657
- interface DeleteCheckoutTemplateResponse {
658
- }
659
- interface QueryCheckoutTemplatesRequest {
660
- /** Query options. */
661
- query?: CursorQuery;
662
- }
663
- interface CursorQuery extends CursorQueryPagingMethodOneOf {
664
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
665
- cursorPaging?: CursorPaging;
775
+ lineItems?: LineItem[];
776
+ /** Billing information. */
777
+ billingInfo?: AddressWithContact;
778
+ /** Shipping information. */
779
+ shippingInfo?: ShippingInfo;
666
780
  /**
667
- * Filter object in the following format:
668
- * `"filter" : {
669
- * "fieldName1": "value1",
670
- * "fieldName2":{"$operator":"value2"}
671
- * }`
781
+ * [Buyer note](https://support.wix.com/en/article/collecting-and-viewing-buyer-notes) left by the customer.
782
+ * @maxLength 1000
783
+ */
784
+ buyerNote?: string | null;
785
+ /** Buyer information. */
786
+ buyerInfo?: BuyerInfo;
787
+ /**
788
+ * The currency selected by the buyer during the purchase flow, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
789
+ * @readonly
790
+ * @format CURRENCY
791
+ */
792
+ conversionCurrency?: string;
793
+ /**
794
+ * Calculated price summary for the checkout.
795
+ * @readonly
796
+ */
797
+ priceSummary?: PriceSummary;
798
+ /**
799
+ * Errors when calculating totals.
800
+ * @readonly
801
+ */
802
+ calculationErrors?: CalculationErrors;
803
+ /**
804
+ * Applied gift card details.
672
805
  *
673
- * Example of operators: `$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome`
806
+ * >**Note:** Gift cards are supported through the Wix UI, though the service plugin is not currently available. Learn more about [Wix Gift Cards](https://support.wix.com/en/article/setting-up-wix-gift-cards-9451439).
807
+ * @readonly
674
808
  */
675
- filter?: Record<string, any> | null;
809
+ giftCard?: GiftCard;
676
810
  /**
677
- * Sort object in the following format:
678
- * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
811
+ * Applied discounts.
812
+ * @readonly
679
813
  */
680
- sort?: Sorting[];
681
- }
682
- /** @oneof */
683
- interface CursorQueryPagingMethodOneOf {
684
- /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
685
- cursorPaging?: CursorPaging;
686
- }
687
- interface Sorting {
688
- /** Name of the field to sort by. */
689
- fieldName?: string;
690
- /** Sort order. */
691
- order?: SortOrderWithLiterals;
692
- }
693
- declare enum SortOrder {
694
- /** Ascending order. */
695
- ASC = "ASC",
696
- /** Descending order. */
697
- DESC = "DESC"
698
- }
699
- /** @enumType */
700
- type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
701
- interface CursorPaging {
814
+ appliedDiscounts?: AppliedDiscount[];
815
+ /** Custom fields. */
816
+ customFields?: CustomField[];
702
817
  /**
703
- * Number of items to load.
704
- * @max 100
818
+ * Weight measurement unit. Defaults to a site's weight unit.
819
+ * @readonly
705
820
  */
706
- limit?: number | null;
821
+ weightUnit?: WeightUnitWithLiterals;
707
822
  /**
708
- * Pointer to the next or previous page in the list of results. </ br>
823
+ * Tax summary.
824
+ * @readonly
825
+ */
826
+ taxSummary?: TaxSummary;
827
+ /**
828
+ * The site's default currency, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
829
+ * @format CURRENCY
830
+ * @readonly
831
+ */
832
+ currency?: string;
833
+ /**
834
+ * Sales channel that submitted the order.
835
+ * @readonly
836
+ */
837
+ channelType?: ChannelTypeWithLiterals;
838
+ /**
839
+ * Site language in which original values are shown.
840
+ * @readonly
841
+ */
842
+ siteLanguage?: string;
843
+ /**
844
+ * Language for communication with the buyer. Defaults to the site language.
709
845
  *
710
- * You can get the relevant cursor token
711
- * from the `pagingMetadata` object in the previous call's response.
712
- * Not relevant for the first request.
846
+ * For a site that supports multiple languages, this is the language the buyer selected.
847
+ * @readonly
713
848
  */
714
- cursor?: string | null;
715
- }
716
- interface QueryCheckoutTemplatesResponse {
717
- /** Retrieved checkout templates. */
718
- checkoutTemplates?: CheckoutTemplate[];
719
- /** Paging metadata. */
720
- pagingMetadata?: CursorPagingMetadata;
721
- }
722
- interface CursorPagingMetadata {
723
- /** Number of items returned in the response. */
724
- count?: number | null;
725
- /** Offset that was requested. */
726
- cursors?: Cursors;
849
+ buyerLanguage?: string;
727
850
  /**
728
- * Indicates if there are more results after the current page.
729
- * If `true`, another page of results can be retrieved.
730
- * If `false`, this is the last page.
851
+ * Whether an order was successfully created from this checkout.
852
+ *
853
+ * For an order to be successful, it must be successfully paid for (unless the total is 0).
854
+ * @readonly
731
855
  */
732
- hasNext?: boolean | null;
733
- }
734
- interface Cursors {
735
- /** Cursor pointing to next page in the list of results. */
736
- next?: string | null;
737
- /** Cursor pointing to previous page in the list of results. */
738
- prev?: string | null;
739
- }
740
- interface CreateCheckoutFromTemplateRequest {
856
+ completed?: boolean;
741
857
  /**
742
- * ID of the checkout template to use to create a checkout from.
743
- * @format GUID
858
+ * Whether tax is included in line item prices.
859
+ * @readonly
744
860
  */
745
- checkoutTemplateId: string;
861
+ taxIncludedInPrice?: boolean;
746
862
  /**
747
- * ID of the site associated with the checkout template.
748
- * @format GUID
863
+ * ID of the checkout's initiator.
864
+ * @readonly
749
865
  */
750
- siteId: string;
751
- }
752
- interface CreateCheckoutFromTemplateResponse {
866
+ createdBy?: CreatedBy;
753
867
  /**
754
- * ID of the created checkout.
868
+ * Date and time the checkout was created.
869
+ * @readonly
870
+ */
871
+ createdDate?: Date | null;
872
+ /**
873
+ * Date and time the checkout was updated.
874
+ * @readonly
875
+ */
876
+ updatedDate?: Date | null;
877
+ /**
878
+ * Minimal amount to pay in order to place the order.
879
+ * @readonly
880
+ */
881
+ payNow?: PriceSummary;
882
+ /**
883
+ * Remaining amount for the order to be fully paid.
884
+ * @readonly
885
+ */
886
+ payLater?: PriceSummary;
887
+ /** Memberships to apply when creating the order. */
888
+ membershipOptions?: MembershipOptions;
889
+ /**
890
+ * Additional Fees.
891
+ * @maxSize 100
892
+ */
893
+ additionalFees?: AdditionalFee[];
894
+ /**
895
+ * Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart.
755
896
  * @format GUID
756
897
  */
757
- checkoutId?: string;
758
- /** URL of the created checkout page. */
759
- checkoutUrl?: string;
898
+ cartId?: string | null;
899
+ /**
900
+ * List of validation violations raised by the Validations service plugin ([SDK](https://dev.wix.com/docs/sdk/backend-modules/ecom/service-plugins/validations/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/e-commerce/service-plugins/validations-integration-service-plugin/introduction)).
901
+ * @readonly
902
+ */
903
+ violations?: Violation[];
904
+ /**
905
+ * Custom field data for the checkout object.
906
+ *
907
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
908
+ */
909
+ extendedFields?: ExtendedFields;
760
910
  /**
761
911
  * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
762
912
  * @format GUID
913
+ * @readonly
763
914
  */
764
915
  purchaseFlowId?: string | null;
765
- }
766
- interface CreateAndRedirectToCheckoutRequest {
767
916
  /**
768
- * ID of the checkout template to use to create a checkout.
769
- * @format GUID
917
+ * Additional settings for customization of the checkout process.
918
+ *
919
+ * > **Notes:**
920
+ * > * Custom settings can only be set when creating a checkout.
921
+ * > * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions". Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
922
+ * @immutable
770
923
  */
771
- checkoutTemplateId: string;
924
+ customSettings?: CustomSettings;
772
925
  /**
773
- * ID of the site associated with the checkout template.
926
+ * Reference IDs for the app and component providing custom checkout page content.
927
+ *
928
+ * To access and manage custom checkout page content, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
929
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
930
+ */
931
+ customContentReference?: CustomContentReference;
932
+ /**
933
+ * References to an external app and resource associated with this checkout.
934
+ * Used for integration and tracking across different platforms.
935
+ * @immutable
936
+ */
937
+ externalReference?: ExternalReference;
938
+ /**
939
+ * Payment for subscriptions after free trial period.
940
+ * @readonly
941
+ */
942
+ payAfterFreeTrial?: PriceSummary;
943
+ /**
944
+ * The business location ID associated with the checkout.
945
+ *
946
+ * To learn more, see the Locations API.
774
947
  * @format GUID
775
948
  */
776
- siteId: string;
949
+ businessLocationId?: string | null;
950
+ /**
951
+ * Currency used for payment, in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
952
+ * @readonly
953
+ * @format CURRENCY
954
+ */
955
+ paymentCurrency?: string;
956
+ }
957
+ interface LineItem {
958
+ /**
959
+ * Line item ID.
960
+ * @format GUID
961
+ * @readonly
962
+ */
963
+ id?: string | null;
964
+ /**
965
+ * Item quantity.
966
+ *
967
+ * Min: `"1"`
968
+ * Max: `"100000"`
969
+ * @min 1
970
+ * @max 100000
971
+ */
972
+ quantity?: number;
973
+ /** Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin. */
974
+ catalogReference?: CatalogReference;
975
+ /**
976
+ * Item name.
977
+ * + Stores - `product.name`
978
+ * + Bookings - `service.info.name`
979
+ * + Events - `ticket.name`
980
+ * @readonly
981
+ */
982
+ productName?: ProductName;
983
+ /**
984
+ * URL to the item's page on the site.
985
+ * @readonly
986
+ */
987
+ url?: PageUrlV2;
988
+ /**
989
+ * Item price **after** catalog-defined discount and line item discounts.
990
+ * @readonly
991
+ */
992
+ price?: MultiCurrencyPrice;
993
+ /**
994
+ * Total line item price **after** catalog-defined discount and line item discounts.
995
+ * @readonly
996
+ */
997
+ lineItemPrice?: MultiCurrencyPrice;
998
+ /**
999
+ * Item price **before** catalog-defined discount. Defaults to `price` when not provided.
1000
+ * @readonly
1001
+ */
1002
+ fullPrice?: MultiCurrencyPrice;
1003
+ /**
1004
+ * Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided.
1005
+ * @readonly
1006
+ */
1007
+ priceBeforeDiscounts?: MultiCurrencyPrice;
1008
+ /**
1009
+ * Total price after all discounts and tax.
1010
+ * @readonly
1011
+ */
1012
+ totalPriceAfterTax?: MultiCurrencyPrice;
1013
+ /**
1014
+ * Total price after discounts, and before tax.
1015
+ * @readonly
1016
+ */
1017
+ totalPriceBeforeTax?: MultiCurrencyPrice;
1018
+ /**
1019
+ * Tax details for this line item.
1020
+ * @readonly
1021
+ */
1022
+ taxDetails?: ItemTaxFullDetails;
1023
+ /**
1024
+ * Discount for this line item's entire quantity.
1025
+ * @readonly
1026
+ */
1027
+ discount?: MultiCurrencyPrice;
1028
+ /**
1029
+ * Line item description lines. Used for display purposes for the cart, checkout and order.
1030
+ * @readonly
1031
+ */
1032
+ descriptionLines?: DescriptionLine[];
1033
+ /**
1034
+ * Line item image details.
1035
+ * @readonly
1036
+ */
1037
+ media?: CommonImage;
1038
+ /**
1039
+ * Item availability details.
1040
+ * @readonly
1041
+ */
1042
+ availability?: ItemAvailabilityInfo;
1043
+ /**
1044
+ * Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability.
1045
+ * @readonly
1046
+ */
1047
+ physicalProperties?: PhysicalProperties;
1048
+ /**
1049
+ * Item type. Either a preset type or custom.
1050
+ * @readonly
1051
+ */
1052
+ itemType?: ItemType;
1053
+ /**
1054
+ * Subscription option information.
1055
+ * @readonly
1056
+ */
1057
+ subscriptionOptionInfo?: SubscriptionOptionInfo;
1058
+ /**
1059
+ * Type of selected payment option for current item.
1060
+ *
1061
+ * Default: `FULL_PAYMENT_ONLINE`
1062
+ * @readonly
1063
+ */
1064
+ paymentOption?: PaymentOptionTypeWithLiterals;
1065
+ /**
1066
+ * Service properties. When relevant, this contains information such as date and number of participants.
1067
+ * @readonly
1068
+ */
1069
+ serviceProperties?: ServiceProperties;
1070
+ /**
1071
+ * In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.
1072
+ * + For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.
1073
+ * + In most cases, this field has the same value as `catalogReference.catalogItemId`.
1074
+ * + Used in membership validation.
1075
+ * @minLength 1
1076
+ * @maxLength 36
1077
+ * @readonly
1078
+ */
1079
+ rootCatalogItemId?: string | null;
1080
+ /**
1081
+ * Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
1082
+ * @readonly
1083
+ */
1084
+ priceDescription?: PriceDescription;
1085
+ /**
1086
+ * Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only.
1087
+ * @readonly
1088
+ */
1089
+ depositAmount?: MultiCurrencyPrice;
1090
+ /**
1091
+ * Delivery profile ID.
1092
+ * @format GUID
1093
+ * @readonly
1094
+ */
1095
+ deliveryProfileId?: string | null;
1096
+ /**
1097
+ * Whether the line item is a custom line item. Custom line items don't trigger the Catalog service plugin.
1098
+ * @readonly
1099
+ */
1100
+ customLineItem?: boolean;
1101
+ /**
1102
+ * Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page.
1103
+ * @minLength 1
1104
+ * @maxLength 2500
1105
+ * @readonly
1106
+ */
1107
+ consentRequiredPaymentPolicy?: string | null;
1108
+ /**
1109
+ * Overriding values for catalog item properties.
1110
+ *
1111
+ * To override catalog fields, your app must have the permission scope named "Manage eCommerce - Admin Permissions".
1112
+ * Learn more about [permission scopes](https://dev.wix.com/docs/build-apps/develop-your-app/access/authorization/about-permissions).
1113
+ */
1114
+ catalogOverrideFields?: CatalogOverrideFields;
1115
+ /**
1116
+ * Whether the price is not yet defined, and will be updated after the order is created.
1117
+ * @readonly
1118
+ */
1119
+ priceUndetermined?: boolean;
1120
+ /**
1121
+ * Whether the line item quantity is fixed and cannot be changed.
1122
+ * @readonly
1123
+ */
1124
+ fixedQuantity?: boolean;
1125
+ /**
1126
+ * Whether to save the payment method on the order.
1127
+ *
1128
+ * Default: `false`
1129
+ * @readonly
1130
+ */
1131
+ savePaymentMethod?: boolean;
1132
+ /** Address to use for tax calculation purposes. */
1133
+ taxableAddress?: TaxableAddress;
1134
+ /**
1135
+ * Custom extended fields for the line item object.
1136
+ *
1137
+ * [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured using the 'Checkout & Orders - Line Items Schema Plugin' in the app dashboard before they can be accessed with API calls.
1138
+ */
1139
+ extendedFields?: ExtendedFields;
1140
+ /**
1141
+ * Policies to be displayed to the customer on the checkout page.
1142
+ * @readonly
1143
+ * @maxSize 5
1144
+ */
1145
+ policies?: Policy[];
1146
+ /**
1147
+ * Whether the item can only be purchased by site members.
1148
+ *
1149
+ * Default: `false`
1150
+ * @readonly
1151
+ */
1152
+ membersOnly?: boolean;
1153
+ /**
1154
+ * Modifier groups that were added to the item.
1155
+ * @readonly
1156
+ * @maxSize 25
1157
+ */
1158
+ modifierGroups?: ModifierGroup[];
1159
+ /**
1160
+ * Total price of all item modifiers. Included in the item price.
1161
+ * @readonly
1162
+ */
1163
+ modifiersTotalPrice?: MultiCurrencyPrice;
1164
+ }
1165
+ interface MultiCurrencyPrice {
1166
+ /**
1167
+ * Amount.
1168
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1169
+ */
1170
+ amount?: string;
1171
+ /**
1172
+ * Converted amount.
1173
+ * @readonly
1174
+ * @decimalValue options { gte:0, lte:1000000000000000 }
1175
+ */
1176
+ convertedAmount?: string;
1177
+ /**
1178
+ * Amount formatted with currency symbol.
1179
+ * @readonly
1180
+ */
1181
+ formattedAmount?: string;
1182
+ /**
1183
+ * Converted amount formatted with currency symbol.
1184
+ * @readonly
1185
+ */
1186
+ formattedConvertedAmount?: string;
1187
+ }
1188
+ interface ItemTaxFullDetails {
1189
+ /** Amount for which tax is calculated. */
1190
+ taxableAmount?: MultiCurrencyPrice;
1191
+ /**
1192
+ * Tax rate %, as a decimal point between 0 and 1.
1193
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
1194
+ */
1195
+ taxRate?: string;
1196
+ /** Calculated tax, based on `taxable_amount` and `tax_rate`. */
1197
+ totalTax?: MultiCurrencyPrice;
1198
+ /**
1199
+ * If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead.
1200
+ * @readonly
1201
+ * @deprecated
1202
+ */
1203
+ rateBreakdown?: TaxRateBreakdown[];
1204
+ }
1205
+ interface TaxRateBreakdown {
1206
+ /**
1207
+ * Name of tax against which the calculation was performed.
1208
+ * @maxLength 100
1209
+ */
1210
+ name?: string;
1211
+ /**
1212
+ * Rate at which this tax detail was calculated.
1213
+ * @decimalValue options { gte:0, lte:1, maxScale:6 }
1214
+ */
1215
+ rate?: string;
1216
+ /** Amount of tax for this tax detail. */
1217
+ tax?: MultiCurrencyPrice;
1218
+ }
1219
+ /**
1220
+ * TaxBreakdown represents tax information for a line item.
1221
+ * It holds the tax amount and the tax rate for each tax authority that apply on the line item.
1222
+ */
1223
+ interface TaxBreakdown {
1224
+ /**
1225
+ * The name of the jurisdiction to which this tax detail applies. For example, "New York" or "Quebec".
1226
+ * @maxLength 200
1227
+ */
1228
+ jurisdiction?: string | null;
1229
+ /** The amount of this line item price that was considered nontaxable. (Decimal value) */
1230
+ nonTaxableAmount?: MultiCurrencyPrice;
1231
+ /**
1232
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)
1233
+ * @decimalValue options { gte:0, maxScale:6 }
1234
+ */
1235
+ rate?: string | null;
1236
+ /** The amount of tax estimated for this line item. (Decimal value) */
1237
+ taxAmount?: MultiCurrencyPrice;
1238
+ /** The taxable amount of this line item. */
1239
+ taxableAmount?: MultiCurrencyPrice;
1240
+ /**
1241
+ * The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
1242
+ * @maxLength 200
1243
+ */
1244
+ taxType?: string | null;
1245
+ /**
1246
+ * The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
1247
+ * This name should be explicit enough to allow the merchant to understand what tax was calculated.
1248
+ * @maxLength 200
1249
+ */
1250
+ taxName?: string | null;
1251
+ /** The type of the jurisdiction in which this tax detail applies. */
1252
+ jurisdictionType?: JurisdictionTypeWithLiterals;
1253
+ }
1254
+ /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
1255
+ declare enum JurisdictionType {
1256
+ UNDEFINED = "UNDEFINED",
1257
+ COUNTRY = "COUNTRY",
1258
+ STATE = "STATE",
1259
+ COUNTY = "COUNTY",
1260
+ CITY = "CITY",
1261
+ SPECIAL = "SPECIAL"
1262
+ }
1263
+ /** @enumType */
1264
+ type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
1265
+ interface CommonImage {
1266
+ /** WixMedia image ID. */
1267
+ id?: string;
1268
+ /** Image URL. */
1269
+ url?: string;
1270
+ /**
1271
+ * Original image height.
1272
+ * @readonly
1273
+ */
1274
+ height?: number;
1275
+ /**
1276
+ * Original image width.
1277
+ * @readonly
1278
+ */
1279
+ width?: number;
1280
+ /** Image alt text. */
1281
+ altText?: string | null;
1282
+ /**
1283
+ * Image filename.
1284
+ * @readonly
1285
+ */
1286
+ filename?: string | null;
1287
+ }
1288
+ interface FocalPoint {
1289
+ /** X-coordinate of the focal point. */
1290
+ x?: number;
1291
+ /** Y-coordinate of the focal point. */
1292
+ y?: number;
1293
+ /** crop by height */
1294
+ height?: number | null;
1295
+ /** crop by width */
1296
+ width?: number | null;
1297
+ }
1298
+ interface ItemAvailabilityInfo {
1299
+ /** Item availability status. */
1300
+ status?: ItemAvailabilityStatusWithLiterals;
1301
+ /** Quantity available. */
1302
+ quantityAvailable?: number | null;
1303
+ }
1304
+ declare enum ItemAvailabilityStatus {
1305
+ AVAILABLE = "AVAILABLE",
1306
+ /** Item does not exist. */
1307
+ NOT_FOUND = "NOT_FOUND",
1308
+ /** Item is not in stock. */
1309
+ NOT_AVAILABLE = "NOT_AVAILABLE",
1310
+ /** Available quantity is less than requested. */
1311
+ PARTIALLY_AVAILABLE = "PARTIALLY_AVAILABLE"
1312
+ }
1313
+ /** @enumType */
1314
+ type ItemAvailabilityStatusWithLiterals = ItemAvailabilityStatus | 'AVAILABLE' | 'NOT_FOUND' | 'NOT_AVAILABLE' | 'PARTIALLY_AVAILABLE';
1315
+ interface Scope {
1316
+ /** Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans) */
1317
+ namespace?: string;
1318
+ /** Coupon scope's applied group (e.g., event or ticket in Wix Events) */
1319
+ group?: Group;
1320
+ }
1321
+ interface Group {
1322
+ /** Coupon scope's group (e.g., product or collection in Wix Stores). See [valid scope values](https://dev.wix.com/api/rest/coupons/coupons/valid-scope-values). */
1323
+ name?: string;
1324
+ /** Item ID (when the coupon scope is limited to just one item). */
1325
+ entityId?: string | null;
1326
+ }
1327
+ interface ModifierGroup {
1328
+ /**
1329
+ * Modifier group ID.
1330
+ * @minLength 1
1331
+ * @maxLength 36
1332
+ */
1333
+ id?: string;
1334
+ /** Modifier group name. */
1335
+ name?: TranslatableString;
1336
+ /**
1337
+ * List of modifiers in this group.
1338
+ * @minSize 1
1339
+ * @maxSize 25
1340
+ */
1341
+ modifiers?: ItemModifier[];
1342
+ }
1343
+ interface ItemModifier {
1344
+ /**
1345
+ * Modifier ID.
1346
+ * @minLength 1
1347
+ * @maxLength 36
1348
+ */
1349
+ id?: string;
1350
+ /**
1351
+ * The quantity of this modifier.
1352
+ * @min 1
1353
+ * @max 100000
1354
+ */
1355
+ quantity?: number | null;
1356
+ /** Primary display label for the modifier. */
1357
+ label?: TranslatableString;
1358
+ /** Additional details. */
1359
+ details?: TranslatableString;
1360
+ /** The price of the modifier. */
1361
+ price?: MultiCurrencyPrice;
1362
+ }
1363
+ /** Billing Info and shipping details */
1364
+ interface AddressWithContact {
1365
+ /** Address. */
1366
+ address?: Address;
1367
+ /** Contact details. */
1368
+ contactDetails?: FullAddressContactDetails;
1369
+ }
1370
+ /** Physical address */
1371
+ interface Address {
1372
+ /**
1373
+ * Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
1374
+ * @format COUNTRY
1375
+ */
1376
+ country?: string | null;
1377
+ /**
1378
+ * Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
1379
+ * @maxLength 50
1380
+ */
1381
+ subdivision?: string | null;
1382
+ /**
1383
+ * City name.
1384
+ * @maxLength 50
1385
+ */
1386
+ city?: string | null;
1387
+ /**
1388
+ * Postal or zip code.
1389
+ * @maxLength 50
1390
+ */
1391
+ postalCode?: string | null;
1392
+ /** Street address. */
1393
+ streetAddress?: StreetAddress;
1394
+ /**
1395
+ * Main address line (usually street name and number).
1396
+ * @maxLength 150
1397
+ */
1398
+ addressLine?: string | null;
1399
+ /**
1400
+ * Free text providing more detailed address info. Usually contains apt, suite, floor.
1401
+ * @maxLength 100
1402
+ */
1403
+ addressLine2?: string | null;
1404
+ /** Geocode object containing latitude and longitude coordinates. */
1405
+ geocode?: AddressLocation;
1406
+ /**
1407
+ * Country's full name.
1408
+ * @readonly
1409
+ */
1410
+ countryFullname?: string | null;
1411
+ /**
1412
+ * Subdivision full-name.
1413
+ * @readonly
1414
+ */
1415
+ subdivisionFullname?: string | null;
1416
+ }
1417
+ interface StreetAddress {
1418
+ /** Street number. */
1419
+ number?: string;
1420
+ /** Street name. */
1421
+ name?: string;
1422
+ }
1423
+ interface AddressLocation {
1424
+ /** Address latitude. */
1425
+ latitude?: number | null;
1426
+ /** Address longitude. */
1427
+ longitude?: number | null;
1428
+ }
1429
+ /** Full contact details for an address */
1430
+ interface FullAddressContactDetails {
1431
+ /**
1432
+ * First name.
1433
+ * @maxLength 100
1434
+ */
1435
+ firstName?: string | null;
1436
+ /**
1437
+ * Last name.
1438
+ * @maxLength 100
1439
+ */
1440
+ lastName?: string | null;
1441
+ /**
1442
+ * Phone number.
1443
+ * @format PHONE
1444
+ */
1445
+ phone?: string | null;
1446
+ /**
1447
+ * Company name.
1448
+ * @maxLength 1000
1449
+ */
1450
+ company?: string | null;
1451
+ /** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
1452
+ vatId?: VatId;
1453
+ }
1454
+ interface VatId {
1455
+ /** Customer's tax ID. */
1456
+ id?: string;
1457
+ /**
1458
+ * Tax type.
1459
+ *
1460
+ * Supported values:
1461
+ * + `CPF`: for individual tax payers
1462
+ * + `CNPJ`: for corporations
1463
+ */
1464
+ type?: VatTypeWithLiterals;
1465
+ }
1466
+ /** tax info types */
1467
+ declare enum VatType {
1468
+ UNSPECIFIED = "UNSPECIFIED",
1469
+ /** CPF - for individual tax payers. */
1470
+ CPF = "CPF",
1471
+ /** CNPJ - for corporations */
1472
+ CNPJ = "CNPJ"
1473
+ }
1474
+ /** @enumType */
1475
+ type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
1476
+ interface ShippingInfo {
1477
+ /** Shipping address and contact details. */
1478
+ shippingDestination?: AddressWithContact;
1479
+ /** Selected option out of the options allowed for the `region`. */
1480
+ selectedCarrierServiceOption?: SelectedCarrierServiceOption;
1481
+ /**
1482
+ * Shipping region. Based on the address provided.
1483
+ * @readonly
1484
+ */
1485
+ region?: ShippingRegion;
1486
+ /**
1487
+ * All carrier options for this shipping rule.
1488
+ * @readonly
1489
+ */
1490
+ carrierServiceOptions?: CarrierServiceOption[];
1491
+ }
1492
+ interface SelectedCarrierServiceOption {
1493
+ /**
1494
+ * Unique identifier of selected option. For example, "usps_std_overnight".
1495
+ * @maxLength 100
1496
+ */
1497
+ code?: string;
1498
+ /**
1499
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
1500
+ * For example, "Standard" or "First-Class Package International".
1501
+ * @maxLength 250
1502
+ * @readonly
1503
+ */
1504
+ title?: string;
1505
+ /**
1506
+ * Delivery logistics.
1507
+ * @readonly
1508
+ */
1509
+ logistics?: DeliveryLogistics;
1510
+ /**
1511
+ * Shipping costs.
1512
+ * @readonly
1513
+ */
1514
+ cost?: SelectedCarrierServiceOptionPrices;
1515
+ /**
1516
+ * Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)
1517
+ * @readonly
1518
+ */
1519
+ requestedShippingOption?: boolean;
1520
+ /**
1521
+ * Other charges
1522
+ * @deprecated Other charges
1523
+ * @replacedBy additional_fees
1524
+ * @targetRemovalDate 2025-10-01
1525
+ */
1526
+ otherCharges?: SelectedCarrierServiceOptionOtherCharge[];
1527
+ /**
1528
+ * This carrier's unique ID
1529
+ * @format GUID
1530
+ */
1531
+ carrierId?: string | null;
1532
+ /**
1533
+ * Delivery solution allocations to different delivery carriers and delivery regions
1534
+ * @maxSize 300
1535
+ */
1536
+ deliveryAllocations?: DeliveryAllocation[];
1537
+ /** If the delivery solution is a partial and doesn't apply to all items. */
1538
+ partial?: boolean | null;
1539
+ }
1540
+ interface DeliveryLogistics {
1541
+ /**
1542
+ * Expected delivery time, in free text. For example, "3-5 business days".
1543
+ * @maxLength 500
1544
+ */
1545
+ deliveryTime?: string | null;
1546
+ /**
1547
+ * Instructions for caller, e.g for pickup: "Please deliver during opening hours, and please don't park in disabled parking spot".
1548
+ * @maxLength 1000
1549
+ */
1550
+ instructions?: string | null;
1551
+ /** Pickup details. */
1552
+ pickupDetails?: PickupDetails;
1553
+ }
1554
+ interface PickupDetails {
1555
+ /** Pickup address. */
1556
+ address?: Address;
1557
+ /**
1558
+ * Whether the pickup address is that of a business - this may effect tax calculation.
1559
+ * @deprecated
1560
+ */
1561
+ businessLocation?: boolean;
1562
+ /** Pickup method */
1563
+ pickupMethod?: PickupMethodWithLiterals;
1564
+ }
1565
+ declare enum PickupMethod {
1566
+ UNKNOWN_METHOD = "UNKNOWN_METHOD",
1567
+ STORE_PICKUP = "STORE_PICKUP",
1568
+ PICKUP_POINT = "PICKUP_POINT"
1569
+ }
1570
+ /** @enumType */
1571
+ type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
1572
+ interface DeliveryTimeSlot {
1573
+ /** starting time of the delivery time slot */
1574
+ from?: Date | null;
1575
+ /** ending time of the delivery time slot */
1576
+ to?: Date | null;
1577
+ }
1578
+ interface SelectedCarrierServiceOptionPrices {
1579
+ /** Total shipping price, after discount and after tax. */
1580
+ totalPriceAfterTax?: MultiCurrencyPrice;
1581
+ /** Total price of shipping after discounts (when relevant), and before tax. */
1582
+ totalPriceBeforeTax?: MultiCurrencyPrice;
1583
+ /** Tax details. */
1584
+ taxDetails?: ItemTaxFullDetails;
1585
+ /** Shipping discount before tax. */
1586
+ totalDiscount?: MultiCurrencyPrice;
1587
+ /** Shipping price before discount and before tax. */
1588
+ price?: MultiCurrencyPrice;
1589
+ }
1590
+ interface SelectedCarrierServiceOptionOtherCharge {
1591
+ /** Type of additional cost. */
1592
+ type?: ChargeTypeWithLiterals;
1593
+ /**
1594
+ * Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'.
1595
+ * @maxLength 200
1596
+ */
1597
+ details?: string | null;
1598
+ /** Price of added charge. */
1599
+ cost?: SelectedCarrierServiceOptionPrices;
1600
+ }
1601
+ declare enum ChargeType {
1602
+ HANDLING_FEE = "HANDLING_FEE",
1603
+ INSURANCE = "INSURANCE"
1604
+ }
1605
+ /** @enumType */
1606
+ type ChargeTypeWithLiterals = ChargeType | 'HANDLING_FEE' | 'INSURANCE';
1607
+ interface DeliveryAllocation {
1608
+ /** The delivery option's carrier details, could be multiple if the delivery option is a combination of multiple carriers */
1609
+ deliveryCarrier?: Carrier;
1610
+ /** The delivery region that are relevant for this delivery solution. */
1611
+ deliveryRegion?: Region;
1612
+ /** Populated if the delivery solution is a partially supplied by this carrier. */
1613
+ applicableLineItems?: ApplicableLineItems;
1614
+ }
1615
+ interface Carrier {
1616
+ /**
1617
+ * The carrier app id
1618
+ * @format GUID
1619
+ */
1620
+ appId?: string | null;
1621
+ /**
1622
+ * Unique code that acts as an ID for a shipping rate. For example, `"usps_std_overnight"`.
1623
+ * @maxLength 250
1624
+ */
1625
+ code?: string;
1626
+ }
1627
+ interface Region {
1628
+ /**
1629
+ * The delivery region id.
1630
+ * @format GUID
1631
+ */
1632
+ id?: string | null;
1633
+ /**
1634
+ * The delivery region name.
1635
+ * @maxLength 100
1636
+ */
1637
+ name?: string | null;
1638
+ }
1639
+ interface ApplicableLineItems {
1640
+ /**
1641
+ * Line items that the delivery solution is for.
1642
+ * @maxSize 300
1643
+ * @minLength 1
1644
+ * @maxLength 100
1645
+ */
1646
+ lineItemIds?: string[];
1647
+ }
1648
+ interface ShippingRegion {
1649
+ /**
1650
+ * Shipping region ID.
1651
+ * @format GUID
1652
+ * @readonly
1653
+ */
1654
+ id?: string;
1655
+ /**
1656
+ * Shipping region name.
1657
+ * @maxLength 100
1658
+ */
1659
+ name?: string;
1660
+ }
1661
+ interface CarrierServiceOption {
1662
+ /**
1663
+ * Carrier ID.
1664
+ * @format GUID
1665
+ */
1666
+ carrierId?: string;
1667
+ /** Shipping options offered by this carrier for this request. */
1668
+ shippingOptions?: ShippingOption[];
1669
+ }
1670
+ interface ShippingOption {
1671
+ /**
1672
+ * Unique code of provided shipping option like "usps_std_overnight".
1673
+ * For legacy calculators this would be the UUID of the option.
1674
+ * @maxLength 100
1675
+ */
1676
+ code?: string;
1677
+ /**
1678
+ * Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).
1679
+ * For example, "Standard" or "First-Class Package International".
1680
+ * @maxLength 250
1681
+ */
1682
+ title?: string;
1683
+ /** Delivery logistics. */
1684
+ logistics?: DeliveryLogistics;
1685
+ /** Sipping price information. */
1686
+ cost?: ShippingPrice;
1687
+ /**
1688
+ * Delivery solution allocations to different delivery carriers and delivery regions
1689
+ * @maxSize 300
1690
+ */
1691
+ deliveryAllocations?: DeliveryAllocation[];
1692
+ /** If the delivery solution is a partial and doesn't apply to all items. */
1693
+ partial?: boolean | null;
1694
+ }
1695
+ interface ShippingPrice {
1696
+ /** Shipping price. */
1697
+ price?: MultiCurrencyPrice;
1698
+ /** Other costs such as insurance, handling & packaging for fragile items, etc. */
1699
+ otherCharges?: OtherCharge[];
1700
+ }
1701
+ interface OtherCharge {
1702
+ /** Type of additional cost. */
1703
+ type?: ChargeTypeWithLiterals;
1704
+ /** Price of added cost. */
1705
+ price?: MultiCurrencyPrice;
1706
+ /**
1707
+ * Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`.
1708
+ * @maxLength 250
1709
+ */
1710
+ details?: string | null;
1711
+ }
1712
+ interface BuyerInfo extends BuyerInfoIdOneOf {
1713
+ /**
1714
+ * Visitor ID (if site visitor is **not** a member).
1715
+ * @format GUID
1716
+ * @readonly
1717
+ */
1718
+ visitorId?: string;
1719
+ /**
1720
+ * Member ID (if site visitor is a site member).
1721
+ * @format GUID
1722
+ * @readonly
1723
+ */
1724
+ memberId?: string;
1725
+ /**
1726
+ * Contact ID. Auto-created if one does not yet exist. For more information, see the Contacts API.
1727
+ * @format GUID
1728
+ * @readonly
1729
+ */
1730
+ contactId?: string | null;
1731
+ /**
1732
+ * Buyer email address.
1733
+ * @format EMAIL
1734
+ */
1735
+ email?: string | null;
1736
+ }
1737
+ /** @oneof */
1738
+ interface BuyerInfoIdOneOf {
1739
+ /**
1740
+ * Visitor ID (if site visitor is **not** a member).
1741
+ * @format GUID
1742
+ * @readonly
1743
+ */
1744
+ visitorId?: string;
1745
+ /**
1746
+ * Member ID (if site visitor is a site member).
1747
+ * @format GUID
1748
+ * @readonly
1749
+ */
1750
+ memberId?: string;
1751
+ }
1752
+ interface PriceSummary {
1753
+ /** Subtotal of all line items, before discounts and before tax. */
1754
+ subtotal?: MultiCurrencyPrice;
1755
+ /** Total shipping price, before discounts and before tax. */
1756
+ shipping?: MultiCurrencyPrice;
1757
+ /** Total tax. */
1758
+ tax?: MultiCurrencyPrice;
1759
+ /** Total calculated discount value. */
1760
+ discount?: MultiCurrencyPrice;
1761
+ /** Total price after discounts, gift cards, and tax. */
1762
+ total?: MultiCurrencyPrice;
1763
+ /** Total additional fees price before tax. */
1764
+ additionalFees?: MultiCurrencyPrice;
1765
+ }
1766
+ interface CalculationErrors extends CalculationErrorsShippingCalculationErrorOneOf {
1767
+ /** General shipping calculation error. */
1768
+ generalShippingCalculationError?: Details;
1769
+ /** Carrier errors. */
1770
+ carrierErrors?: CarrierErrors;
1771
+ /** Tax calculation error. */
1772
+ taxCalculationError?: Details;
1773
+ /** Coupon calculation error. */
1774
+ couponCalculationError?: Details;
1775
+ /** Gift card calculation error. */
1776
+ giftCardCalculationError?: Details;
1777
+ /** Order validation errors. */
1778
+ orderValidationErrors?: ApplicationError[];
1779
+ /**
1780
+ * Membership payment methods calculation errors
1781
+ * For example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid
1782
+ */
1783
+ membershipError?: Details;
1784
+ /** Discount Rule calculation error. */
1785
+ discountsCalculationError?: Details;
1786
+ }
1787
+ /** @oneof */
1788
+ interface CalculationErrorsShippingCalculationErrorOneOf {
1789
+ /** General shipping calculation error. */
1790
+ generalShippingCalculationError?: Details;
1791
+ /** Carrier errors. */
1792
+ carrierErrors?: CarrierErrors;
1793
+ }
1794
+ interface Details extends DetailsKindOneOf {
1795
+ applicationError?: ApplicationError;
1796
+ validationError?: ValidationError;
1797
+ systemError?: SystemError;
1798
+ /**
1799
+ * deprecated in API's - to enable migration from rendering arbitrary tracing to rest response
1800
+ * @deprecated
1801
+ */
1802
+ tracing?: Record<string, string>;
1803
+ }
1804
+ /** @oneof */
1805
+ interface DetailsKindOneOf {
1806
+ applicationError?: ApplicationError;
1807
+ validationError?: ValidationError;
1808
+ systemError?: SystemError;
1809
+ }
1810
+ interface ApplicationError {
1811
+ /** Error code. */
1812
+ code?: string;
1813
+ /** Description of the error. */
1814
+ description?: string;
1815
+ /** Data related to the error. */
1816
+ data?: Record<string, any> | null;
1817
+ }
1818
+ /**
1819
+ * example result:
1820
+ * {
1821
+ * "fieldViolations": [
1822
+ * {
1823
+ * "field": "fieldA",
1824
+ * "description": "invalid music note. supported notes: [do,re,mi,fa,sol,la,ti]",
1825
+ * "violatedRule": "OTHER",
1826
+ * "ruleName": "INVALID_NOTE",
1827
+ * "data": {
1828
+ * "value": "FI"
1829
+ * }
1830
+ * },
1831
+ * {
1832
+ * "field": "fieldB",
1833
+ * "description": "field value out of range. supported range: [0-20]",
1834
+ * "violatedRule": "MAX",
1835
+ * "data": {
1836
+ * "threshold": 20
1837
+ * }
1838
+ * },
1839
+ * {
1840
+ * "field": "fieldC",
1841
+ * "description": "invalid phone number. provide a valid phone number of size: [7-12], supported characters: [0-9, +, -, (, )]",
1842
+ * "violatedRule": "FORMAT",
1843
+ * "data": {
1844
+ * "type": "PHONE"
1845
+ * }
1846
+ * }
1847
+ * ]
1848
+ * }
1849
+ */
1850
+ interface ValidationError {
1851
+ fieldViolations?: FieldViolation[];
1852
+ }
1853
+ declare enum RuleType {
1854
+ VALIDATION = "VALIDATION",
1855
+ OTHER = "OTHER",
1856
+ MAX = "MAX",
1857
+ MIN = "MIN",
1858
+ MAX_LENGTH = "MAX_LENGTH",
1859
+ MIN_LENGTH = "MIN_LENGTH",
1860
+ MAX_SIZE = "MAX_SIZE",
1861
+ MIN_SIZE = "MIN_SIZE",
1862
+ FORMAT = "FORMAT",
1863
+ DECIMAL_LTE = "DECIMAL_LTE",
1864
+ DECIMAL_GTE = "DECIMAL_GTE",
1865
+ DECIMAL_LT = "DECIMAL_LT",
1866
+ DECIMAL_GT = "DECIMAL_GT",
1867
+ DECIMAL_MAX_SCALE = "DECIMAL_MAX_SCALE",
1868
+ INVALID_ENUM_VALUE = "INVALID_ENUM_VALUE",
1869
+ REQUIRED_FIELD = "REQUIRED_FIELD",
1870
+ FIELD_NOT_ALLOWED = "FIELD_NOT_ALLOWED",
1871
+ ONE_OF_ALIGNMENT = "ONE_OF_ALIGNMENT",
1872
+ EXACT_LENGTH = "EXACT_LENGTH",
1873
+ EXACT_SIZE = "EXACT_SIZE",
1874
+ REQUIRED_ONE_OF_FIELD = "REQUIRED_ONE_OF_FIELD"
1875
+ }
1876
+ /** @enumType */
1877
+ type RuleTypeWithLiterals = RuleType | 'VALIDATION' | 'OTHER' | 'MAX' | 'MIN' | 'MAX_LENGTH' | 'MIN_LENGTH' | 'MAX_SIZE' | 'MIN_SIZE' | 'FORMAT' | 'DECIMAL_LTE' | 'DECIMAL_GTE' | 'DECIMAL_LT' | 'DECIMAL_GT' | 'DECIMAL_MAX_SCALE' | 'INVALID_ENUM_VALUE' | 'REQUIRED_FIELD' | 'FIELD_NOT_ALLOWED' | 'ONE_OF_ALIGNMENT' | 'EXACT_LENGTH' | 'EXACT_SIZE' | 'REQUIRED_ONE_OF_FIELD';
1878
+ interface FieldViolation {
1879
+ field?: string;
1880
+ description?: string;
1881
+ violatedRule?: RuleTypeWithLiterals;
1882
+ /** applicable when violated_rule=OTHER */
1883
+ ruleName?: string | null;
1884
+ data?: Record<string, any> | null;
1885
+ }
1886
+ interface SystemError {
1887
+ /** Error code. */
1888
+ errorCode?: string | null;
1889
+ }
1890
+ interface CarrierErrors {
1891
+ /** Carrier errors. */
1892
+ errors?: CarrierError[];
1893
+ }
1894
+ interface CarrierError {
1895
+ /** Carrier ID. */
1896
+ carrierId?: string;
1897
+ /** Error details. */
1898
+ error?: Details;
1899
+ }
1900
+ interface GiftCard {
1901
+ /**
1902
+ * Gift Card ID.
1903
+ * @deprecated
1904
+ */
1905
+ id?: string;
1906
+ /** Gift card obfuscated code. */
1907
+ obfuscatedCode?: string;
1908
+ /** Actual amount to be redeemed from the gift card. */
1909
+ amount?: MultiCurrencyPrice;
1910
+ /**
1911
+ * App ID of the gift card provider.
1912
+ * @format GUID
1913
+ */
1914
+ appId?: string;
1915
+ /**
1916
+ * External ID in the gift card provider's system.
1917
+ * Used for integration and tracking across different platforms.
1918
+ * @minLength 1
1919
+ * @maxLength 50
1920
+ */
1921
+ externalId?: string | null;
1922
+ /** Requested amount to redeem from the gift card. */
1923
+ requestedAmount?: MultiCurrencyPrice;
1924
+ }
1925
+ interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1926
+ /** Coupon details. */
1927
+ coupon?: Coupon;
1928
+ /** Merchant discount. */
1929
+ merchantDiscount?: MerchantDiscount;
1930
+ /** Discount rule */
1931
+ discountRule?: DiscountRule;
1932
+ /** Discount type. */
1933
+ discountType?: DiscountTypeWithLiterals;
1934
+ /**
1935
+ * IDs of line items the discount applies to.
1936
+ * @format GUID
1937
+ * @deprecated IDs of line items the discount applies to.
1938
+ * @replacedBy line_items_discounts
1939
+ * @targetRemovalDate 2025-12-31
1940
+ */
1941
+ lineItemIds?: string[];
1942
+ }
1943
+ /** @oneof */
1944
+ interface AppliedDiscountDiscountSourceOneOf {
1945
+ /** Coupon details. */
1946
+ coupon?: Coupon;
1947
+ /** Merchant discount. */
1948
+ merchantDiscount?: MerchantDiscount;
1949
+ /** Discount rule */
1950
+ discountRule?: DiscountRule;
1951
+ }
1952
+ declare enum DiscountType {
1953
+ GLOBAL = "GLOBAL",
1954
+ SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
1955
+ SHIPPING = "SHIPPING"
1956
+ }
1957
+ /** @enumType */
1958
+ type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
1959
+ /** Coupon */
1960
+ interface Coupon {
1961
+ /** Coupon ID. */
1962
+ id?: string;
1963
+ /** Coupon code. */
1964
+ code?: string;
1965
+ /** Coupon value. */
1966
+ amount?: MultiCurrencyPrice;
1967
+ /** Coupon name. */
1968
+ name?: string;
1969
+ }
1970
+ interface MerchantDiscount {
1971
+ /** Discount value. */
1972
+ amount?: MultiCurrencyPrice;
1973
+ /**
1974
+ * Discount Percentage. Will be calculated from items price before other discounts.
1975
+ * @min 1
1976
+ * @max 100
1977
+ */
1978
+ percentage?: number | null;
1979
+ }
1980
+ interface DiscountRule {
1981
+ /**
1982
+ * Discount rule ID
1983
+ * @format GUID
1984
+ */
1985
+ id?: string;
1986
+ /** Discount rule name */
1987
+ name?: DiscountRuleName;
1988
+ /** Discount value. */
1989
+ amount?: MultiCurrencyPrice;
1990
+ }
1991
+ interface DiscountRuleName {
1992
+ /**
1993
+ * Original discount rule name (in site's default language).
1994
+ * @minLength 1
1995
+ * @maxLength 256
1996
+ */
1997
+ original?: string;
1998
+ /**
1999
+ * Translated discount rule name according to buyer language. Defaults to `original` when not provided.
2000
+ * @minLength 1
2001
+ * @maxLength 500
2002
+ */
2003
+ translated?: string | null;
2004
+ }
2005
+ interface LineItemDiscount {
2006
+ /**
2007
+ * ID of line item the discount applies to.
2008
+ * @format GUID
2009
+ */
2010
+ id?: string;
2011
+ /** Discount value. */
2012
+ totalDiscountAmount?: MultiCurrencyPrice;
2013
+ }
2014
+ interface CustomField {
2015
+ /** Custom field value. */
2016
+ value?: any;
2017
+ /**
2018
+ * Custom field title.
2019
+ * @minLength 1
2020
+ * @maxLength 500
2021
+ */
2022
+ title?: string;
2023
+ /**
2024
+ * Translated custom field title.
2025
+ * @minLength 1
2026
+ * @maxLength 500
2027
+ */
2028
+ translatedTitle?: string | null;
2029
+ }
2030
+ declare enum WeightUnit {
2031
+ /** Weight unit can't be classified due to an error. */
2032
+ UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
2033
+ /** Kilograms. */
2034
+ KG = "KG",
2035
+ /** Pounds. */
2036
+ LB = "LB"
2037
+ }
2038
+ /** @enumType */
2039
+ type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
2040
+ interface TaxSummary {
2041
+ /**
2042
+ * Amount for which tax is calculated, added from line items.
2043
+ * @readonly
2044
+ */
2045
+ taxableAmount?: MultiCurrencyPrice;
2046
+ /**
2047
+ * Calculated tax, added from line items.
2048
+ * @readonly
2049
+ */
2050
+ totalTax?: MultiCurrencyPrice;
2051
+ /**
2052
+ * Tax calculator that was active when the order was created.
2053
+ * @deprecated
2054
+ */
2055
+ calculationDetails?: TaxCalculationDetails;
2056
+ }
2057
+ interface TaxCalculationDetails extends TaxCalculationDetailsCalculationDetailsOneOf {
2058
+ /** Reason the manual calculation was used. */
2059
+ manualRateReason?: ManualCalculationReasonWithLiterals;
2060
+ /** Details of the fallback rate calculation. */
2061
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
2062
+ /** Rate calculation type. */
2063
+ rateType?: RateTypeWithLiterals;
2064
+ }
2065
+ /** @oneof */
2066
+ interface TaxCalculationDetailsCalculationDetailsOneOf {
2067
+ /** Reason the manual calculation was used. */
2068
+ manualRateReason?: ManualCalculationReasonWithLiterals;
2069
+ /** Details of the fallback rate calculation. */
2070
+ autoTaxFallbackDetails?: AutoTaxFallbackCalculationDetails;
2071
+ }
2072
+ declare enum RateType {
2073
+ /** no tax being collected for this request due to location of purchase */
2074
+ NO_TAX_COLLECTED = "NO_TAX_COLLECTED",
2075
+ /** manual rate used for calculation */
2076
+ MANUAL_RATE = "MANUAL_RATE",
2077
+ /** autotax rate used for calculation */
2078
+ AUTO_RATE = "AUTO_RATE",
2079
+ /** fallback rate used for calculation */
2080
+ FALLBACK_RATE = "FALLBACK_RATE"
2081
+ }
2082
+ /** @enumType */
2083
+ type RateTypeWithLiterals = RateType | 'NO_TAX_COLLECTED' | 'MANUAL_RATE' | 'AUTO_RATE' | 'FALLBACK_RATE';
2084
+ declare enum ManualCalculationReason {
2085
+ /** user set calculator in Business Manager to be Manual */
2086
+ GLOBAL_SETTING_TO_MANUAL = "GLOBAL_SETTING_TO_MANUAL",
2087
+ /** specific region is on manual even though Global setting is Auto-tax */
2088
+ REGION_SETTING_TO_MANUAL = "REGION_SETTING_TO_MANUAL"
2089
+ }
2090
+ /** @enumType */
2091
+ type ManualCalculationReasonWithLiterals = ManualCalculationReason | 'GLOBAL_SETTING_TO_MANUAL' | 'REGION_SETTING_TO_MANUAL';
2092
+ interface AutoTaxFallbackCalculationDetails {
2093
+ /** reason for fallback */
2094
+ fallbackReason?: FallbackReasonWithLiterals;
2095
+ /** invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here */
2096
+ error?: ApplicationError;
2097
+ }
2098
+ declare enum FallbackReason {
2099
+ /** auto-tax failed to be calculated */
2100
+ AUTO_TAX_FAILED = "AUTO_TAX_FAILED",
2101
+ /** auto-tax was temporarily deactivated on a system-level */
2102
+ AUTO_TAX_DEACTIVATED = "AUTO_TAX_DEACTIVATED"
2103
+ }
2104
+ /** @enumType */
2105
+ type FallbackReasonWithLiterals = FallbackReason | 'AUTO_TAX_FAILED' | 'AUTO_TAX_DEACTIVATED';
2106
+ /**
2107
+ * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
2108
+ * Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
2109
+ */
2110
+ interface AggregatedTaxBreakdown {
2111
+ /**
2112
+ * The name of the tax against which this tax amount was calculated.
2113
+ * @maxLength 200
2114
+ */
2115
+ taxName?: string;
2116
+ /**
2117
+ * The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
2118
+ * @maxLength 200
2119
+ */
2120
+ taxType?: string;
2121
+ /**
2122
+ * The name of the jurisdiction in which this tax detail applies.
2123
+ * @maxLength 200
2124
+ */
2125
+ jurisdiction?: string;
2126
+ /** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
2127
+ jurisdictionTypeEnum?: JurisdictionTypeWithLiterals;
2128
+ /**
2129
+ * The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)
2130
+ * @decimalValue options { gte:0, maxScale:6 }
2131
+ */
2132
+ rate?: string;
2133
+ /** The sum of all the tax from line items that calculated by the tax identifiers. */
2134
+ aggregatedTaxAmount?: MultiCurrencyPrice;
2135
+ /** The sum of all the taxable amount from line items for tax identifiers. */
2136
+ aggregatedTaxableAmount?: MultiCurrencyPrice;
2137
+ }
2138
+ declare enum ChannelType {
2139
+ /** Unspecified sales channel. This value is not supported. */
2140
+ UNSPECIFIED = "UNSPECIFIED",
2141
+ /** A web client. */
2142
+ WEB = "WEB",
2143
+ /** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
2144
+ POS = "POS",
2145
+ /** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
2146
+ EBAY = "EBAY",
2147
+ /** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
2148
+ AMAZON = "AMAZON",
2149
+ /** Other sales platform. */
2150
+ OTHER_PLATFORM = "OTHER_PLATFORM",
2151
+ /** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
2152
+ WIX_APP_STORE = "WIX_APP_STORE",
2153
+ /** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
2154
+ WIX_INVOICES = "WIX_INVOICES",
2155
+ /** Wix merchant backoffice. */
2156
+ BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
2157
+ /** Wish sales channel. */
2158
+ WISH = "WISH",
2159
+ /** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
2160
+ CLASS_PASS = "CLASS_PASS",
2161
+ /** Global-E sales channel. */
2162
+ GLOBAL_E = "GLOBAL_E",
2163
+ /** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
2164
+ FACEBOOK = "FACEBOOK",
2165
+ /** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
2166
+ ETSY = "ETSY",
2167
+ /** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
2168
+ TIKTOK = "TIKTOK",
2169
+ /** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
2170
+ FAIRE_COM = "FAIRE_COM",
2171
+ /** PayPal Agentic Checkout sales channel. */
2172
+ PAYPAL_AGENTIC_CHECKOUT = "PAYPAL_AGENTIC_CHECKOUT"
2173
+ }
2174
+ /** @enumType */
2175
+ type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM' | 'PAYPAL_AGENTIC_CHECKOUT';
2176
+ interface CreatedBy extends CreatedByIdOneOf {
2177
+ /**
2178
+ * User ID. When the order was created by a Wix user on behalf of a buyer.
2179
+ * For example, via POS (point of service).
2180
+ * @format GUID
2181
+ */
2182
+ userId?: string;
2183
+ /**
2184
+ * Member ID. When the order was created by a **logged in** site visitor.
2185
+ * @format GUID
2186
+ */
2187
+ memberId?: string;
2188
+ /**
2189
+ * Visitor ID. When the order was created by a site visitor that was **not** logged in.
2190
+ * @format GUID
2191
+ */
2192
+ visitorId?: string;
2193
+ /**
2194
+ * App ID. When the order was created by an external application or Wix service.
2195
+ * @format GUID
2196
+ */
2197
+ appId?: string;
2198
+ }
2199
+ /** @oneof */
2200
+ interface CreatedByIdOneOf {
2201
+ /**
2202
+ * User ID. When the order was created by a Wix user on behalf of a buyer.
2203
+ * For example, via POS (point of service).
2204
+ * @format GUID
2205
+ */
2206
+ userId?: string;
2207
+ /**
2208
+ * Member ID. When the order was created by a **logged in** site visitor.
2209
+ * @format GUID
2210
+ */
2211
+ memberId?: string;
2212
+ /**
2213
+ * Visitor ID. When the order was created by a site visitor that was **not** logged in.
2214
+ * @format GUID
2215
+ */
2216
+ visitorId?: string;
2217
+ /**
2218
+ * App ID. When the order was created by an external application or Wix service.
2219
+ * @format GUID
2220
+ */
2221
+ appId?: string;
2222
+ }
2223
+ /** Reserved for internal use. */
2224
+ interface MembershipOptions {
2225
+ /**
2226
+ * Reserved for internal use.
2227
+ * @readonly
2228
+ * @maxSize 300
2229
+ */
2230
+ eligibleMemberships?: Membership[];
2231
+ /**
2232
+ * Reserved for internal use.
2233
+ * @readonly
2234
+ * @maxSize 300
2235
+ */
2236
+ invalidMemberships?: InvalidMembership[];
2237
+ /** Selected membership to apply to this checkout. */
2238
+ selectedMemberships?: SelectedMemberships;
2239
+ }
2240
+ interface Membership {
2241
+ /**
2242
+ * Membership ID.
2243
+ * @minLength 1
2244
+ * @maxLength 100
2245
+ */
2246
+ id?: string;
2247
+ /**
2248
+ * ID of the application providing this payment option.
2249
+ * @format GUID
2250
+ */
2251
+ appId?: string;
2252
+ /** The name of this membership. */
2253
+ name?: MembershipName;
2254
+ /**
2255
+ * Line item IDs which are "paid" for by this membership.
2256
+ * @minSize 1
2257
+ * @maxSize 300
2258
+ * @minLength 1
2259
+ * @maxLength 100
2260
+ */
2261
+ lineItemIds?: string[];
2262
+ /** Optional - For a membership that has limited credits, information about credit usage. */
2263
+ credits?: MembershipPaymentCredits;
2264
+ /** Optional - TMembership expiry date. */
2265
+ expirationDate?: Date | null;
2266
+ /** Additional data about this membership. */
2267
+ additionalData?: Record<string, any> | null;
2268
+ }
2269
+ interface MembershipName {
2270
+ /**
2271
+ * Membership name.
2272
+ * @maxLength 100
2273
+ */
2274
+ original?: string;
2275
+ /**
2276
+ * Translated membership name. Defaults to `original` when not provided.
2277
+ * @maxLength 100
2278
+ */
2279
+ translated?: string | null;
2280
+ }
2281
+ interface MembershipPaymentCredits {
2282
+ /**
2283
+ * Membership's total amount of credits.
2284
+ * @min 1
2285
+ */
2286
+ total?: number;
2287
+ /** Membership's remaining amount of credits. */
2288
+ remaining?: number;
2289
+ }
2290
+ interface InvalidMembership {
2291
+ /** Membership details. */
2292
+ membership?: Membership;
2293
+ /**
2294
+ * Reason why this membership is invalid and cannot be used.
2295
+ * @minLength 1
2296
+ * @maxLength 100
2297
+ */
2298
+ reason?: string;
2299
+ }
2300
+ interface SelectedMemberships {
2301
+ /**
2302
+ * Selected memberships.
2303
+ * @maxSize 300
2304
+ */
2305
+ memberships?: SelectedMembership[];
2306
+ }
2307
+ interface SelectedMembership {
2308
+ /**
2309
+ * Membership ID.
2310
+ * @minLength 1
2311
+ * @maxLength 100
2312
+ */
2313
+ id?: string;
2314
+ /**
2315
+ * ID of the app providing this payment option.
2316
+ * @format GUID
2317
+ */
2318
+ appId?: string;
2319
+ /**
2320
+ * IDs of the line items this membership applies to.
2321
+ * @minSize 1
2322
+ * @maxSize 300
2323
+ * @minLength 1
2324
+ * @maxLength 100
2325
+ */
2326
+ lineItemIds?: string[];
2327
+ }
2328
+ interface AdditionalFee {
2329
+ /**
2330
+ * Additional fee's unique code (or ID) for future processing.
2331
+ * @minLength 1
2332
+ * @maxLength 100
2333
+ */
2334
+ code?: string | null;
2335
+ /**
2336
+ * Translated additional fee's name.
2337
+ * @minLength 1
2338
+ * @maxLength 50
2339
+ */
2340
+ name?: string;
2341
+ /** Additional fee's price. */
2342
+ price?: MultiCurrencyPrice;
2343
+ /** Tax details. */
2344
+ taxDetails?: ItemTaxFullDetails;
2345
+ /**
2346
+ * Provider's app id.
2347
+ * @minLength 1
2348
+ * @maxLength 100
2349
+ */
2350
+ providerAppId?: string | null;
2351
+ /** Additional fee's price before tax. */
2352
+ priceBeforeTax?: MultiCurrencyPrice;
2353
+ /** Additional fee's price after tax. */
2354
+ priceAfterTax?: MultiCurrencyPrice;
2355
+ /**
2356
+ * Optional - Line items associated with this additional fee.
2357
+ * If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
2358
+ * @format GUID
2359
+ */
2360
+ lineItemIds?: string[];
2361
+ /** the source the additional fee was added from */
2362
+ source?: AdditionalFeeSourceWithLiterals;
2363
+ /**
2364
+ * The translated name of the additional fee. The translation language is determined by the `languages` field in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
2365
+ * @minLength 1
2366
+ * @maxLength 50
2367
+ */
2368
+ translatedName?: string | null;
2369
+ }
2370
+ declare enum AdditionalFeeSource {
2371
+ UNKNOWN_ADDITIONAL_FEE_SOURCE = "UNKNOWN_ADDITIONAL_FEE_SOURCE",
2372
+ /** The additional fee was added by an additional fee service plugin */
2373
+ SERVICE_PLUGIN = "SERVICE_PLUGIN",
2374
+ /** The additional fee was added on the item either via the catalog or on custom line item */
2375
+ ITEM = "ITEM",
2376
+ /** The additional fee was added manually on the request */
2377
+ MANUAL = "MANUAL",
2378
+ /** The additional fee was added by the shipping provider */
2379
+ SHIPPING = "SHIPPING"
2380
+ }
2381
+ /** @enumType */
2382
+ type AdditionalFeeSourceWithLiterals = AdditionalFeeSource | 'UNKNOWN_ADDITIONAL_FEE_SOURCE' | 'SERVICE_PLUGIN' | 'ITEM' | 'MANUAL' | 'SHIPPING';
2383
+ interface ConversionInfo {
2384
+ /**
2385
+ * The site currency.
2386
+ * @readonly
2387
+ * @format CURRENCY
2388
+ */
2389
+ siteCurrency?: string;
2390
+ /**
2391
+ * The rate used when converting from the site currency to the checkout currency.
2392
+ * @readonly
2393
+ * @decimalValue options { gt:0, lte:1000000000000000 }
2394
+ */
2395
+ conversionRate?: string;
2396
+ }
2397
+ interface Violation {
2398
+ /** Severity of the violation. The violations are shown on the cart and checkout pages. A warning is displayed as yellow, and allows a site visitor to proceed with caution. An error is displayed as red, and doesn't allow a site visitor to proceed with the eCommerce flow. */
2399
+ severity?: SeverityWithLiterals;
2400
+ /** Target location on a checkout or cart page where the violation will be displayed. */
2401
+ target?: Target;
2402
+ /**
2403
+ * Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `<a href="https://www.wix.com">Click me</a>`.
2404
+ * @minLength 1
2405
+ * @maxLength 1000
2406
+ */
2407
+ description?: string | null;
2408
+ }
2409
+ declare enum Severity {
2410
+ /** The user is allowed to move forward in the flow. */
2411
+ WARNING = "WARNING",
2412
+ /**
2413
+ * The user is blocked from moving forward in the flow.
2414
+ * For example, if callerContext is CART - moving to checkout is blocked. if callerContext is CHECKOUT, placing an order is blocked.
2415
+ */
2416
+ ERROR = "ERROR"
2417
+ }
2418
+ /** @enumType */
2419
+ type SeverityWithLiterals = Severity | 'WARNING' | 'ERROR';
2420
+ interface Target extends TargetTargetTypeOneOf {
2421
+ /** General (other) violation. */
2422
+ other?: Other;
2423
+ /** Specific line item violation. */
2424
+ lineItem?: TargetLineItem;
2425
+ }
2426
+ /** @oneof */
2427
+ interface TargetTargetTypeOneOf {
2428
+ /** General (other) violation. */
2429
+ other?: Other;
2430
+ /** Specific line item violation. */
2431
+ lineItem?: TargetLineItem;
2432
+ }
2433
+ /** Available locations on the webpage */
2434
+ declare enum NameInOther {
2435
+ /** Default location, in case no specific location is specified. */
2436
+ OTHER_DEFAULT = "OTHER_DEFAULT"
2437
+ }
2438
+ /** @enumType */
2439
+ type NameInOtherWithLiterals = NameInOther | 'OTHER_DEFAULT';
2440
+ /** Available locations on the line item */
2441
+ declare enum NameInLineItem {
2442
+ /** Default location, in case no specific location is specified. */
2443
+ LINE_ITEM_DEFAULT = "LINE_ITEM_DEFAULT"
2444
+ }
2445
+ /** @enumType */
2446
+ type NameInLineItemWithLiterals = NameInLineItem | 'LINE_ITEM_DEFAULT';
2447
+ declare enum SuggestedFix {
2448
+ /** No suggested fix is specified. The user should refer to the violation description to resolve the issue. */
2449
+ UNKNOWN_SUGGESTED_FIX = "UNKNOWN_SUGGESTED_FIX",
2450
+ /** The line item should be removed from the cart or checkout to resolve the violation. */
2451
+ REMOVE_LINE_ITEM = "REMOVE_LINE_ITEM"
2452
+ }
2453
+ /** @enumType */
2454
+ type SuggestedFixWithLiterals = SuggestedFix | 'UNKNOWN_SUGGESTED_FIX' | 'REMOVE_LINE_ITEM';
2455
+ /** General (other) violation. */
2456
+ interface Other {
2457
+ /** Location on a checkout or a cart page where a general (other) violation will be displayed. */
2458
+ name?: NameInOtherWithLiterals;
2459
+ }
2460
+ /** Specific line item violation. */
2461
+ interface TargetLineItem {
2462
+ /** Location on a checkout or a cart page where the specific line item violation will be displayed. */
2463
+ name?: NameInLineItemWithLiterals;
2464
+ /** ID of the line item containing the violation. */
2465
+ id?: string | null;
2466
+ }
2467
+ interface CustomSettings {
2468
+ /**
2469
+ * Whether to restrict the option to add or remove a gift card on the checkout page.
2470
+ *
2471
+ * Default: `false`
2472
+ */
2473
+ lockGiftCard?: boolean;
2474
+ /**
2475
+ * Whether to restrict the option to add or remove a coupon code on the checkout page.
2476
+ *
2477
+ * Default: `false`
2478
+ */
2479
+ lockCouponCode?: boolean;
2480
+ /**
2481
+ * Whether to disable policy agreement checkout in the checkout page
2482
+ *
2483
+ * Default: `false`
2484
+ */
2485
+ disabledPolicyAgreementCheckbox?: boolean;
2486
+ /**
2487
+ * Whether to disable manual payment option for this checkout.
2488
+ *
2489
+ * Default: `false`
2490
+ */
2491
+ disabledManualPayment?: boolean;
2492
+ }
2493
+ interface SubscriptionCharges {
2494
+ /**
2495
+ * ids of the items the subscription is defined on
2496
+ * @format GUID
2497
+ * @minSize 1
2498
+ * @maxSize 300
2499
+ */
2500
+ lineItemIds?: string[];
2501
+ /**
2502
+ * Generated description explaining future charges amount and schedule.
2503
+ * Translated to subscription order buyer language, or to site language if was not provided.
2504
+ * @maxLength 1000
2505
+ */
2506
+ description?: string | null;
2507
+ /**
2508
+ * Charges for subscription.
2509
+ * @maxSize 50
2510
+ */
2511
+ charges?: Charge[];
2512
+ }
2513
+ interface Charge {
2514
+ /** The cycle number from which the charge starts. */
2515
+ cycleFrom?: number;
2516
+ /** The number of cycles for which the charge is applicable. */
2517
+ cycleCount?: number | null;
2518
+ /** Charge summary. */
2519
+ priceSummary?: PriceSummary;
2520
+ /** The billing date from which the charge starts. */
2521
+ cycleBillingDate?: Date | null;
2522
+ }
2523
+ interface CreateCheckoutTemplateRequest {
2524
+ /** Checkout template to create. */
2525
+ checkoutTemplate: CheckoutTemplate;
2526
+ }
2527
+ interface CreateCheckoutTemplateResponse {
2528
+ /** Created checkout template. */
2529
+ checkoutTemplate?: CheckoutTemplate;
2530
+ }
2531
+ interface GetCheckoutTemplateRequest {
2532
+ /**
2533
+ * ID of the checkout template to retrieve.
2534
+ * @format GUID
2535
+ */
2536
+ checkoutTemplateId: string;
2537
+ }
2538
+ interface GetCheckoutTemplateResponse {
2539
+ /** Retrieved checkout template. */
2540
+ checkoutTemplate?: CheckoutTemplate;
2541
+ }
2542
+ interface UpdateCheckoutTemplateRequest {
2543
+ /** Checkout template info to update. */
2544
+ checkoutTemplate: CheckoutTemplate;
2545
+ }
2546
+ interface UpdateCheckoutTemplateResponse {
2547
+ /** Updated checkout template. */
2548
+ checkoutTemplate?: CheckoutTemplate;
2549
+ }
2550
+ interface DeleteCheckoutTemplateRequest {
2551
+ /**
2552
+ * ID of the checkout template to delete.
2553
+ * @format GUID
2554
+ */
2555
+ checkoutTemplateId: string;
2556
+ }
2557
+ interface DeleteCheckoutTemplateResponse {
2558
+ }
2559
+ interface QueryCheckoutTemplatesRequest {
2560
+ /** Query options. */
2561
+ query?: CursorQuery;
2562
+ }
2563
+ interface CursorQuery extends CursorQueryPagingMethodOneOf {
2564
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2565
+ cursorPaging?: CursorPaging;
2566
+ /**
2567
+ * Filter object in the following format:
2568
+ * `"filter" : {
2569
+ * "fieldName1": "value1",
2570
+ * "fieldName2":{"$operator":"value2"}
2571
+ * }`
2572
+ *
2573
+ * Example of operators: `$eq`, `$ne`, `$in`, `$startsWith`, `$exists`, `$hasSome`
2574
+ */
2575
+ filter?: Record<string, any> | null;
2576
+ /**
2577
+ * Sort object in the following format:
2578
+ * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
2579
+ */
2580
+ sort?: Sorting[];
2581
+ }
2582
+ /** @oneof */
2583
+ interface CursorQueryPagingMethodOneOf {
2584
+ /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
2585
+ cursorPaging?: CursorPaging;
2586
+ }
2587
+ interface Sorting {
2588
+ /** Name of the field to sort by. */
2589
+ fieldName?: string;
2590
+ /** Sort order. */
2591
+ order?: SortOrderWithLiterals;
2592
+ }
2593
+ declare enum SortOrder {
2594
+ /** Ascending order. */
2595
+ ASC = "ASC",
2596
+ /** Descending order. */
2597
+ DESC = "DESC"
2598
+ }
2599
+ /** @enumType */
2600
+ type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
2601
+ interface CursorPaging {
2602
+ /**
2603
+ * Number of items to load.
2604
+ * @max 100
2605
+ */
2606
+ limit?: number | null;
2607
+ /**
2608
+ * Pointer to the next or previous page in the list of results. </ br>
2609
+ *
2610
+ * You can get the relevant cursor token
2611
+ * from the `pagingMetadata` object in the previous call's response.
2612
+ * Not relevant for the first request.
2613
+ */
2614
+ cursor?: string | null;
2615
+ }
2616
+ interface QueryCheckoutTemplatesResponse {
2617
+ /** Retrieved checkout templates. */
2618
+ checkoutTemplates?: CheckoutTemplate[];
2619
+ /** Paging metadata. */
2620
+ pagingMetadata?: CursorPagingMetadata;
2621
+ }
2622
+ interface CursorPagingMetadata {
2623
+ /** Number of items returned in the response. */
2624
+ count?: number | null;
2625
+ /** Offset that was requested. */
2626
+ cursors?: Cursors;
2627
+ /**
2628
+ * Indicates if there are more results after the current page.
2629
+ * If `true`, another page of results can be retrieved.
2630
+ * If `false`, this is the last page.
2631
+ */
2632
+ hasNext?: boolean | null;
2633
+ }
2634
+ interface Cursors {
2635
+ /** Cursor pointing to next page in the list of results. */
2636
+ next?: string | null;
2637
+ /** Cursor pointing to previous page in the list of results. */
2638
+ prev?: string | null;
2639
+ }
2640
+ interface CreateCheckoutFromTemplateRequest {
2641
+ /**
2642
+ * ID of the checkout template to use to create a checkout from.
2643
+ * @format GUID
2644
+ */
2645
+ checkoutTemplateId: string;
2646
+ /**
2647
+ * ID of the site associated with the checkout template.
2648
+ * @format GUID
2649
+ */
2650
+ siteId: string;
2651
+ }
2652
+ interface CreateCheckoutFromTemplateResponse {
2653
+ /**
2654
+ * ID of the created checkout.
2655
+ * @format GUID
2656
+ */
2657
+ checkoutId?: string;
2658
+ /** URL of the created checkout page. */
2659
+ checkoutUrl?: string;
2660
+ /**
2661
+ * Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
2662
+ * @format GUID
2663
+ */
2664
+ purchaseFlowId?: string | null;
2665
+ }
2666
+ interface CreateAndRedirectToCheckoutRequest {
2667
+ /**
2668
+ * ID of the checkout template to use to create a checkout.
2669
+ * @format GUID
2670
+ */
2671
+ checkoutTemplateId: string;
2672
+ /**
2673
+ * ID of the site associated with the checkout template.
2674
+ * @format GUID
2675
+ */
2676
+ siteId: string;
777
2677
  }
778
2678
  interface RawHttpResponse {
779
2679
  body?: Uint8Array;
@@ -784,6 +2684,178 @@ interface HeadersEntry {
784
2684
  key?: string;
785
2685
  value?: string;
786
2686
  }
2687
+ interface DomainEvent extends DomainEventBodyOneOf {
2688
+ createdEvent?: EntityCreatedEvent;
2689
+ updatedEvent?: EntityUpdatedEvent;
2690
+ deletedEvent?: EntityDeletedEvent;
2691
+ actionEvent?: ActionEvent;
2692
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
2693
+ id?: string;
2694
+ /**
2695
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
2696
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
2697
+ */
2698
+ entityFqdn?: string;
2699
+ /**
2700
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
2701
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
2702
+ */
2703
+ slug?: string;
2704
+ /** ID of the entity associated with the event. */
2705
+ entityId?: string;
2706
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
2707
+ eventTime?: Date | null;
2708
+ /**
2709
+ * Whether the event was triggered as a result of a privacy regulation application
2710
+ * (for example, GDPR).
2711
+ */
2712
+ triggeredByAnonymizeRequest?: boolean | null;
2713
+ /** If present, indicates the action that triggered the event. */
2714
+ originatedFrom?: string | null;
2715
+ /**
2716
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
2717
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
2718
+ */
2719
+ entityEventSequence?: string | null;
2720
+ }
2721
+ /** @oneof */
2722
+ interface DomainEventBodyOneOf {
2723
+ createdEvent?: EntityCreatedEvent;
2724
+ updatedEvent?: EntityUpdatedEvent;
2725
+ deletedEvent?: EntityDeletedEvent;
2726
+ actionEvent?: ActionEvent;
2727
+ }
2728
+ interface EntityCreatedEvent {
2729
+ entityAsJson?: string;
2730
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
2731
+ restoreInfo?: RestoreInfo;
2732
+ }
2733
+ interface RestoreInfo {
2734
+ deletedDate?: Date | null;
2735
+ }
2736
+ interface EntityUpdatedEvent {
2737
+ /**
2738
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
2739
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
2740
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
2741
+ */
2742
+ currentEntityAsJson?: string;
2743
+ }
2744
+ interface EntityDeletedEvent {
2745
+ /** Entity that was deleted. */
2746
+ deletedEntityAsJson?: string | null;
2747
+ }
2748
+ interface ActionEvent {
2749
+ bodyAsJson?: string;
2750
+ }
2751
+ interface MessageEnvelope {
2752
+ /**
2753
+ * App instance ID.
2754
+ * @format GUID
2755
+ */
2756
+ instanceId?: string | null;
2757
+ /**
2758
+ * Event type.
2759
+ * @maxLength 150
2760
+ */
2761
+ eventType?: string;
2762
+ /** The identification type and identity data. */
2763
+ identity?: IdentificationData;
2764
+ /** Stringify payload. */
2765
+ data?: string;
2766
+ }
2767
+ interface IdentificationData extends IdentificationDataIdOneOf {
2768
+ /**
2769
+ * ID of a site visitor that has not logged in to the site.
2770
+ * @format GUID
2771
+ */
2772
+ anonymousVisitorId?: string;
2773
+ /**
2774
+ * ID of a site visitor that has logged in to the site.
2775
+ * @format GUID
2776
+ */
2777
+ memberId?: string;
2778
+ /**
2779
+ * ID of a Wix user (site owner, contributor, etc.).
2780
+ * @format GUID
2781
+ */
2782
+ wixUserId?: string;
2783
+ /**
2784
+ * ID of an app.
2785
+ * @format GUID
2786
+ */
2787
+ appId?: string;
2788
+ /** @readonly */
2789
+ identityType?: WebhookIdentityTypeWithLiterals;
2790
+ }
2791
+ /** @oneof */
2792
+ interface IdentificationDataIdOneOf {
2793
+ /**
2794
+ * ID of a site visitor that has not logged in to the site.
2795
+ * @format GUID
2796
+ */
2797
+ anonymousVisitorId?: string;
2798
+ /**
2799
+ * ID of a site visitor that has logged in to the site.
2800
+ * @format GUID
2801
+ */
2802
+ memberId?: string;
2803
+ /**
2804
+ * ID of a Wix user (site owner, contributor, etc.).
2805
+ * @format GUID
2806
+ */
2807
+ wixUserId?: string;
2808
+ /**
2809
+ * ID of an app.
2810
+ * @format GUID
2811
+ */
2812
+ appId?: string;
2813
+ }
2814
+ declare enum WebhookIdentityType {
2815
+ UNKNOWN = "UNKNOWN",
2816
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
2817
+ MEMBER = "MEMBER",
2818
+ WIX_USER = "WIX_USER",
2819
+ APP = "APP"
2820
+ }
2821
+ /** @enumType */
2822
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
2823
+ /** @docsIgnore */
2824
+ type CreateCheckoutTemplateApplicationErrors = {
2825
+ code?: 'CANNOT_CREATE_CHECKOUT_TEMPLATE_WITHOUT_ITEMS';
2826
+ description?: string;
2827
+ data?: Record<string, any>;
2828
+ };
2829
+ /** @docsIgnore */
2830
+ type UpdateCheckoutTemplateApplicationErrors = {
2831
+ code?: 'CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITHOUT_SPECIFIED_FIELDS';
2832
+ description?: string;
2833
+ data?: Record<string, any>;
2834
+ } | {
2835
+ code?: 'CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITH_UNSUPPORTED_FIELD';
2836
+ description?: string;
2837
+ data?: Record<string, any>;
2838
+ } | {
2839
+ code?: 'CANNOT_UPDATE_CHECKOUT_UPDATE_TEMPLATE_WITH_UNKNOWN_STATUS';
2840
+ description?: string;
2841
+ data?: Record<string, any>;
2842
+ } | {
2843
+ code?: 'CANNOT_UPDATE_CHECKOUT_TEMPLATE_WITH_EMPTY_ITEMS';
2844
+ description?: string;
2845
+ data?: Record<string, any>;
2846
+ };
2847
+ /** @docsIgnore */
2848
+ type CreateCheckoutFromTemplateApplicationErrors = {
2849
+ code?: 'CANNOT_CREATE_CHECKOUT_FROM_INACTIVE_TEMPLATE';
2850
+ description?: string;
2851
+ data?: Record<string, any>;
2852
+ };
2853
+ /** @docsIgnore */
2854
+ type CreateAndRedirectToCheckoutApplicationErrors = {
2855
+ code?: 'CANNOT_CREATE_CHECKOUT_FROM_INACTIVE_TEMPLATE';
2856
+ description?: string;
2857
+ data?: Record<string, any>;
2858
+ };
787
2859
 
788
2860
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
789
2861
  getUrl: (context: any) => string;
@@ -813,4 +2885,4 @@ declare function createAndRedirectToCheckout(): __PublicMethodMetaInfo<'GET', {
813
2885
  checkoutTemplateId: string;
814
2886
  }, CreateAndRedirectToCheckoutRequest$1, CreateAndRedirectToCheckoutRequest, RawHttpResponse$1, RawHttpResponse>;
815
2887
 
816
- export { type __PublicMethodMetaInfo, createAndRedirectToCheckout, createCheckoutFromTemplate, createCheckoutTemplate, deleteCheckoutTemplate, getCheckoutTemplate, queryCheckoutTemplates, updateCheckoutTemplate };
2888
+ export { type ActionEvent as ActionEventOriginal, type AdditionalFee as AdditionalFeeOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, type AggregatedTaxBreakdown as AggregatedTaxBreakdownOriginal, type ApplicableLineItems as ApplicableLineItemsOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type AutoTaxFallbackCalculationDetails as AutoTaxFallbackCalculationDetailsOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type CalculationErrors as CalculationErrorsOriginal, type CalculationErrorsShippingCalculationErrorOneOf as CalculationErrorsShippingCalculationErrorOneOfOriginal, type CarrierError as CarrierErrorOriginal, type CarrierErrors as CarrierErrorsOriginal, type Carrier as CarrierOriginal, type CarrierServiceOption as CarrierServiceOptionOriginal, type CatalogOverrideFields as CatalogOverrideFieldsOriginal, type CatalogReference as CatalogReferenceOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type Charge as ChargeOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type CheckoutCustomization as CheckoutCustomizationOriginal, type Checkout as CheckoutOriginal, type CheckoutTemplate as CheckoutTemplateOriginal, type CheckoutTemplateUsed as CheckoutTemplateUsedOriginal, type Color as ColorOriginal, type CommonImage as CommonImageOriginal, type ConversionInfo as ConversionInfoOriginal, type Coupon as CouponOriginal, type CreateAndRedirectToCheckoutApplicationErrors as CreateAndRedirectToCheckoutApplicationErrorsOriginal, type CreateAndRedirectToCheckoutRequest as CreateAndRedirectToCheckoutRequestOriginal, type CreateCheckoutFromTemplateApplicationErrors as CreateCheckoutFromTemplateApplicationErrorsOriginal, type CreateCheckoutFromTemplateRequest as CreateCheckoutFromTemplateRequestOriginal, type CreateCheckoutFromTemplateResponse as CreateCheckoutFromTemplateResponseOriginal, type CreateCheckoutTemplateApplicationErrors as CreateCheckoutTemplateApplicationErrorsOriginal, type CreateCheckoutTemplateRequest as CreateCheckoutTemplateRequestOriginal, type CreateCheckoutTemplateResponse as CreateCheckoutTemplateResponseOriginal, type CreatedByIdOneOf as CreatedByIdOneOfOriginal, type CreatedBy as CreatedByOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomContentReference as CustomContentReferenceOriginal, type CustomField as CustomFieldOriginal, type CustomLineItem as CustomLineItemOriginal, type CustomSettings as CustomSettingsOriginal, type DeleteCheckoutTemplateRequest as DeleteCheckoutTemplateRequestOriginal, type DeleteCheckoutTemplateResponse as DeleteCheckoutTemplateResponseOriginal, type DeliveryAllocation as DeliveryAllocationOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type Description as DescriptionOriginal, type DetailsKindOneOf as DetailsKindOneOfOriginal, type Details as DetailsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReference as ExternalReferenceOriginal, FallbackReason as FallbackReasonOriginal, type FallbackReasonWithLiterals as FallbackReasonWithLiteralsOriginal, type FieldViolation as FieldViolationOriginal, FileType as FileTypeOriginal, type FileTypeWithLiterals as FileTypeWithLiteralsOriginal, type FocalPoint as FocalPointOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type GetCheckoutTemplateRequest as GetCheckoutTemplateRequestOriginal, type GetCheckoutTemplateResponse as GetCheckoutTemplateResponseOriginal, type GiftCard as GiftCardOriginal, type Group as GroupOriginal, type HeadersEntry as HeadersEntryOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type InvalidMembership as InvalidMembershipOriginal, type ItemAvailabilityInfo as ItemAvailabilityInfoOriginal, ItemAvailabilityStatus as ItemAvailabilityStatusOriginal, type ItemAvailabilityStatusWithLiterals as ItemAvailabilityStatusWithLiteralsOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, ItemTypeItemType as ItemTypeItemTypeOriginal, type ItemTypeItemTypeWithLiterals as ItemTypeItemTypeWithLiteralsOriginal, type ItemType as ItemTypeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItem as LineItemOriginal, ManualCalculationReason as ManualCalculationReasonOriginal, type ManualCalculationReasonWithLiterals as ManualCalculationReasonWithLiteralsOriginal, type MembershipName as MembershipNameOriginal, type MembershipOptions as MembershipOptionsOriginal, type Membership as MembershipOriginal, type MembershipPaymentCredits as MembershipPaymentCreditsOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type ModifierGroup as ModifierGroupOriginal, type MultiCurrencyPrice as MultiCurrencyPriceOriginal, NameInLineItem as NameInLineItemOriginal, type NameInLineItemWithLiterals as NameInLineItemWithLiteralsOriginal, NameInOther as NameInOtherOriginal, type NameInOtherWithLiterals as NameInOtherWithLiteralsOriginal, type OtherCharge as OtherChargeOriginal, type Other as OtherOriginal, type PageUrlV2 as PageUrlV2Original, type PaymentOption as PaymentOptionOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type Policy as PolicyOriginal, type PriceDescription as PriceDescriptionOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, type QueryCheckoutTemplatesRequest as QueryCheckoutTemplatesRequestOriginal, type QueryCheckoutTemplatesResponse as QueryCheckoutTemplatesResponseOriginal, RateType as RateTypeOriginal, type RateTypeWithLiterals as RateTypeWithLiteralsOriginal, type RawHttpResponse as RawHttpResponseOriginal, type Region as RegionOriginal, type RestoreInfo as RestoreInfoOriginal, RuleType as RuleTypeOriginal, type RuleTypeWithLiterals as RuleTypeWithLiteralsOriginal, type Scope as ScopeOriginal, type SecuredMedia as SecuredMediaOriginal, type SelectedCarrierServiceOption as SelectedCarrierServiceOptionOriginal, type SelectedCarrierServiceOptionOtherCharge as SelectedCarrierServiceOptionOtherChargeOriginal, type SelectedCarrierServiceOptionPrices as SelectedCarrierServiceOptionPricesOriginal, type SelectedMembership as SelectedMembershipOriginal, type SelectedMemberships as SelectedMembershipsOriginal, type ServiceProperties as ServicePropertiesOriginal, Severity as SeverityOriginal, type SeverityWithLiterals as SeverityWithLiteralsOriginal, type ShippingInfo as ShippingInfoOriginal, type ShippingOption as ShippingOptionOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRegion as ShippingRegionOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SubscriptionCharges as SubscriptionChargesOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionOptionInfo as SubscriptionOptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, SuggestedFix as SuggestedFixOriginal, type SuggestedFixWithLiterals as SuggestedFixWithLiteralsOriginal, type SystemError as SystemErrorOriginal, type TargetLineItem as TargetLineItemOriginal, type Target as TargetOriginal, type TargetTargetTypeOneOf as TargetTargetTypeOneOfOriginal, type TaxBreakdown as TaxBreakdownOriginal, type TaxCalculationDetailsCalculationDetailsOneOf as TaxCalculationDetailsCalculationDetailsOneOfOriginal, type TaxCalculationDetails as TaxCalculationDetailsOriginal, type TaxRateBreakdown as TaxRateBreakdownOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type Title as TitleOriginal, type TranslatableString as TranslatableStringOriginal, type UpdateCheckoutTemplateApplicationErrors as UpdateCheckoutTemplateApplicationErrorsOriginal, type UpdateCheckoutTemplateRequest as UpdateCheckoutTemplateRequestOriginal, type UpdateCheckoutTemplateResponse as UpdateCheckoutTemplateResponseOriginal, type V1ItemModifier as V1ItemModifierOriginal, type V1LineItem as V1LineItemOriginal, type V1ModifierGroup as V1ModifierGroupOriginal, type ValidationError as ValidationErrorOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type Violation as ViolationOriginal, type WebClientCustomization as WebClientCustomizationOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type __PublicMethodMetaInfo, createAndRedirectToCheckout, createCheckoutFromTemplate, createCheckoutTemplate, deleteCheckoutTemplate, getCheckoutTemplate, queryCheckoutTemplates, updateCheckoutTemplate };