{"id":"542352e6-3f2c-49bb-b4a0-397038081966","createdDate":"2024-08-27T13:30:02.455Z","updatedDate":"2024-08-27T13:30:02.455Z","resourceId":"d15e5b1a-609c-4b24-adc2-a9cb413971ab","sdk":{"schema":{"name":"velo-events_wix-ecom-backend","fqn":"","slug":"velo-events-wix-ecom-backend","typesMap":{"docs/ecom-discounts-v1-discount-rule.DiscountRuleCreated":{"name":"DiscountRuleCreated","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountRuleCreated","slug":"discount-rule-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRule","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountRule"},"description":"Created discount rule."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-discounts-v1-discount-rule.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-discounts-v1-discount-rule.DiscountRule":{"name":"DiscountRule","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountRule","slug":"discount-rule","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the discount rule was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rule ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the discount rule was last updated."},{"name":"active","slug":"active","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the discount rule is active.\n\nDefault: `true`"},{"name":"activeTimeInfo","slug":"active-time-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActiveTimeInfo","referenceFqn":"docs/ecom-discounts-v1-discount-rule.ActiveTimeInfo"},"description":"Time frame in which the discount rule is active."},{"name":"discounts","slug":"discounts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Discounts","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Discounts"},"description":"List of discounts that are applied when one or more triggers are met.\n\n> **Notes:**\n>\n> + Currently, only 1 discount can be defined per discount rule.\n> + A discount rule can be applied on multiple items per cart.\n> + A discount rule can only be applied once per item."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rule name."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the discount rule is updated.\nTo prevent conflicting changes, the current `revision` must be passed when updating the discount rule."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Status"},"description":"Discount rule status."},{"name":"trigger","slug":"trigger","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountTrigger","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountTrigger"},"description":"Discount rule trigger.\nA set of conditions that must be met for the `discounts` to be applied.\nNot passing a trigger will cause the discount to always apply."},{"name":"usageCount","slug":"usage-count","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of times the discount rule was used."}]},"docs/ecom-discounts-v1-discount-rule.ActiveTimeInfo":{"name":"ActiveTimeInfo","fqn":"docs/ecom-discounts-v1-discount-rule.ActiveTimeInfo","slug":"active-time-info","actions":[],"properties":[{"name":"end","slug":"end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the discount rule is active **till**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the discount rule is active **from**, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."}]},"docs/ecom-discounts-v1-discount-rule.Discounts":{"name":"Discounts","fqn":"docs/ecom-discounts-v1-discount-rule.Discounts","slug":"discounts","actions":[],"properties":[{"name":"values","slug":"values","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Discount","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Discount"}},"description":"Discounts."}]},"docs/ecom-discounts-v1-discount-rule.Discount":{"name":"Discount","fqn":"docs/ecom-discounts-v1-discount-rule.Discount","slug":"discount","actions":[],"oneofProperties":{"discount":[{"name":"fixedAmount","slug":"fixed-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount to discount from original price."},{"name":"fixedPrice","slug":"fixed-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fixed price. Line item will be fixed to this price."},{"name":"percentage","slug":"percentage","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Percentage to discount from original price."}]},"properties":[{"name":"discountType","slug":"discount-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountType","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountType"},"description":"Discount type.\n\n+ `PERCENTAGE`: Price is reduced by percentage value.\n+ `FIXED_AMOUNT`: Price is reduced by fixed amount.\n+ `FIXED_PRICE`: Price will be set to fixed amount."},{"name":"specificItemsInfo","slug":"specific-items-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SpecificItemsInfo","referenceFqn":"docs/ecom-discounts-v1-discount-rule.SpecificItemsInfo"},"description":"Data related to `SPECIFIC_ITEMS` target type."},{"name":"targetType","slug":"target-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Type","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Type"},"description":"Discount target.\n\n+ `SPECIFIC_ITEMS`: Discount applies to a specific set of items."}]},"docs/ecom-discounts-v1-discount-rule.BuyXGetYInfo":{"name":"BuyXGetYInfo","fqn":"docs/ecom-discounts-v1-discount-rule.BuyXGetYInfo","slug":"buy-xget-yinfo","actions":[],"properties":[{"name":"customerBuys","slug":"customer-buys","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomerBuy","referenceFqn":"docs/ecom-discounts-v1-discount-rule.CustomerBuy"},"description":"Information about which items must be in the cart (buy X) for the discount to apply (get Y)."},{"name":"customerGets","slug":"customer-gets","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomerGet","referenceFqn":"docs/ecom-discounts-v1-discount-rule.CustomerGet"},"description":"Information about which items will be discounted (get Y)."},{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The maximum number of times the 'buy X get Y' discount can be applied.\nFor example, when the value of `limit` is `2`, with a \"2+1\" sale on all items, the following logic applies:\n+ Buy 2 get 1, buy 3 get 1.\n+ Buy 4 get 2, buy 6 get 2, buy 9 get 2, and so on."}]},"docs/ecom-discounts-v1-discount-rule.CustomerBuy":{"name":"CustomerBuy","fqn":"docs/ecom-discounts-v1-discount-rule.CustomerBuy","slug":"customer-buy","actions":[],"oneofProperties":{"condition":[{"name":"minimumQuantity","slug":"minimum-quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum number of items the customer must add to the cart to be eligible for a discount."},{"name":"minimumSpend","slug":"minimum-spend","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum price the customer must add to the cart to be eligible for a discount."}]},"properties":[{"name":"scopes","slug":"scopes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Scope","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Scope"}},"description":"Scopes of the items that must be added to the cart to enable the discount."}]},"docs/ecom-discounts-v1-discount-rule.Scope":{"name":"Scope","fqn":"docs/ecom-discounts-v1-discount-rule.Scope","slug":"scope","actions":[],"oneofProperties":{"scopeItems":[{"name":"catalogItemFilter","slug":"catalog-item-filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogItemFilter","referenceFqn":"docs/ecom-discounts-v1-discount-rule.CatalogItemFilter"},"description":"Catalog item filter. Must be passed with `type.\"CATALOG_ITEM\"`."},{"name":"customFilter","slug":"custom-filter","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomFilter","referenceFqn":"docs/ecom-discounts-v1-discount-rule.CustomFilter"},"description":"Custom filter. Must be passed with `type.\"CATALOG_ITEM\"`."}]},"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Scope ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScopeType","referenceFqn":"docs/ecom-discounts-v1-discount-rule.ScopeType"},"description":"Scope type."}]},"docs/ecom-discounts-v1-discount-rule.CatalogItemFilter":{"name":"CatalogItemFilter","fqn":"docs/ecom-discounts-v1-discount-rule.CatalogItemFilter","slug":"catalog-item-filter","actions":[],"properties":[{"name":"catalogAppId","slug":"catalog-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Catalog App ID. For example, the Wix Stores, Wix Bookings, or 3rd-party `appId`."},{"name":"catalogItemIds","slug":"catalog-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"ID of the item within its Wix or 3rd-party catalog. For example, `productId` for Wix Stores."}]},"docs/ecom-discounts-v1-discount-rule.CustomFilter":{"name":"CustomFilter","fqn":"docs/ecom-discounts-v1-discount-rule.CustomFilter","slug":"custom-filter","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom filter app ID, when relevant."},{"name":"params","slug":"params","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Custom filter in `{ \"key\": \"value\" }` form.\nFor example, an array of `collectionIDs`:\n`{ [\"collectionId\": \"12345\"], [\"collectionId\": \"67890\"] }`."}]},"docs/ecom-discounts-v1-discount-rule.ScopeType":{"name":"ScopeType","fqn":"docs/ecom-discounts-v1-discount-rule.ScopeType","slug":"scope-type","actions":[],"enumValues":["CATALOG_ITEM","CUSTOM_FILTER","UNDEFINED_SCOPE"],"properties":[]},"docs/ecom-discounts-v1-discount-rule.CustomerGet":{"name":"CustomerGet","fqn":"docs/ecom-discounts-v1-discount-rule.CustomerGet","slug":"customer-get","actions":[],"properties":[{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Exact number of items in the cart that will be discounted.\nIf the cart contains fewer items than the value of quantity, the discount will not apply."},{"name":"scopes","slug":"scopes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Scope","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Scope"}},"description":"Scopes of the items that will be discounted."}]},"docs/ecom-discounts-v1-discount-rule.DiscountType":{"name":"DiscountType","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountType","slug":"discount-type","actions":[],"enumValues":["FIXED_AMOUNT","FIXED_PRICE","PERCENTAGE","UNDEFINED"],"properties":[]},"docs/ecom-discounts-v1-discount-rule.SpecificItemsInfo":{"name":"SpecificItemsInfo","fqn":"docs/ecom-discounts-v1-discount-rule.SpecificItemsInfo","slug":"specific-items-info","actions":[],"properties":[{"name":"scopes","slug":"scopes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Scope","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Scope"}},"description":"All associated scopes for `SPECIFIC_ITEMS` target type."}]},"docs/ecom-discounts-v1-discount-rule.Type":{"name":"Type","fqn":"docs/ecom-discounts-v1-discount-rule.Type","slug":"type","actions":[],"enumValues":["BUY_X_GET_Y","SPECIFIC_ITEMS","UNDEFINED"],"properties":[]},"docs/ecom-discounts-v1-discount-rule.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-discounts-v1-discount-rule.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-discounts-v1-discount-rule.DiscountSettings":{"name":"DiscountSettings","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountSettings","slug":"discount-settings","actions":[],"properties":[{"name":"appliesTo","slug":"applies-to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppliedSubjectType","referenceFqn":"docs/ecom-discounts-v1-discount-rule.AppliedSubjectType"},"description":"Discount applies to either `ALL_ITEMS`, or to the `LOWEST_PRICED_ITEM`."},{"name":"includeSubscription","slug":"include-subscription","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the discount will apply to subscriptions.\n\nDefault: `false`"},{"name":"usageLimit","slug":"usage-limit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum total number of uses allowed for the discount rule."},{"name":"usageLimitPerUser","slug":"usage-limit-per-user","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The usage limit per user per discount.\nWhen not provided, this setting will not apply."}]},"docs/ecom-discounts-v1-discount-rule.AppliedSubjectType":{"name":"AppliedSubjectType","fqn":"docs/ecom-discounts-v1-discount-rule.AppliedSubjectType","slug":"applied-subject-type","actions":[],"enumValues":["ALL_ITEMS","LOWEST_PRICED_ITEM","UNDEFINED"],"properties":[]},"docs/ecom-discounts-v1-discount-rule.Status":{"name":"Status","fqn":"docs/ecom-discounts-v1-discount-rule.Status","slug":"status","actions":[],"enumValues":["EXPIRED","LIVE","PENDING","UNDEFINED"],"properties":[]},"docs/ecom-discounts-v1-discount-rule.DiscountTrigger":{"name":"DiscountTrigger","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountTrigger","slug":"discount-trigger","actions":[],"oneofProperties":{"trigger":[{"name":"and","slug":"and","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"And","referenceFqn":"docs/ecom-discounts-v1-discount-rule.And"},"description":"Chain multiple triggers with the `and` operator."},{"name":"customTrigger","slug":"custom-trigger","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Custom","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Custom"},"description":"Custom trigger."},{"name":"itemQuantityRange","slug":"item-quantity-range","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemQuantityRange","referenceFqn":"docs/ecom-discounts-v1-discount-rule.ItemQuantityRange"},"description":"Item quantity trigger range."},{"name":"or","slug":"or","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Or","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Or"},"description":"Chain multiple triggers with the `or` operator."},{"name":"subtotalRange","slug":"subtotal-range","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubtotalRange","referenceFqn":"docs/ecom-discounts-v1-discount-rule.SubtotalRange"},"description":"Subtotal trigger range."}]},"properties":[{"name":"triggerType","slug":"trigger-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TriggerType","referenceFqn":"docs/ecom-discounts-v1-discount-rule.TriggerType"},"description":"Trigger type.\n\n+ `AND`: Operator used for chaining multiple triggers. Currently 1 `AND` chain operator is supported.\n+ `SUBTOTAL_RANGE`: Subtotal must be within the specified `subtotalRange` values.\n+ `ITEM_QUANTITY_RANGE`: Quantity of items in scope must be within specified `itemQuantityRange` values.\n+ `CUSTOM`: Custom trigger type defined in `customTrigger` object."}]},"docs/ecom-discounts-v1-discount-rule.And":{"name":"And","fqn":"docs/ecom-discounts-v1-discount-rule.And","slug":"and","actions":[],"properties":[{"name":"triggers","slug":"triggers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DiscountTrigger","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountTrigger"}},"description":"List of triggers to have an \"AND\" operator between their results."}]},"docs/ecom-discounts-v1-discount-rule.Custom":{"name":"Custom","fqn":"docs/ecom-discounts-v1-discount-rule.Custom","slug":"custom","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Trigger ID."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that created the trigger."}]},"docs/ecom-discounts-v1-discount-rule.ItemQuantityRange":{"name":"ItemQuantityRange","fqn":"docs/ecom-discounts-v1-discount-rule.ItemQuantityRange","slug":"item-quantity-range","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum item quantity (inclusive)."},{"name":"scopes","slug":"scopes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Scope","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Scope"}},"description":"Relevant scopes for `SPECIFIC_ITEMS` target type."},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum item quantity (inclusive)."}]},"docs/ecom-discounts-v1-discount-rule.Or":{"name":"Or","fqn":"docs/ecom-discounts-v1-discount-rule.Or","slug":"or","actions":[],"properties":[{"name":"triggers","slug":"triggers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DiscountTrigger","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountTrigger"}},"description":"List of triggers to have an \"OR\" operator between their results."}]},"docs/ecom-discounts-v1-discount-rule.SubtotalRange":{"name":"SubtotalRange","fqn":"docs/ecom-discounts-v1-discount-rule.SubtotalRange","slug":"subtotal-range","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum subtotal price (inclusive)."},{"name":"scopes","slug":"scopes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Scope","referenceFqn":"docs/ecom-discounts-v1-discount-rule.Scope"}},"description":"Relevant scopes for `SPECIFIC_ITEMS` target type."},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Maximum subtotal price (inclusive)."}]},"docs/ecom-discounts-v1-discount-rule.TriggerType":{"name":"TriggerType","fqn":"docs/ecom-discounts-v1-discount-rule.TriggerType","slug":"trigger-type","actions":[],"enumValues":["AND","CUSTOM","ITEM_QUANTITY_RANGE","OR","SUBTOTAL_RANGE","UNDEFINED"],"properties":[]},"docs/ecom-discounts-v1-discount-rule.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-discounts-v1-discount-rule.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-discounts-v1-discount-rule.DiscountRuleDeleted":{"name":"DiscountRuleDeleted","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountRuleDeleted","slug":"discount-rule-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-discounts-v1-discount-rule.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-discounts-v1-discount-rule.DiscountRuleUpdated":{"name":"DiscountRuleUpdated","fqn":"docs/ecom-discounts-v1-discount-rule.DiscountRuleUpdated","slug":"discount-rule-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRule","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountRule"},"description":"Updated discount rule."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-discounts-v1-discount-rule.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-orders-v1-invoice.InvoiceCreated":{"name":"InvoiceCreated","fqn":"docs/ecom-orders-v1-invoice.InvoiceCreated","slug":"invoice-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Invoice","referenceFqn":"docs/ecom-orders-v1-invoice.Invoice"},"description":"Created invoice."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-orders-v1-invoice.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-orders-v1-invoice.Invoice":{"name":"Invoice","fqn":"docs/ecom-orders-v1-invoice.Invoice","slug":"invoice","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invoice ID."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that set the invoice."}]},"docs/ecom-orders-v1-invoice.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-orders-v1-invoice.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-abandoned-checkout.AbandonedCheckoutRecoveredEvent":{"name":"AbandonedCheckoutRecoveredEvent","fqn":"docs/ecom-v1-abandoned-checkout.AbandonedCheckoutRecoveredEvent","slug":"abandoned-checkout-recovered-event","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AbandonedCheckoutRecovered","referenceFqn":"docs/ecom-v1-abandoned-checkout.AbandonedCheckoutRecovered"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-abandoned-checkout.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-abandoned-checkout.AbandonedCheckoutRecovered":{"name":"AbandonedCheckoutRecovered","fqn":"docs/ecom-v1-abandoned-checkout.AbandonedCheckoutRecovered","slug":"abandoned-checkout-recovered","actions":[],"properties":[{"name":"abandonedCheckout","slug":"abandoned-checkout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AbandonedCheckout","referenceFqn":"docs/ecom-v1-abandoned-checkout.AbandonedCheckout"}}]},"docs/ecom-v1-abandoned-checkout.AbandonedCheckout":{"name":"AbandonedCheckout","fqn":"docs/ecom-v1-abandoned-checkout.AbandonedCheckout","slug":"abandoned-checkout","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the abandoned checkout was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Abandoned checkout ID."},{"name":"_updatedDate","slug":"updated-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the abandoned checkout was updated."},{"name":"activities","slug":"activities","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Activity","referenceFqn":"docs/ecom-v1-abandoned-checkout.Activity"}},"description":"List of all automation activities performed by [Wix Automations](https://support.wix.com/en/article/wix-automations-getting-started) regarding the abandoned checkout.\nWix Automations updates the `activities` field for each actvity in the automation flow. Only relevant if the site owner set up [automations in the Dashboard](https://support.wix.com/en/article/wix-automations-creating-a-new-automation). Read more about `activities` in the [introduction](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction)."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1BuyerInfo","referenceFqn":"docs/ecom-v1-abandoned-checkout.V1BuyerInfo"},"description":"Buyer information."},{"name":"buyerLanguage","slug":"buyer-language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected."},{"name":"cartId","slug":"cart-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The associated cart ID."},{"name":"checkoutId","slug":"checkout-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The associated checkout ID."},{"name":"checkoutRecoveredDate","slug":"checkout-recovered-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the abandoned checkout was recovered."},{"name":"checkoutUrl","slug":"checkout-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout URL."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FullAddressContactDetails","referenceFqn":"docs/ecom-v1-abandoned-checkout.FullAddressContactDetails"},"description":"Contact details."},{"name":"conversionCurrency","slug":"conversion-currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency the buyer used in checkout."},{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The store's currency."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"docs/ecom-v1-abandoned-checkout.Status"},"description":"Status of the abandoned checkout."},{"name":"subtotalPrice","slug":"subtotal-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-abandoned-checkout.MultiCurrencyPrice"},"description":"Subtotal price of all line items, before discounts and before tax."},{"name":"totalPrice","slug":"total-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-abandoned-checkout.MultiCurrencyPrice"},"description":"Total price after discounts, gift cards, and tax."}]},"docs/ecom-v1-abandoned-checkout.Activity":{"name":"Activity","fqn":"docs/ecom-v1-abandoned-checkout.Activity","slug":"activity","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the automation activity was created."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActivityType","referenceFqn":"docs/ecom-v1-abandoned-checkout.ActivityType"},"description":"Automation activity type."}]},"docs/ecom-v1-abandoned-checkout.ActivityType":{"name":"ActivityType","fqn":"docs/ecom-v1-abandoned-checkout.ActivityType","slug":"activity-type","actions":[],"enumValues":["EMAIL_NOT_SENT","EMAIL_SENT","NOTIFICATION_SENT","SCHEDULED","TASK_CREATED","UNKNOWN_TYPE"],"properties":[]},"docs/ecom-v1-abandoned-checkout.V1BuyerInfo":{"name":"V1BuyerInfo","fqn":"docs/ecom-v1-abandoned-checkout.V1BuyerInfo","slug":"v1buyer-info","actions":[],"oneofProperties":{"id":[{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID (if the site visitor is a site member)."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User ID (if the site visitor is a site owner or collaborator)."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID (if the site visitor is **not** a site member)."}]},"properties":[{"name":"contactId","slug":"contact-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID. For more information, see the [Contacts API](https://dev.wix.com/docs/rest/api-reference/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email address."}]},"docs/ecom-v1-abandoned-checkout.FullAddressContactDetails":{"name":"FullAddressContactDetails","fqn":"docs/ecom-v1-abandoned-checkout.FullAddressContactDetails","slug":"full-address-contact-details","actions":[],"properties":[{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Company name."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"vatId","slug":"vat-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatId","referenceFqn":"docs/ecom-v1-abandoned-checkout.VatId"},"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed."}]},"docs/ecom-v1-abandoned-checkout.VatId":{"name":"VatId","fqn":"docs/ecom-v1-abandoned-checkout.VatId","slug":"vat-id","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Customer's tax ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatType","referenceFqn":"docs/ecom-v1-abandoned-checkout.VatType"},"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations"}]},"docs/ecom-v1-abandoned-checkout.VatType":{"name":"VatType","fqn":"docs/ecom-v1-abandoned-checkout.VatType","slug":"vat-type","actions":[],"enumValues":["CNPJ","CPF","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-abandoned-checkout.Status":{"name":"Status","fqn":"docs/ecom-v1-abandoned-checkout.Status","slug":"status","actions":[],"enumValues":["ABANDONED","RECOVERED"],"properties":[]},"docs/ecom-v1-abandoned-checkout.MultiCurrencyPrice":{"name":"MultiCurrencyPrice","fqn":"docs/ecom-v1-abandoned-checkout.MultiCurrencyPrice","slug":"multi-currency-price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"convertedAmount","slug":"converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."},{"name":"formattedConvertedAmount","slug":"formatted-converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount formatted with currency symbol."}]},"docs/ecom-v1-abandoned-checkout.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-abandoned-checkout.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestInvalidateCache":{"name":"BackInStockNotificationRequestInvalidateCache","fqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestInvalidateCache","slug":"back-in-stock-notification-request-invalidate-cache","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"InvalidateCache","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.InvalidateCache"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-back-in-stock-notification-request.InvalidateCache":{"name":"InvalidateCache","fqn":"docs/ecom-v1-back-in-stock-notification-request.InvalidateCache","slug":"invalidate-cache","actions":[],"oneofProperties":{"getBy":[{"name":"app","slug":"app","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"App","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.App"},"description":"Invalidate by App"},{"name":"file","slug":"file","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"File","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.File"},"description":"Invalidate by file (for media files such as PDFs)"},{"name":"metaSiteId","slug":"meta-site-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invalidate by msId. NOT recommended, as this will invalidate the entire site cache!"},{"name":"page","slug":"page","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Page","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.Page"},"description":"Invalidate by page id"},{"name":"siteId","slug":"site-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invalidate by Site ID. NOT recommended, as this will invalidate the entire site cache!"},{"name":"uri","slug":"uri","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"URI","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.URI"},"description":"Invalidate by URI path"}]},"properties":[{"name":"localDc","slug":"local-dc","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Is local DS"},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"tell us why you're invalidating the cache. You don't need to add your app name"}]},"docs/ecom-v1-back-in-stock-notification-request.App":{"name":"App","fqn":"docs/ecom-v1-back-in-stock-notification-request.App","slug":"app","actions":[],"properties":[{"name":"appDefId","slug":"app-def-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The AppDefId"},{"name":"instanceId","slug":"instance-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The instance Id"}]},"docs/ecom-v1-back-in-stock-notification-request.File":{"name":"File","fqn":"docs/ecom-v1-back-in-stock-notification-request.File","slug":"file","actions":[],"properties":[{"name":"fileName","slug":"file-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invalidate by filename (for media files such as PDFs)"},{"name":"metaSiteId","slug":"meta-site-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"the msid the file is related to"}]},"docs/ecom-v1-back-in-stock-notification-request.Page":{"name":"Page","fqn":"docs/ecom-v1-back-in-stock-notification-request.Page","slug":"page","actions":[],"properties":[{"name":"metaSiteId","slug":"meta-site-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"the msid the page is on"},{"name":"pageId","slug":"page-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Invalidate by Page ID"}]},"docs/ecom-v1-back-in-stock-notification-request.URI":{"name":"URI","fqn":"docs/ecom-v1-back-in-stock-notification-request.URI","slug":"uri","actions":[],"properties":[{"name":"metaSiteId","slug":"meta-site-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"the msid the URI is on"},{"name":"uriPath","slug":"uri-path","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URI path to invalidate (e.g. page/my/path) - without leading/trailing slashes"}]},"docs/ecom-v1-back-in-stock-notification-request.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-back-in-stock-notification-request.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestCreated":{"name":"BackInStockNotificationRequestCreated","fqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestCreated","slug":"back-in-stock-notification-request-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequest"},"description":"Created back in stock notification request."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequest":{"name":"BackInStockNotificationRequest","fqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequest","slug":"back-in-stock-notification-request","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the notification request was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Request ID."},{"name":"autoNotified","slug":"auto-notified","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether a notification was sent automatically.\n\n`autoNotified` is empty when the notification request is created and is not returned until\nthe field has a value. `autoNotified` receives a value when a notification email is sent for this request object.\n\n`autoNotified` sets to `TRUE` if the notification is sent through the site, either automatically or with [Report Items Back In Stock](/report-items-back-in-stock).\nIf the notification email is sent offline but the `status` is updated with [Mark As Notification Sent](/mark-as-notification-sent),\nthen `autoNotified` sets to `FALSE`."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.CatalogReference"},"description":"Catalog and item reference that the notification request is for.\n\nIncludes IDs for the catalog and item it came from, as well as additional, optional information."},{"name":"contactId","slug":"contact-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID for the contact with this `email`.\n\nIf a contact does not already exist with the email address submitted when creating this request, then a new contact is created.\nFor more information about contacts, see the [Contacts API](https://dev.wix.com/docs/rest/api-reference/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Email address to send notification to about item being back in stock."},{"name":"itemUrl","slug":"item-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item URL for this request."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.Status"},"description":"Status of the notification.\n\n`status` is set to `RECEIVED` when the notification request is created.\nThe `status` changes once a notification email is sent for this request object:\n+ When a notification email is sent through the site, either automatically or with [Report Items Back In Stock](/report-items-back-in-stock), then the `status` is briefly set to `PROCESSING` and then set to `NOTIFICATION_SENT` if the email is successul, and `FAILED` if it fails.\n+ When a notification email is sent offline, use [Mark As Notification Sent](/mark-as-notification-sent) to set `status` to `NOTIFICATION_SENT`."}]},"docs/ecom-v1-back-in-stock-notification-request.CatalogReference":{"name":"CatalogReference","fqn":"docs/ecom-v1-back-in-stock-notification-request.CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"docs/ecom-v1-back-in-stock-notification-request.Status":{"name":"Status","fqn":"docs/ecom-v1-back-in-stock-notification-request.Status","slug":"status","actions":[],"enumValues":["FAILED","NOTIFICATION_SENT","PROCESSING","RECEIVED","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestDeleted":{"name":"BackInStockNotificationRequestDeleted","fqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestDeleted","slug":"back-in-stock-notification-request-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestUpdated":{"name":"BackInStockNotificationRequestUpdated","fqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestUpdated","slug":"back-in-stock-notification-request-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequest","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequest"},"description":"Updated back in stock notification request."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-cart.CartCreated":{"name":"CartCreated","fqn":"docs/ecom-v1-cart.CartCreated","slug":"cart-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cart","referenceFqn":"docs/ecom-v1-cart.Cart"},"description":"Created cart."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-cart.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-cart.Cart":{"name":"Cart","fqn":"docs/ecom-v1-cart.Cart","slug":"cart","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the cart was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cart ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the cart was updated."},{"name":"appliedDiscounts","slug":"applied-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CartDiscount","referenceFqn":"docs/ecom-v1-cart.CartDiscount"}},"description":"Cart discounts."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BuyerInfo","referenceFqn":"docs/ecom-v1-cart.BuyerInfo"},"description":"Buyer information."},{"name":"buyerLanguage","slug":"buyer-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected."},{"name":"buyerNote","slug":"buyer-note","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Note left by the buyer/customer."},{"name":"checkoutId","slug":"checkout-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the checkout that originated from this cart."},{"name":"contactInfo","slug":"contact-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-cart.AddressWithContact"},"description":"Contact info."},{"name":"conversionCurrency","slug":"conversion-currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency code used for all the converted prices that are returned.\nFor a site that supports multiple currencies, this is the currency the buyer selected."},{"name":"currency","slug":"currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency used for pricing."},{"name":"lineItems","slug":"line-items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItem","referenceFqn":"docs/ecom-v1-cart.LineItem"}},"description":"Line items."},{"name":"overrideCheckoutUrl","slug":"override-checkout-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"`overrideCheckoutUrl` allows the flexibility to redirect customers to a customized checkout page.\n\nThis field overrides the `checkoutUrl` in a cart or checkout. `checkoutUrl` is used in the [Abandoned Checkout API](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/abandoned-checkout/introduction)\nto send customers back to their checkouts. By default, a `checkoutUrl` generates for a checkout and directs to a\nstandard Wix checkout page. When `overrideCheckoutUrl` has a value, it will replace and set the value of `checkoutUrl`."},{"name":"purchaseFlowId","slug":"purchase-flow-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order."},{"name":"selectedShippingOption","slug":"selected-shipping-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedShippingOption","referenceFqn":"docs/ecom-v1-cart.SelectedShippingOption"},"description":"Selected shipping option."},{"name":"siteLanguage","slug":"site-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Site language in which original values are displayed."},{"name":"taxIncludedInPrices","slug":"tax-included-in-prices","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether tax is included in line item prices."},{"name":"weightUnit","slug":"weight-unit","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WeightUnit","referenceFqn":"docs/ecom-v1-cart.WeightUnit"},"description":"Weight measurement unit - defaults to site's weight unit."}]},"docs/ecom-v1-cart.CartDiscount":{"name":"CartDiscount","fqn":"docs/ecom-v1-cart.CartDiscount","slug":"cart-discount","actions":[],"oneofProperties":{"discountSource":[{"name":"coupon","slug":"coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Coupon","referenceFqn":"docs/ecom-v1-cart.Coupon"},"description":"Coupon details."},{"name":"merchantDiscount","slug":"merchant-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MerchantDiscount","referenceFqn":"docs/ecom-v1-cart.MerchantDiscount"},"description":"Merchant discount."}]},"properties":[]},"docs/ecom-v1-cart.Coupon":{"name":"Coupon","fqn":"docs/ecom-v1-cart.Coupon","slug":"coupon","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."}]},"docs/ecom-v1-cart.MerchantDiscount":{"name":"MerchantDiscount","fqn":"docs/ecom-v1-cart.MerchantDiscount","slug":"merchant-discount","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-cart.MultiCurrencyPrice"},"description":"Discount value."}]},"docs/ecom-v1-cart.MultiCurrencyPrice":{"name":"MultiCurrencyPrice","fqn":"docs/ecom-v1-cart.MultiCurrencyPrice","slug":"multi-currency-price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"convertedAmount","slug":"converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."},{"name":"formattedConvertedAmount","slug":"formatted-converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount formatted with currency symbol."}]},"docs/ecom-v1-cart.BuyerInfo":{"name":"BuyerInfo","fqn":"docs/ecom-v1-cart.BuyerInfo","slug":"buyer-info","actions":[],"oneofProperties":{"id":[{"name":"memberId","slug":"member-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID - if the buyer is a site member."},{"name":"userId","slug":"user-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User ID - if the buyer (or cart owner) is a Wix user."},{"name":"visitorId","slug":"visitor-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID - if the buyer is **not** a site member."}]},"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email address."}]},"docs/ecom-v1-cart.AddressWithContact":{"name":"AddressWithContact","fqn":"docs/ecom-v1-cart.AddressWithContact","slug":"address-with-contact","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-cart.Address"},"description":"Address."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FullAddressContactDetails","referenceFqn":"docs/ecom-v1-cart.FullAddressContactDetails"},"description":"Contact details."}]},"docs/ecom-v1-cart.Address":{"name":"Address","fqn":"docs/ecom-v1-cart.Address","slug":"address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-cart.StreetAddress"},"description":"Street address."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-cart.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-cart.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-cart.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-cart.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"docs/ecom-v1-cart.FullAddressContactDetails":{"name":"FullAddressContactDetails","fqn":"docs/ecom-v1-cart.FullAddressContactDetails","slug":"full-address-contact-details","actions":[],"properties":[{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Company name."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"vatId","slug":"vat-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatId","referenceFqn":"docs/ecom-v1-cart.VatId"},"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed."}]},"docs/ecom-v1-cart.VatId":{"name":"VatId","fqn":"docs/ecom-v1-cart.VatId","slug":"vat-id","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Customer's tax ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatType","referenceFqn":"docs/ecom-v1-cart.VatType"},"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations"}]},"docs/ecom-v1-cart.VatType":{"name":"VatType","fqn":"docs/ecom-v1-cart.VatType","slug":"vat-type","actions":[],"enumValues":["CNPJ","CPF","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-cart.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-cart.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-cart.LineItem":{"name":"LineItem","fqn":"docs/ecom-v1-cart.LineItem","slug":"line-item","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"availability","slug":"availability","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAvailabilityInfo","referenceFqn":"docs/ecom-v1-cart.ItemAvailabilityInfo"},"description":"Item availability details."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-cart.CatalogReference"},"description":"Catalog and item reference. Holds IDs for the item and the catalog it came from, as well as further optional info."},{"name":"consentRequiredPaymentPolicy","slug":"consent-required-payment-policy","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."},{"name":"depositAmount","slug":"deposit-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-cart.MultiCurrencyPrice"},"description":"Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only."},{"name":"descriptionLines","slug":"description-lines","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-cart.DescriptionLine"}},"description":"Line item description lines. Used for displaying the cart, checkout and order."},{"name":"fullPrice","slug":"full-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-cart.MultiCurrencyPrice"},"description":"Item price **before** catalog-defined discount. Defaults to `price` when not provided."},{"name":"image","slug":"image","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image details."},{"name":"itemType","slug":"item-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-cart.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"paymentOption","slug":"payment-option","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentOptionType","referenceFqn":"docs/ecom-v1-cart.PaymentOptionType"},"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.\n+ `MEMBERSHIP_OFFLINE` - Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is 0."},{"name":"physicalProperties","slug":"physical-properties","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-cart.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability."},{"name":"price","slug":"price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-cart.MultiCurrencyPrice"},"description":"Item price **after** catalog-defined discount and line item discounts."},{"name":"priceBeforeDiscounts","slug":"price-before-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-cart.MultiCurrencyPrice"},"description":"Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided."},{"name":"priceDescription","slug":"price-description","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-cart.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-cart.ProductName"},"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`"},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item quantity."},{"name":"rootCatalogItemId","slug":"root-catalog-item-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ in most cases, this field is the same as `catalogReference.catalogItemId`.\n+ Used in membership validation."},{"name":"savePaymentMethod","slug":"save-payment-method","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to save the payment method on the order.\n\nDefault: `false`"},{"name":"selectedMembership","slug":"selected-membership","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedMembership","referenceFqn":"docs/ecom-v1-cart.SelectedMembership"},"description":"Selected membership to be used as payment for this item. Must be used with `lineItem.paymentOption` set to `MEMBERSHIP` or `MEMBERSHIP_OFFLINE`. This field can be empty when `lineItem.paymentOption` is set to `MEMBERSHIP_OFFLINE`."},{"name":"serviceProperties","slug":"service-properties","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ServiceProperties","referenceFqn":"docs/ecom-v1-cart.ServiceProperties"},"description":"Service properties. When relevant, this contains information such as date and number of participants."},{"name":"taxGroupId","slug":"tax-group-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax group ID for this line item."},{"name":"url","slug":"url","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL to the item's page on the site."}]},"docs/ecom-v1-cart.ItemAvailabilityInfo":{"name":"ItemAvailabilityInfo","fqn":"docs/ecom-v1-cart.ItemAvailabilityInfo","slug":"item-availability-info","actions":[],"properties":[{"name":"quantityAvailable","slug":"quantity-available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Quantity available."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAvailabilityStatus","referenceFqn":"docs/ecom-v1-cart.ItemAvailabilityStatus"},"description":"Item availability status.\n+ `\"NOT_FOUND\"`: Item does not exist\n+ `\"NOT_AVAILABLE\"`: Item not in stock\n+ `\"PARTIALLY_AVAILABLE\"`: Available quantity is less than requested"}]},"docs/ecom-v1-cart.ItemAvailabilityStatus":{"name":"ItemAvailabilityStatus","fqn":"docs/ecom-v1-cart.ItemAvailabilityStatus","slug":"item-availability-status","actions":[],"enumValues":["AVAILABLE","NOT_AVAILABLE","NOT_FOUND","PARTIALLY_AVAILABLE"],"properties":[]},"docs/ecom-v1-cart.CatalogOverrideFields":{"name":"CatalogOverrideFields","fqn":"docs/ecom-v1-cart.CatalogOverrideFields","slug":"catalog-override-fields","actions":[],"properties":[{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-cart.DescriptionLine"}},"description":"Line item description lines. Used for displaying the cart, checkout and order."},{"name":"fullPrice","slug":"full-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price **before** discount."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image details."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-cart.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price **after** discounts."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-cart.ProductName"},"description":"Item product name"}]},"docs/ecom-v1-cart.DescriptionLine":{"name":"DescriptionLine","fqn":"docs/ecom-v1-cart.DescriptionLine","slug":"description-line","actions":[],"oneofProperties":{"value":[{"name":"colorInfo","slug":"color-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/ecom-v1-cart.Color"},"description":"Description line color value."},{"name":"plainText","slug":"plain-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PlainTextValue","referenceFqn":"docs/ecom-v1-cart.PlainTextValue"},"description":"Description line plain text value."}],"descriptionLineValue":[]},"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DescriptionLineName","referenceFqn":"docs/ecom-v1-cart.DescriptionLineName"},"description":"Description line name."}]},"docs/ecom-v1-cart.Color":{"name":"Color","fqn":"docs/ecom-v1-cart.Color","slug":"color","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HEX or RGB color code for display."},{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-cart.DescriptionLineType":{"name":"DescriptionLineType","fqn":"docs/ecom-v1-cart.DescriptionLineType","slug":"description-line-type","actions":[],"enumValues":["COLOR","PLAIN_TEXT","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-cart.DescriptionLineName":{"name":"DescriptionLineName","fqn":"docs/ecom-v1-cart.DescriptionLineName","slug":"description-line-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-cart.PlainTextValue":{"name":"PlainTextValue","fqn":"docs/ecom-v1-cart.PlainTextValue","slug":"plain-text-value","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-cart.PhysicalProperties":{"name":"PhysicalProperties","fqn":"docs/ecom-v1-cart.PhysicalProperties","slug":"physical-properties","actions":[],"properties":[{"name":"shippable","slug":"shippable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this line item is shippable."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."}]},"docs/ecom-v1-cart.ProductName":{"name":"ProductName","fqn":"docs/ecom-v1-cart.ProductName","slug":"product-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Item 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).\n\nMin: 1 character.\nMax: 200 characters."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."}]},"docs/ecom-v1-cart.CatalogReference":{"name":"CatalogReference","fqn":"docs/ecom-v1-cart.CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"docs/ecom-v1-cart.Scope":{"name":"Scope","fqn":"docs/ecom-v1-cart.Scope","slug":"scope","actions":[],"properties":[{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Group","referenceFqn":"docs/ecom-v1-cart.Group"},"description":"Coupon scope's applied group (e.g., event or ticket in Wix Events)"},{"name":"namespace","slug":"namespace","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans)"}]},"docs/ecom-v1-cart.Group":{"name":"Group","fqn":"docs/ecom-v1-cart.Group","slug":"group","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID (when the coupon scope is limited to just one item)."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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)."}]},"docs/ecom-v1-cart.SecuredMedia":{"name":"SecuredMedia","fqn":"docs/ecom-v1-cart.SecuredMedia","slug":"secured-media","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media ID in Wix Media Manager."},{"name":"fileName","slug":"file-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original filename."},{"name":"fileType","slug":"file-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileType","referenceFqn":"docs/ecom-v1-cart.FileType"},"description":"File type."}]},"docs/ecom-v1-cart.FileType":{"name":"FileType","fqn":"docs/ecom-v1-cart.FileType","slug":"file-type","actions":[],"enumValues":["SECURE_ARCHIVE","SECURE_DOCUMENT","SECURE_MUSIC","SECURE_PICTURE","SECURE_VIDEO","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-cart.ItemType":{"name":"ItemType","fqn":"docs/ecom-v1-cart.ItemType","slug":"item-type","actions":[],"oneofProperties":{"itemTypeData":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom item type. When none of the preset types are suitable, specifies the custom type."},{"name":"preset","slug":"preset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTypeItemType","referenceFqn":"docs/ecom-v1-cart.ItemTypeItemType"},"description":"Preset item type."}]},"properties":[]},"docs/ecom-v1-cart.ItemTypeItemType":{"name":"ItemTypeItemType","fqn":"docs/ecom-v1-cart.ItemTypeItemType","slug":"item-type-item-type","actions":[],"enumValues":["DIGITAL","GIFT_CARD","PHYSICAL","SERVICE","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-cart.PaymentOptionType":{"name":"PaymentOptionType","fqn":"docs/ecom-v1-cart.PaymentOptionType","slug":"payment-option-type","actions":[],"enumValues":["DEPOSIT_ONLINE","FULL_PAYMENT_OFFLINE","FULL_PAYMENT_ONLINE","MEMBERSHIP","MEMBERSHIP_OFFLINE"],"properties":[]},"docs/ecom-v1-cart.PriceDescription":{"name":"PriceDescription","fqn":"docs/ecom-v1-cart.PriceDescription","slug":"price-description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Price description 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Price description translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-cart.SelectedMembership":{"name":"SelectedMembership","fqn":"docs/ecom-v1-cart.SelectedMembership","slug":"selected-membership","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Membership ID."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing this payment option."}]},"docs/ecom-v1-cart.ServiceProperties":{"name":"ServiceProperties","fqn":"docs/ecom-v1-cart.ServiceProperties","slug":"service-properties","actions":[],"properties":[{"name":"numberOfParticipants","slug":"number-of-participants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."},{"name":"scheduledDate","slug":"scheduled-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"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.\nFor example, the start time of a class."}]},"docs/ecom-v1-cart.SubscriptionOptionInfo":{"name":"SubscriptionOptionInfo","fqn":"docs/ecom-v1-cart.SubscriptionOptionInfo","slug":"subscription-option-info","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Description","referenceFqn":"docs/ecom-v1-cart.Description"},"description":"Subscription option description."},{"name":"subscriptionSettings","slug":"subscription-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionSettings","referenceFqn":"docs/ecom-v1-cart.SubscriptionSettings"},"description":"Subscription option settings."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Title","referenceFqn":"docs/ecom-v1-cart.Title"},"description":"Subscription option title."}]},"docs/ecom-v1-cart.Description":{"name":"Description","fqn":"docs/ecom-v1-cart.Description","slug":"description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option description."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated subscription option description."}]},"docs/ecom-v1-cart.SubscriptionSettings":{"name":"SubscriptionSettings","fqn":"docs/ecom-v1-cart.SubscriptionSettings","slug":"subscription-settings","actions":[],"properties":[{"name":"autoRenewal","slug":"auto-renewal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether subscription is renewed automatically at the end of each period."},{"name":"billingCycles","slug":"billing-cycles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`."},{"name":"frequency","slug":"frequency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionFrequency","referenceFqn":"docs/ecom-v1-cart.SubscriptionFrequency"},"description":"Frequency of recurring payment."}]},"docs/ecom-v1-cart.SubscriptionFrequency":{"name":"SubscriptionFrequency","fqn":"docs/ecom-v1-cart.SubscriptionFrequency","slug":"subscription-frequency","actions":[],"enumValues":["DAY","MONTH","UNDEFINED","WEEK","YEAR"],"properties":[]},"docs/ecom-v1-cart.Title":{"name":"Title","fqn":"docs/ecom-v1-cart.Title","slug":"title","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-cart.SelectedShippingOption":{"name":"SelectedShippingOption","fqn":"docs/ecom-v1-cart.SelectedShippingOption","slug":"selected-shipping-option","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Carrier ID."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Selected shipping option code. For example, \"usps_std_overnight\"."}]},"docs/ecom-v1-cart.WeightUnit":{"name":"WeightUnit","fqn":"docs/ecom-v1-cart.WeightUnit","slug":"weight-unit","actions":[],"enumValues":["KG","LB","UNSPECIFIED_WEIGHT_UNIT"],"properties":[]},"docs/ecom-v1-cart.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-cart.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-cart.CartDeleted":{"name":"CartDeleted","fqn":"docs/ecom-v1-cart.CartDeleted","slug":"cart-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-cart.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-cart.CartUpdated":{"name":"CartUpdated","fqn":"docs/ecom-v1-cart.CartUpdated","slug":"cart-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Cart","referenceFqn":"docs/ecom-v1-cart.Cart"},"description":"Updated cart."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-cart.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout.CheckoutCompleted":{"name":"CheckoutCompleted","fqn":"docs/ecom-v1-checkout.CheckoutCompleted","slug":"checkout-completed","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutMarkedAsCompleted","referenceFqn":"docs/ecom-v1-checkout.CheckoutMarkedAsCompleted"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout.CheckoutMarkedAsCompleted":{"name":"CheckoutMarkedAsCompleted","fqn":"docs/ecom-v1-checkout.CheckoutMarkedAsCompleted","slug":"checkout-marked-as-completed","actions":[],"properties":[{"name":"checkout","slug":"checkout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Checkout","referenceFqn":"docs/ecom-v1-checkout.Checkout"}}]},"docs/ecom-v1-checkout.Checkout":{"name":"Checkout","fqn":"docs/ecom-v1-checkout.Checkout","slug":"checkout","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the checkout was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the checkout was updated."},{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalFee","referenceFqn":"docs/ecom-v1-checkout.AdditionalFee"}},"description":"Additional Fees."},{"name":"appliedDiscounts","slug":"applied-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AppliedDiscount","referenceFqn":"docs/ecom-v1-checkout.AppliedDiscount"}},"description":"Applied discounts."},{"name":"billingInfo","slug":"billing-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-checkout.AddressWithContact"},"description":"Billing information."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BuyerInfo","referenceFqn":"docs/ecom-v1-checkout.BuyerInfo"},"description":"Buyer information."},{"name":"buyerLanguage","slug":"buyer-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected."},{"name":"buyerNote","slug":"buyer-note","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer."},{"name":"calculationErrors","slug":"calculation-errors","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalculationErrors","referenceFqn":"docs/ecom-v1-checkout.CalculationErrors"},"description":"Errors when calculating totals."},{"name":"cartId","slug":"cart-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart."},{"name":"channelType","slug":"channel-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChannelType","referenceFqn":"docs/ecom-v1-checkout.ChannelType"},"description":"Sales channel that submitted the order.\n+ `\"UNSPECIFIED\"`: Unspecified sales channel. This value is not supported.\n+ `\"WEB\"`: A web client.\n+ `\"POS\"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)\n+ `\"EBAY\"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)\n+ `\"AMAZON\"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)\n+ `\"WISH\"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)\n+ `\"WIX_INVOICES\"`: 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)\n+ `\"WIX_APP_STORE\"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)\n+ `\"BACKOFFICE_MERCHANT\"`: Wix merchant backoffice\n+ `\"OTHER_PLATFORM\"`: Other sales platform."},{"name":"completed","slug":"completed","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether an order was successfully created from this checkout.\nFor an order to be successful, it must be successfully paid for (unless the total is 0)."},{"name":"conversionCurrency","slug":"conversion-currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format."},{"name":"createdBy","slug":"created-by","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreatedBy","referenceFqn":"docs/ecom-v1-checkout.CreatedBy"},"description":"ID of the checkout's initiator."},{"name":"currency","slug":"currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The currency used when submitting the order."},{"name":"customContentReference","slug":"custom-content-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomContentReference","referenceFqn":"docs/ecom-v1-checkout.CustomContentReference"},"description":"Customize the content of the checkout page.\n\nIncludes IDs for the app and the component providing the content"},{"name":"customFields","slug":"custom-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomField","referenceFqn":"docs/ecom-v1-checkout.CustomField"}},"description":"Custom fields."},{"name":"customSettings","slug":"custom-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomSettings","referenceFqn":"docs/ecom-v1-checkout.CustomSettings"},"description":"Additional settings for customization of the checkout process.\n\nCustom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout)."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-checkout.ExtendedFields"},"description":"Custom field data for the checkout object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls."},{"name":"externalReference","slug":"external-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExternalReference","referenceFqn":"docs/ecom-v1-checkout.ExternalReference"},"description":"Used for integration and tracking across different platforms.\nContains external system IDs (e.g., app ID, external ID) to link the checkout with other systems."},{"name":"giftCard","slug":"gift-card","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GiftCard","referenceFqn":"docs/ecom-v1-checkout.GiftCard"},"description":"Applied gift card details.\n\n>**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/wix-stores-setting-up-wix-gift-cards)."},{"name":"lineItems","slug":"line-items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItem","referenceFqn":"docs/ecom-v1-checkout.LineItem"}},"description":"Line items.\n\nMax: 300 items"},{"name":"membershipOptions","slug":"membership-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipOptions","referenceFqn":"docs/ecom-v1-checkout.MembershipOptions"},"description":"Memberships to apply when creating the order."},{"name":"payLater","slug":"pay-later","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-checkout.PriceSummary"},"description":"Remaining amount for the order to be fully paid."},{"name":"payNow","slug":"pay-now","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-checkout.PriceSummary"},"description":"Minimal amount to pay in order to place the order."},{"name":"priceSummary","slug":"price-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-checkout.PriceSummary"},"description":"Calculated price summary for the checkout."},{"name":"purchaseFlowId","slug":"purchase-flow-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order."},{"name":"shippingInfo","slug":"shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingInfo","referenceFqn":"docs/ecom-v1-checkout.ShippingInfo"},"description":"Shipping information."},{"name":"siteLanguage","slug":"site-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Site language in which original values are shown."},{"name":"taxIncludedInPrice","slug":"tax-included-in-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether tax is included in line item prices."},{"name":"taxSummary","slug":"tax-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaxSummary","referenceFqn":"docs/ecom-v1-checkout.TaxSummary"},"description":"Tax summary."},{"name":"violations","slug":"violations","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Violation","referenceFqn":"docs/ecom-v1-checkout.Violation"}},"description":"List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction)."},{"name":"weightUnit","slug":"weight-unit","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WeightUnit","referenceFqn":"docs/ecom-v1-checkout.WeightUnit"},"description":"Weight measurement unit - defaults to site's weight unit."}]},"docs/ecom-v1-checkout.AdditionalFee":{"name":"AdditionalFee","fqn":"docs/ecom-v1-checkout.AdditionalFee","slug":"additional-fee","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee's unique code (or ID) for future processing."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Optional - Line items associated with this additional fee.\nIf no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated additional fee's name."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Additional fee's price."},{"name":"priceAfterTax","slug":"price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Additional fee's price after tax."},{"name":"priceBeforeTax","slug":"price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Additional fee's price before tax."},{"name":"providerAppId","slug":"provider-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Provider's app id."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-checkout.ItemTaxFullDetails"},"description":"Tax details."}]},"docs/ecom-v1-checkout.MultiCurrencyPrice":{"name":"MultiCurrencyPrice","fqn":"docs/ecom-v1-checkout.MultiCurrencyPrice","slug":"multi-currency-price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"convertedAmount","slug":"converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."},{"name":"formattedConvertedAmount","slug":"formatted-converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount formatted with currency symbol."}]},"docs/ecom-v1-checkout.ItemTaxFullDetails":{"name":"ItemTaxFullDetails","fqn":"docs/ecom-v1-checkout.ItemTaxFullDetails","slug":"item-tax-full-details","actions":[],"properties":[{"name":"rateBreakdown","slug":"rate-breakdown","isReadOnly":true,"isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TaxRateBreakdown","referenceFqn":"docs/ecom-v1-checkout.TaxRateBreakdown"}},"description":"If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead."},{"name":"taxRate","slug":"tax-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate %, as a decimal point between 0 and 1."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Amount for which tax is calculated."},{"name":"totalTax","slug":"total-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Calculated tax, based on `taxable_amount` and `tax_rate`."}]},"docs/ecom-v1-checkout.TaxRateBreakdown":{"name":"TaxRateBreakdown","fqn":"docs/ecom-v1-checkout.TaxRateBreakdown","slug":"tax-rate-breakdown","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of tax against which the calculation was performed."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rate at which this tax detail was calculated."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Amount of tax for this tax detail."}]},"docs/ecom-v1-checkout.TaxBreakdown":{"name":"TaxBreakdown","fqn":"docs/ecom-v1-checkout.TaxBreakdown","slug":"tax-breakdown","actions":[],"properties":[{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\"."},{"name":"jurisdictionType","slug":"jurisdiction-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-checkout.JurisdictionType"},"description":"The type of the jurisdiction in which this tax detail applies."},{"name":"nonTaxableAmount","slug":"non-taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"The amount of this line item price that was considered nontaxable. (Decimal value)"},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)"},{"name":"taxAmount","slug":"tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"The amount of tax estimated for this line item. (Decimal value)"},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\nThis name should be explicit enough to allow the merchant to understand what tax was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"The taxable amount of this line item."}]},"docs/ecom-v1-checkout.JurisdictionType":{"name":"JurisdictionType","fqn":"docs/ecom-v1-checkout.JurisdictionType","slug":"jurisdiction-type","actions":[],"enumValues":["CITY","COUNTRY","COUNTY","SPECIAL","STATE","UNDEFINED"],"properties":[]},"docs/ecom-v1-checkout.AppliedDiscount":{"name":"AppliedDiscount","fqn":"docs/ecom-v1-checkout.AppliedDiscount","slug":"applied-discount","actions":[],"oneofProperties":{"discountSource":[{"name":"coupon","slug":"coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Coupon","referenceFqn":"docs/ecom-v1-checkout.Coupon"},"description":"Coupon details."},{"name":"discountRule","slug":"discount-rule","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRule","referenceFqn":"docs/ecom-v1-checkout.DiscountRule"},"description":"Discount rule"},{"name":"merchantDiscount","slug":"merchant-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MerchantDiscount","referenceFqn":"docs/ecom-v1-checkout.MerchantDiscount"},"description":"Merchant discount."}]},"properties":[{"name":"discountType","slug":"discount-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountType","referenceFqn":"docs/ecom-v1-checkout.DiscountType"},"description":"Discount type."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"IDs of line items the discount applies to.","replacedBy":"line_items_discounts","targetRemovalDate":"2024-06-01"},"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of line items the discount applies to."}]},"docs/ecom-v1-checkout.Coupon":{"name":"Coupon","fqn":"docs/ecom-v1-checkout.Coupon","slug":"coupon","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Coupon value."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"docs/ecom-v1-checkout.DiscountRule":{"name":"DiscountRule","fqn":"docs/ecom-v1-checkout.DiscountRule","slug":"discount-rule","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rule ID"},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Discount value."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleName","referenceFqn":"docs/ecom-v1-checkout.DiscountRuleName"},"description":"Discount rule name"}]},"docs/ecom-v1-checkout.DiscountRuleName":{"name":"DiscountRuleName","fqn":"docs/ecom-v1-checkout.DiscountRuleName","slug":"discount-rule-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original discount rule name (in site's default language)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated discount rule name according to buyer language. Defaults to `original` when not provided."}]},"docs/ecom-v1-checkout.DiscountType":{"name":"DiscountType","fqn":"docs/ecom-v1-checkout.DiscountType","slug":"discount-type","actions":[],"enumValues":["GLOBAL","SHIPPING","SPECIFIC_ITEMS"],"properties":[]},"docs/ecom-v1-checkout.LineItemDiscount":{"name":"LineItemDiscount","fqn":"docs/ecom-v1-checkout.LineItemDiscount","slug":"line-item-discount","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of line item the discount applies to."},{"name":"totalDiscountAmount","slug":"total-discount-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Discount value."}]},"docs/ecom-v1-checkout.MerchantDiscount":{"name":"MerchantDiscount","fqn":"docs/ecom-v1-checkout.MerchantDiscount","slug":"merchant-discount","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Discount value."},{"name":"percentage","slug":"percentage","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Discount Percentage. Will be calculated from items price before other discounts."}]},"docs/ecom-v1-checkout.AddressWithContact":{"name":"AddressWithContact","fqn":"docs/ecom-v1-checkout.AddressWithContact","slug":"address-with-contact","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApiAddress","referenceFqn":"docs/ecom-v1-checkout.ApiAddress"},"description":"Address."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FullAddressContactDetails","referenceFqn":"docs/ecom-v1-checkout.FullAddressContactDetails"},"description":"Contact details."}]},"docs/ecom-v1-checkout.ApiAddress":{"name":"ApiAddress","fqn":"docs/ecom-v1-checkout.ApiAddress","slug":"api-address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-checkout.StreetAddress"},"description":"Street address."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-checkout.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-checkout.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-checkout.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-checkout.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"docs/ecom-v1-checkout.FullAddressContactDetails":{"name":"FullAddressContactDetails","fqn":"docs/ecom-v1-checkout.FullAddressContactDetails","slug":"full-address-contact-details","actions":[],"properties":[{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Company name."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"vatId","slug":"vat-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonVatId","referenceFqn":"docs/ecom-v1-checkout.CommonVatId"},"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed."}]},"docs/ecom-v1-checkout.CommonVatId":{"name":"CommonVatId","fqn":"docs/ecom-v1-checkout.CommonVatId","slug":"common-vat-id","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Customer's tax ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonVatType","referenceFqn":"docs/ecom-v1-checkout.CommonVatType"},"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations"}]},"docs/ecom-v1-checkout.CommonVatType":{"name":"CommonVatType","fqn":"docs/ecom-v1-checkout.CommonVatType","slug":"common-vat-type","actions":[],"enumValues":["CNPJ","CPF","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-checkout.BuyerInfo":{"name":"BuyerInfo","fqn":"docs/ecom-v1-checkout.BuyerInfo","slug":"buyer-info","actions":[],"oneofProperties":{"id":[{"name":"memberId","slug":"member-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID (if site visitor is a site member)."},{"name":"visitorId","slug":"visitor-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID (if site visitor is **not** a member)."}]},"properties":[{"name":"contactId","slug":"contact-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email address."}]},"docs/ecom-v1-checkout.CalculationErrors":{"name":"CalculationErrors","fqn":"docs/ecom-v1-checkout.CalculationErrors","slug":"calculation-errors","actions":[],"oneofProperties":{"shippingCalculationError":[{"name":"carrierErrors","slug":"carrier-errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CarrierErrors","referenceFqn":"docs/ecom-v1-checkout.CarrierErrors"},"description":"Carrier errors."},{"name":"generalShippingCalculationError","slug":"general-shipping-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"General shipping calculation error."}]},"properties":[{"name":"couponCalculationError","slug":"coupon-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"Coupon calculation error."},{"name":"discountsCalculationError","slug":"discounts-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"Discount Rule calculation error."},{"name":"giftCardCalculationError","slug":"gift-card-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"Gift card calculation error."},{"name":"membershipError","slug":"membership-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"Membership payment methods calculation errors\nFor example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid"},{"name":"orderValidationErrors","slug":"order-validation-errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"docs/ecom-v1-checkout.ApplicationError"}},"description":"Order validation errors."},{"name":"taxCalculationError","slug":"tax-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"Tax calculation error."}]},"docs/ecom-v1-checkout.CarrierErrors":{"name":"CarrierErrors","fqn":"docs/ecom-v1-checkout.CarrierErrors","slug":"carrier-errors","actions":[],"properties":[{"name":"errors","slug":"errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CarrierError","referenceFqn":"docs/ecom-v1-checkout.CarrierError"}},"description":"Carrier errors."}]},"docs/ecom-v1-checkout.CarrierError":{"name":"CarrierError","fqn":"docs/ecom-v1-checkout.CarrierError","slug":"carrier-error","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Carrier ID."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout.Details"},"description":"Error details."}]},"docs/ecom-v1-checkout.Details":{"name":"Details","fqn":"docs/ecom-v1-checkout.Details","slug":"details","actions":[],"oneofProperties":{"kind":[{"name":"applicationError","slug":"application-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"docs/ecom-v1-checkout.ApplicationError"}},{"name":"systemError","slug":"system-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SystemError","referenceFqn":"docs/ecom-v1-checkout.SystemError"}},{"name":"validationError","slug":"validation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValidationError","referenceFqn":"docs/ecom-v1-checkout.ValidationError"}}]},"properties":[{"name":"tracing","slug":"tracing","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"string"}},"description":"deprecated in API's - to enable migration from rendering arbitrary tracing to rest response"}]},"docs/ecom-v1-checkout.ApplicationError":{"name":"ApplicationError","fqn":"docs/ecom-v1-checkout.ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"docs/ecom-v1-checkout.SystemError":{"name":"SystemError","fqn":"docs/ecom-v1-checkout.SystemError","slug":"system-error","actions":[],"properties":[{"name":"errorCode","slug":"error-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."}]},"docs/ecom-v1-checkout.ValidationError":{"name":"ValidationError","fqn":"docs/ecom-v1-checkout.ValidationError","slug":"validation-error","actions":[],"properties":[{"name":"fieldViolations","slug":"field-violations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FieldViolation","referenceFqn":"docs/ecom-v1-checkout.FieldViolation"}}}]},"docs/ecom-v1-checkout.FieldViolation":{"name":"FieldViolation","fqn":"docs/ecom-v1-checkout.FieldViolation","slug":"field-violation","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"field","slug":"field","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"ruleName","slug":"rule-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"applicable when violated_rule=OTHER"},{"name":"violatedRule","slug":"violated-rule","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RuleType","referenceFqn":"docs/ecom-v1-checkout.RuleType"}}]},"docs/ecom-v1-checkout.RuleType":{"name":"RuleType","fqn":"docs/ecom-v1-checkout.RuleType","slug":"rule-type","actions":[],"enumValues":["DECIMAL_GT","DECIMAL_GTE","DECIMAL_LT","DECIMAL_LTE","DECIMAL_MAX_SCALE","FIELD_NOT_ALLOWED","FORMAT","INVALID_ENUM_VALUE","MAX","MAX_LENGTH","MAX_SIZE","MIN","MIN_LENGTH","MIN_SIZE","ONE_OF_ALIGNMENT","OTHER","REQUIRED_FIELD","VALIDATION"],"properties":[]},"docs/ecom-v1-checkout.ChannelType":{"name":"ChannelType","fqn":"docs/ecom-v1-checkout.ChannelType","slug":"channel-type","actions":[],"enumValues":["AMAZON","BACKOFFICE_MERCHANT","CLASS_PASS","EBAY","ETSY","FACEBOOK","FAIRE_COM","GLOBAL_E","OTHER_PLATFORM","POS","TIKTOK","UNSPECIFIED","WEB","WISH","WIX_APP_STORE","WIX_INVOICES"],"properties":[]},"docs/ecom-v1-checkout.ConversionInfo":{"name":"ConversionInfo","fqn":"docs/ecom-v1-checkout.ConversionInfo","slug":"conversion-info","actions":[],"properties":[{"name":"conversionRate","slug":"conversion-rate","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate used when converting from the site currency to the checkout currency."},{"name":"siteCurrency","slug":"site-currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The site currency."}]},"docs/ecom-v1-checkout.CreatedBy":{"name":"CreatedBy","fqn":"docs/ecom-v1-checkout.CreatedBy","slug":"created-by","actions":[],"oneofProperties":{"id":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID - when the order was created by an external application or Wix service."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID - when the order was created by a **logged in** site visitor."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User ID - when the order was created by a Wix user on behalf of a buyer.\nFor example, via POS (point of service)."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID - when the order was created by a site visitor that was **not** logged in."}]},"properties":[]},"docs/ecom-v1-checkout.CustomContentReference":{"name":"CustomContentReference","fqn":"docs/ecom-v1-checkout.CustomContentReference","slug":"custom-content-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps)."},{"name":"componentId","slug":"component-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps)."}]},"docs/ecom-v1-checkout.CustomField":{"name":"CustomField","fqn":"docs/ecom-v1-checkout.CustomField","slug":"custom-field","actions":[],"properties":[{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom field title."},{"name":"translatedTitle","slug":"translated-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated custom field title."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Custom field value."}]},"docs/ecom-v1-checkout.CustomSettings":{"name":"CustomSettings","fqn":"docs/ecom-v1-checkout.CustomSettings","slug":"custom-settings","actions":[],"properties":[{"name":"disabledManualPayment","slug":"disabled-manual-payment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"},{"name":"disabledPolicyAgreementCheckbox","slug":"disabled-policy-agreement-checkbox","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"},{"name":"lockCouponCode","slug":"lock-coupon-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to restrict the option to add or remove a coupon code on the checkout page.\n\nDefault: `false`"},{"name":"lockGiftCard","slug":"lock-gift-card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to restrict the option to add or remove a gift card on the checkout page.\n\nDefault: `false`"}]},"docs/ecom-v1-checkout.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-checkout.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-checkout.ExternalReference":{"name":"ExternalReference","fqn":"docs/ecom-v1-checkout.ExternalReference","slug":"external-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that associated with the purchase flow."},{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reference to an external system ID, used to link the purchase flow to a specific ID in another system"}]},"docs/ecom-v1-checkout.GiftCard":{"name":"GiftCard","fqn":"docs/ecom-v1-checkout.GiftCard","slug":"gift-card","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Gift Card ID."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Gift card value."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID of the gift card provider."},{"name":"obfuscatedCode","slug":"obfuscated-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gift card obfuscated code."}]},"docs/ecom-v1-checkout.LineItem":{"name":"LineItem","fqn":"docs/ecom-v1-checkout.LineItem","slug":"line-item","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"availability","slug":"availability","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAvailabilityInfo","referenceFqn":"docs/ecom-v1-checkout.ItemAvailabilityInfo"},"description":"Item availability details."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-checkout.CatalogReference"},"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info."},{"name":"consentRequiredPaymentPolicy","slug":"consent-required-payment-policy","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."},{"name":"depositAmount","slug":"deposit-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only."},{"name":"descriptionLines","slug":"description-lines","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-checkout.DescriptionLine"}},"description":"Line item description lines. Used for display purposes for the cart, checkout and order."},{"name":"discount","slug":"discount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Discount for this line item's entire quantity."},{"name":"fullPrice","slug":"full-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Item price **before** catalog-defined discount. Defaults to `price` when not provided."},{"name":"itemType","slug":"item-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-checkout.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"lineItemPrice","slug":"line-item-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total line item price **after** catalog-defined discount and line item discounts."},{"name":"media","slug":"media","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image details."},{"name":"paymentOption","slug":"payment-option","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentOptionType","referenceFqn":"docs/ecom-v1-checkout.PaymentOptionType"},"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.\n+ `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.\n+ `MEMBERSHIP_OFFLINE`: Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is `0`."},{"name":"physicalProperties","slug":"physical-properties","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-checkout.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability."},{"name":"price","slug":"price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Item price **after** catalog-defined discount and line item discounts."},{"name":"priceBeforeDiscounts","slug":"price-before-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided."},{"name":"priceDescription","slug":"price-description","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-checkout.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-checkout.ProductName"},"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`"},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item quantity.\n\nMin: `\"1\"`\nMax: `\"100000\"`"},{"name":"rootCatalogItemId","slug":"root-catalog-item-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field has the same value as `catalogReference.catalogItemId`.\n+ Used in membership validation."},{"name":"savePaymentMethod","slug":"save-payment-method","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to save the payment method on the order.\n\nDefault: `false`"},{"name":"serviceProperties","slug":"service-properties","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ServiceProperties","referenceFqn":"docs/ecom-v1-checkout.ServiceProperties"},"description":"Service properties. When relevant, this contains information such as date and number of participants."},{"name":"taxDetails","slug":"tax-details","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-checkout.ItemTaxFullDetails"},"description":"Tax details for this line item."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total price after all discounts and tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total price after discounts, and before tax."},{"name":"url","slug":"url","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL to the item's page on the site."}]},"docs/ecom-v1-checkout.ItemAvailabilityInfo":{"name":"ItemAvailabilityInfo","fqn":"docs/ecom-v1-checkout.ItemAvailabilityInfo","slug":"item-availability-info","actions":[],"properties":[{"name":"quantityAvailable","slug":"quantity-available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Quantity available."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAvailabilityStatus","referenceFqn":"docs/ecom-v1-checkout.ItemAvailabilityStatus"},"description":"Item availability status.\n+ `\"NOT_FOUND\"`: Item does not exist\n+ `\"NOT_AVAILABLE\"`: Item not in stock\n+ `\"PARTIALLY_AVAILABLE\"`: Available quantity is less than requested"}]},"docs/ecom-v1-checkout.ItemAvailabilityStatus":{"name":"ItemAvailabilityStatus","fqn":"docs/ecom-v1-checkout.ItemAvailabilityStatus","slug":"item-availability-status","actions":[],"enumValues":["AVAILABLE","NOT_AVAILABLE","NOT_FOUND","PARTIALLY_AVAILABLE"],"properties":[]},"docs/ecom-v1-checkout.CatalogOverrideFields":{"name":"CatalogOverrideFields","fqn":"docs/ecom-v1-checkout.CatalogOverrideFields","slug":"catalog-override-fields","actions":[],"properties":[{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-checkout.DescriptionLine"}},"description":"Line item description lines. Used for displaying the cart, checkout and order."},{"name":"fullPrice","slug":"full-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price **before** discount."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image details."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-checkout.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price **after** discounts."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-checkout.ProductName"},"description":"Item product name"}]},"docs/ecom-v1-checkout.DescriptionLine":{"name":"DescriptionLine","fqn":"docs/ecom-v1-checkout.DescriptionLine","slug":"description-line","actions":[],"oneofProperties":{"value":[{"name":"colorInfo","slug":"color-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/ecom-v1-checkout.Color"},"description":"Description line color value."},{"name":"plainText","slug":"plain-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PlainTextValue","referenceFqn":"docs/ecom-v1-checkout.PlainTextValue"},"description":"Description line plain text value."}],"descriptionLineValue":[]},"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DescriptionLineName","referenceFqn":"docs/ecom-v1-checkout.DescriptionLineName"},"description":"Description line name."}]},"docs/ecom-v1-checkout.Color":{"name":"Color","fqn":"docs/ecom-v1-checkout.Color","slug":"color","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HEX or RGB color code for display."},{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout.DescriptionLineType":{"name":"DescriptionLineType","fqn":"docs/ecom-v1-checkout.DescriptionLineType","slug":"description-line-type","actions":[],"enumValues":["COLOR","PLAIN_TEXT","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-checkout.DescriptionLineName":{"name":"DescriptionLineName","fqn":"docs/ecom-v1-checkout.DescriptionLineName","slug":"description-line-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout.PlainTextValue":{"name":"PlainTextValue","fqn":"docs/ecom-v1-checkout.PlainTextValue","slug":"plain-text-value","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout.PhysicalProperties":{"name":"PhysicalProperties","fqn":"docs/ecom-v1-checkout.PhysicalProperties","slug":"physical-properties","actions":[],"properties":[{"name":"shippable","slug":"shippable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this line item is shippable."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."}]},"docs/ecom-v1-checkout.ProductName":{"name":"ProductName","fqn":"docs/ecom-v1-checkout.ProductName","slug":"product-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Item 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).\n\nMin: 1 character.\nMax: 200 characters."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout.CatalogReference":{"name":"CatalogReference","fqn":"docs/ecom-v1-checkout.CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"docs/ecom-v1-checkout.Scope":{"name":"Scope","fqn":"docs/ecom-v1-checkout.Scope","slug":"scope","actions":[],"properties":[{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Group","referenceFqn":"docs/ecom-v1-checkout.Group"},"description":"Coupon scope's applied group (e.g., event or ticket in Wix Events)"},{"name":"namespace","slug":"namespace","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans)"}]},"docs/ecom-v1-checkout.Group":{"name":"Group","fqn":"docs/ecom-v1-checkout.Group","slug":"group","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID (when the coupon scope is limited to just one item)."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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)."}]},"docs/ecom-v1-checkout.SecuredMedia":{"name":"SecuredMedia","fqn":"docs/ecom-v1-checkout.SecuredMedia","slug":"secured-media","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media ID in Wix Media Manager."},{"name":"fileName","slug":"file-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original filename."},{"name":"fileType","slug":"file-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileType","referenceFqn":"docs/ecom-v1-checkout.FileType"},"description":"File type."}]},"docs/ecom-v1-checkout.FileType":{"name":"FileType","fqn":"docs/ecom-v1-checkout.FileType","slug":"file-type","actions":[],"enumValues":["SECURE_ARCHIVE","SECURE_DOCUMENT","SECURE_MUSIC","SECURE_PICTURE","SECURE_VIDEO","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-checkout.ItemType":{"name":"ItemType","fqn":"docs/ecom-v1-checkout.ItemType","slug":"item-type","actions":[],"oneofProperties":{"itemTypeData":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom item type. When none of the preset types are suitable, specifies the custom type."},{"name":"preset","slug":"preset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTypeItemType","referenceFqn":"docs/ecom-v1-checkout.ItemTypeItemType"},"description":"Preset item type."}]},"properties":[]},"docs/ecom-v1-checkout.ItemTypeItemType":{"name":"ItemTypeItemType","fqn":"docs/ecom-v1-checkout.ItemTypeItemType","slug":"item-type-item-type","actions":[],"enumValues":["DIGITAL","GIFT_CARD","PHYSICAL","SERVICE","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-checkout.PaymentOptionType":{"name":"PaymentOptionType","fqn":"docs/ecom-v1-checkout.PaymentOptionType","slug":"payment-option-type","actions":[],"enumValues":["DEPOSIT_ONLINE","FULL_PAYMENT_OFFLINE","FULL_PAYMENT_ONLINE","MEMBERSHIP","MEMBERSHIP_OFFLINE"],"properties":[]},"docs/ecom-v1-checkout.PriceDescription":{"name":"PriceDescription","fqn":"docs/ecom-v1-checkout.PriceDescription","slug":"price-description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Price description 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Price description translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout.ServiceProperties":{"name":"ServiceProperties","fqn":"docs/ecom-v1-checkout.ServiceProperties","slug":"service-properties","actions":[],"properties":[{"name":"numberOfParticipants","slug":"number-of-participants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."},{"name":"scheduledDate","slug":"scheduled-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"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.\nFor example, the start time of a class."}]},"docs/ecom-v1-checkout.SubscriptionOptionInfo":{"name":"SubscriptionOptionInfo","fqn":"docs/ecom-v1-checkout.SubscriptionOptionInfo","slug":"subscription-option-info","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Description","referenceFqn":"docs/ecom-v1-checkout.Description"},"description":"Subscription option description."},{"name":"subscriptionSettings","slug":"subscription-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionSettings","referenceFqn":"docs/ecom-v1-checkout.SubscriptionSettings"},"description":"Subscription option settings."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Title","referenceFqn":"docs/ecom-v1-checkout.Title"},"description":"Subscription option title."}]},"docs/ecom-v1-checkout.Description":{"name":"Description","fqn":"docs/ecom-v1-checkout.Description","slug":"description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option description."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated subscription option description."}]},"docs/ecom-v1-checkout.SubscriptionSettings":{"name":"SubscriptionSettings","fqn":"docs/ecom-v1-checkout.SubscriptionSettings","slug":"subscription-settings","actions":[],"properties":[{"name":"autoRenewal","slug":"auto-renewal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether subscription is renewed automatically at the end of each period."},{"name":"billingCycles","slug":"billing-cycles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`."},{"name":"frequency","slug":"frequency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionFrequency","referenceFqn":"docs/ecom-v1-checkout.SubscriptionFrequency"},"description":"Frequency of recurring payment."}]},"docs/ecom-v1-checkout.SubscriptionFrequency":{"name":"SubscriptionFrequency","fqn":"docs/ecom-v1-checkout.SubscriptionFrequency","slug":"subscription-frequency","actions":[],"enumValues":["DAY","MONTH","UNDEFINED","WEEK","YEAR"],"properties":[]},"docs/ecom-v1-checkout.Title":{"name":"Title","fqn":"docs/ecom-v1-checkout.Title","slug":"title","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout.MembershipOptions":{"name":"MembershipOptions","fqn":"docs/ecom-v1-checkout.MembershipOptions","slug":"membership-options","actions":[],"properties":[{"name":"eligibleMemberships","slug":"eligible-memberships","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Membership","referenceFqn":"docs/ecom-v1-checkout.Membership"}},"description":"Reserved for internal use."},{"name":"invalidMemberships","slug":"invalid-memberships","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InvalidMembership","referenceFqn":"docs/ecom-v1-checkout.InvalidMembership"}},"description":"Reserved for internal use."},{"name":"selectedMemberships","slug":"selected-memberships","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedMemberships","referenceFqn":"docs/ecom-v1-checkout.SelectedMemberships"},"description":"Selected membership to apply to this checkout."}]},"docs/ecom-v1-checkout.Membership":{"name":"Membership","fqn":"docs/ecom-v1-checkout.Membership","slug":"membership","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Membership ID."},{"name":"additionalData","slug":"additional-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional data about this membership."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the application providing this payment option."},{"name":"credits","slug":"credits","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipPaymentCredits","referenceFqn":"docs/ecom-v1-checkout.MembershipPaymentCredits"},"description":"Optional - For a membership that has limited credits, information about credit usage."},{"name":"expirationDate","slug":"expiration-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Optional - TMembership expiry date."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Line item IDs which are \"paid\" for by this membership."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipName","referenceFqn":"docs/ecom-v1-checkout.MembershipName"},"description":"The name of this membership."}]},"docs/ecom-v1-checkout.MembershipPaymentCredits":{"name":"MembershipPaymentCredits","fqn":"docs/ecom-v1-checkout.MembershipPaymentCredits","slug":"membership-payment-credits","actions":[],"properties":[{"name":"remaining","slug":"remaining","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"How much credit remained for this membership"},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"How much credit this membership has in total"}]},"docs/ecom-v1-checkout.MembershipName":{"name":"MembershipName","fqn":"docs/ecom-v1-checkout.MembershipName","slug":"membership-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of this membership"},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - Translated name of this membership. Defaults to `original` when not provided."}]},"docs/ecom-v1-checkout.InvalidMembership":{"name":"InvalidMembership","fqn":"docs/ecom-v1-checkout.InvalidMembership","slug":"invalid-membership","actions":[],"properties":[{"name":"membership","slug":"membership","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Membership","referenceFqn":"docs/ecom-v1-checkout.Membership"},"description":"Membership details."},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reason why this membership is invalid and cannot be used."}]},"docs/ecom-v1-checkout.SelectedMemberships":{"name":"SelectedMemberships","fqn":"docs/ecom-v1-checkout.SelectedMemberships","slug":"selected-memberships","actions":[],"properties":[{"name":"memberships","slug":"memberships","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SelectedMembership","referenceFqn":"docs/ecom-v1-checkout.SelectedMembership"}},"description":"Selected memberships."}]},"docs/ecom-v1-checkout.SelectedMembership":{"name":"SelectedMembership","fqn":"docs/ecom-v1-checkout.SelectedMembership","slug":"selected-membership","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Membership ID."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing this payment option."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the line items this membership applies to."}]},"docs/ecom-v1-checkout.PriceSummary":{"name":"PriceSummary","fqn":"docs/ecom-v1-checkout.PriceSummary","slug":"price-summary","actions":[],"properties":[{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total additional fees price before tax."},{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total calculated discount value."},{"name":"shipping","slug":"shipping","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total shipping price, before discounts and before tax."},{"name":"subtotal","slug":"subtotal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Subtotal of all line items, before discounts and before tax."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total tax."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total price after discounts, gift cards, and tax."}]},"docs/ecom-v1-checkout.ShippingInfo":{"name":"ShippingInfo","fqn":"docs/ecom-v1-checkout.ShippingInfo","slug":"shipping-info","actions":[],"properties":[{"name":"carrierServiceOptions","slug":"carrier-service-options","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CarrierServiceOption","referenceFqn":"docs/ecom-v1-checkout.CarrierServiceOption"}},"description":"All carrier options for this shipping rule."},{"name":"region","slug":"region","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingRegion","referenceFqn":"docs/ecom-v1-checkout.ShippingRegion"},"description":"Shipping region. Based on the address provided."},{"name":"selectedCarrierServiceOption","slug":"selected-carrier-service-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedCarrierServiceOption","referenceFqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOption"},"description":"Selected option out of the options allowed for the `region`."},{"name":"shippingDestination","slug":"shipping-destination","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-checkout.AddressWithContact"},"description":"Shipping address and contact details."}]},"docs/ecom-v1-checkout.CarrierServiceOption":{"name":"CarrierServiceOption","fqn":"docs/ecom-v1-checkout.CarrierServiceOption","slug":"carrier-service-option","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Carrier ID."},{"name":"shippingOptions","slug":"shipping-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ShippingOption","referenceFqn":"docs/ecom-v1-checkout.ShippingOption"}},"description":"Shipping options offered by this carrier for this request."}]},"docs/ecom-v1-checkout.ShippingOption":{"name":"ShippingOption","fqn":"docs/ecom-v1-checkout.ShippingOption","slug":"shipping-option","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique code of provided shipping option like \"usps_std_overnight\".\nFor legacy calculators this would be the UUID of the option."},{"name":"cost","slug":"cost","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingPrice","referenceFqn":"docs/ecom-v1-checkout.ShippingPrice"},"description":"Sipping price information."},{"name":"logistics","slug":"logistics","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryLogistics","referenceFqn":"docs/ecom-v1-checkout.DeliveryLogistics"},"description":"Delivery logistics."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\nFor example, \"Standard\" or \"First-Class Package International\"."}]},"docs/ecom-v1-checkout.ShippingPrice":{"name":"ShippingPrice","fqn":"docs/ecom-v1-checkout.ShippingPrice","slug":"shipping-price","actions":[],"properties":[{"name":"otherCharges","slug":"other-charges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OtherCharge","referenceFqn":"docs/ecom-v1-checkout.OtherCharge"}},"description":"Other costs such as insurance, handling & packaging for fragile items, etc."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Shipping price."}]},"docs/ecom-v1-checkout.OtherCharge":{"name":"OtherCharge","fqn":"docs/ecom-v1-checkout.OtherCharge","slug":"other-charge","actions":[],"properties":[{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Price of added cost."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChargeType","referenceFqn":"docs/ecom-v1-checkout.ChargeType"},"description":"Type of additional cost."}]},"docs/ecom-v1-checkout.ChargeType":{"name":"ChargeType","fqn":"docs/ecom-v1-checkout.ChargeType","slug":"charge-type","actions":[],"enumValues":["HANDLING_FEE","INSURANCE"],"properties":[]},"docs/ecom-v1-checkout.DeliveryLogistics":{"name":"DeliveryLogistics","fqn":"docs/ecom-v1-checkout.DeliveryLogistics","slug":"delivery-logistics","actions":[],"properties":[{"name":"deliveryTime","slug":"delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Expected delivery time, in free text. For example, \"3-5 business days\"."},{"name":"instructions","slug":"instructions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\"."},{"name":"pickupDetails","slug":"pickup-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupDetails","referenceFqn":"docs/ecom-v1-checkout.PickupDetails"},"description":"Pickup details."}]},"docs/ecom-v1-checkout.DeliveryTimeSlot":{"name":"DeliveryTimeSlot","fqn":"docs/ecom-v1-checkout.DeliveryTimeSlot","slug":"delivery-time-slot","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"starting time of the delivery time slot"},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"ending time of the delivery time slot"}]},"docs/ecom-v1-checkout.PickupDetails":{"name":"PickupDetails","fqn":"docs/ecom-v1-checkout.PickupDetails","slug":"pickup-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApiAddress","referenceFqn":"docs/ecom-v1-checkout.ApiAddress"},"description":"Pickup address."},{"name":"businessLocation","slug":"business-location","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the pickup address is that of a business - this may effect tax calculation."},{"name":"pickupMethod","slug":"pickup-method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupMethod","referenceFqn":"docs/ecom-v1-checkout.PickupMethod"},"description":"Pickup method"}]},"docs/ecom-v1-checkout.PickupMethod":{"name":"PickupMethod","fqn":"docs/ecom-v1-checkout.PickupMethod","slug":"pickup-method","actions":[],"enumValues":["PICKUP_POINT","STORE_PICKUP","UNKNOWN_METHOD"],"properties":[]},"docs/ecom-v1-checkout.ShippingRegion":{"name":"ShippingRegion","fqn":"docs/ecom-v1-checkout.ShippingRegion","slug":"shipping-region","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping region ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping region name."}]},"docs/ecom-v1-checkout.SelectedCarrierServiceOption":{"name":"SelectedCarrierServiceOption","fqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOption","slug":"selected-carrier-service-option","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"This carrier's unique ID"},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique identifier of selected option. For example, \"usps_std_overnight\"."},{"name":"cost","slug":"cost","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedCarrierServiceOptionPrices","referenceFqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOptionPrices"},"description":"Shipping costs."},{"name":"logistics","slug":"logistics","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryLogistics","referenceFqn":"docs/ecom-v1-checkout.DeliveryLogistics"},"description":"Delivery logistics."},{"name":"otherCharges","slug":"other-charges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SelectedCarrierServiceOptionOtherCharge","referenceFqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOptionOtherCharge"}},"description":"Other charges"},{"name":"requestedShippingOption","slug":"requested-shipping-option","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)"},{"name":"title","slug":"title","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\nFor example, \"Standard\" or \"First-Class Package International\"."}]},"docs/ecom-v1-checkout.SelectedCarrierServiceOptionPrices":{"name":"SelectedCarrierServiceOptionPrices","fqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOptionPrices","slug":"selected-carrier-service-option-prices","actions":[],"properties":[{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Shipping price before discount and before tax."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-checkout.ItemTaxFullDetails"},"description":"Tax details."},{"name":"totalDiscount","slug":"total-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Shipping discount before tax."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total shipping price, after discount and after tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Total price of shipping after discounts (when relevant), and before tax."}]},"docs/ecom-v1-checkout.SelectedCarrierServiceOptionOtherCharge":{"name":"SelectedCarrierServiceOptionOtherCharge","fqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOptionOtherCharge","slug":"selected-carrier-service-option-other-charge","actions":[],"properties":[{"name":"cost","slug":"cost","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedCarrierServiceOptionPrices","referenceFqn":"docs/ecom-v1-checkout.SelectedCarrierServiceOptionPrices"},"description":"Price of added charge."},{"name":"details","slug":"details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChargeType","referenceFqn":"docs/ecom-v1-checkout.ChargeType"},"description":"Type of additional cost."}]},"docs/ecom-v1-checkout.TaxSummary":{"name":"TaxSummary","fqn":"docs/ecom-v1-checkout.TaxSummary","slug":"tax-summary","actions":[],"properties":[{"name":"calculationDetails","slug":"calculation-details","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"TaxCalculationDetails","referenceFqn":"docs/ecom-v1-checkout.TaxCalculationDetails"},"description":"Tax calculator that was active when the order was created."},{"name":"taxableAmount","slug":"taxable-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Amount for which tax is calculated, added from line items."},{"name":"totalTax","slug":"total-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"Calculated tax, added from line items."}]},"docs/ecom-v1-checkout.AggregatedTaxBreakdown":{"name":"AggregatedTaxBreakdown","fqn":"docs/ecom-v1-checkout.AggregatedTaxBreakdown","slug":"aggregated-tax-breakdown","actions":[],"properties":[{"name":"aggregatedTaxAmount","slug":"aggregated-tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout.MultiCurrencyPrice"},"description":"The sum of all the tax from line items that calculated by the tax identifiers."},{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the jurisdiction in which this tax detail applies."},{"name":"jurisdictionTypeEnum","slug":"jurisdiction-type-enum","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-checkout.JurisdictionType"},"description":"The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special)."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)"},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws."}]},"docs/ecom-v1-checkout.TaxCalculationDetails":{"name":"TaxCalculationDetails","fqn":"docs/ecom-v1-checkout.TaxCalculationDetails","slug":"tax-calculation-details","actions":[],"oneofProperties":{"calculationDetails":[{"name":"autoTaxFallbackDetails","slug":"auto-tax-fallback-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AutoTaxFallbackCalculationDetails","referenceFqn":"docs/ecom-v1-checkout.AutoTaxFallbackCalculationDetails"},"description":"Details of the fallback rate calculation."},{"name":"manualRateReason","slug":"manual-rate-reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManualCalculationReason","referenceFqn":"docs/ecom-v1-checkout.ManualCalculationReason"},"description":"Reason the manual calculation was used."}]},"properties":[{"name":"rateType","slug":"rate-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RateType","referenceFqn":"docs/ecom-v1-checkout.RateType"},"description":"Rate calculation type."}]},"docs/ecom-v1-checkout.AutoTaxFallbackCalculationDetails":{"name":"AutoTaxFallbackCalculationDetails","fqn":"docs/ecom-v1-checkout.AutoTaxFallbackCalculationDetails","slug":"auto-tax-fallback-calculation-details","actions":[],"properties":[{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"docs/ecom-v1-checkout.ApplicationError"},"description":"invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here"},{"name":"fallbackReason","slug":"fallback-reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FallbackReason","referenceFqn":"docs/ecom-v1-checkout.FallbackReason"},"description":"reason for fallback"}]},"docs/ecom-v1-checkout.FallbackReason":{"name":"FallbackReason","fqn":"docs/ecom-v1-checkout.FallbackReason","slug":"fallback-reason","actions":[],"enumValues":["AUTO_TAX_DEACTIVATED","AUTO_TAX_FAILED"],"properties":[]},"docs/ecom-v1-checkout.ManualCalculationReason":{"name":"ManualCalculationReason","fqn":"docs/ecom-v1-checkout.ManualCalculationReason","slug":"manual-calculation-reason","actions":[],"enumValues":["GLOBAL_SETTING_TO_MANUAL","REGION_SETTING_TO_MANUAL"],"properties":[]},"docs/ecom-v1-checkout.RateType":{"name":"RateType","fqn":"docs/ecom-v1-checkout.RateType","slug":"rate-type","actions":[],"enumValues":["AUTO_RATE","FALLBACK_RATE","MANUAL_RATE","NO_TAX_COLLECTED"],"properties":[]},"docs/ecom-v1-checkout.Violation":{"name":"Violation","fqn":"docs/ecom-v1-checkout.Violation","slug":"violation","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`."},{"name":"severity","slug":"severity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Severity","referenceFqn":"docs/ecom-v1-checkout.Severity"},"description":"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."},{"name":"target","slug":"target","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Target","referenceFqn":"docs/ecom-v1-checkout.Target"},"description":"Target location on a checkout or cart page where the violation will be displayed."}]},"docs/ecom-v1-checkout.Severity":{"name":"Severity","fqn":"docs/ecom-v1-checkout.Severity","slug":"severity","actions":[],"enumValues":["ERROR","WARNING"],"properties":[]},"docs/ecom-v1-checkout.Target":{"name":"Target","fqn":"docs/ecom-v1-checkout.Target","slug":"target","actions":[],"oneofProperties":{"targetType":[{"name":"lineItem","slug":"line-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TargetLineItem","referenceFqn":"docs/ecom-v1-checkout.TargetLineItem"},"description":"Specific line item violation."},{"name":"other","slug":"other","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Other","referenceFqn":"docs/ecom-v1-checkout.Other"},"description":"General (other) violation."}]},"properties":[]},"docs/ecom-v1-checkout.TargetLineItem":{"name":"TargetLineItem","fqn":"docs/ecom-v1-checkout.TargetLineItem","slug":"target-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the line item containing the violation."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location on a checkout or a cart page where the specific line item violation will be displayed."}]},"docs/ecom-v1-checkout.Other":{"name":"Other","fqn":"docs/ecom-v1-checkout.Other","slug":"other","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location on a checkout or a cart page where a general (other) violation will be displayed."}]},"docs/ecom-v1-checkout.WeightUnit":{"name":"WeightUnit","fqn":"docs/ecom-v1-checkout.WeightUnit","slug":"weight-unit","actions":[],"enumValues":["KG","LB","UNSPECIFIED_WEIGHT_UNIT"],"properties":[]},"docs/ecom-v1-checkout.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-checkout.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-checkout.CheckoutCreated":{"name":"CheckoutCreated","fqn":"docs/ecom-v1-checkout.CheckoutCreated","slug":"checkout-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Checkout","referenceFqn":"docs/ecom-v1-checkout.Checkout"},"description":"Created checkout."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout.CheckoutUpdated":{"name":"CheckoutUpdated","fqn":"docs/ecom-v1-checkout.CheckoutUpdated","slug":"checkout-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Checkout","referenceFqn":"docs/ecom-v1-checkout.Checkout"},"description":"Updated checkout."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout-settings.CheckoutSettingsUpdated":{"name":"CheckoutSettingsUpdated","fqn":"docs/ecom-v1-checkout-settings.CheckoutSettingsUpdated","slug":"checkout-settings-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutSettings","referenceFqn":"docs/ecom-v1-checkout-settings.CheckoutSettings"},"description":"Updated checkout settings."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout-settings.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout-settings.CheckoutSettings":{"name":"CheckoutSettings","fqn":"docs/ecom-v1-checkout-settings.CheckoutSettings","slug":"checkout-settings","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the checkout settings were created."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the checkout settings were updated."},{"name":"checkoutFields","slug":"checkout-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutFields","referenceFqn":"docs/ecom-v1-checkout-settings.CheckoutFields"},"description":"Settings that apply to checkout fields and the checkout process."},{"name":"checkoutPolicies","slug":"checkout-policies","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutPolicies","referenceFqn":"docs/ecom-v1-checkout-settings.CheckoutPolicies"},"description":"Checkout policies."}]},"docs/ecom-v1-checkout-settings.CheckoutBrand":{"name":"CheckoutBrand","fqn":"docs/ecom-v1-checkout-settings.CheckoutBrand","slug":"checkout-brand","actions":[],"properties":[{"name":"header","slug":"header","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutHeader","referenceFqn":"docs/ecom-v1-checkout-settings.CheckoutHeader"},"description":"Checkout header."}]},"docs/ecom-v1-checkout-settings.CheckoutHeader":{"name":"CheckoutHeader","fqn":"docs/ecom-v1-checkout-settings.CheckoutHeader","slug":"checkout-header","actions":[],"properties":[{"name":"alignment","slug":"alignment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Alignment","referenceFqn":"docs/ecom-v1-checkout-settings.Alignment"},"description":"Alignment within the header.\n\n>**Note:** `SIDE` alignment is decided depending on the locale's language. For example, scripts like Hebrew and Arabic will automatically align right-to-left."},{"name":"displayCheckoutLabel","slug":"display-checkout-label","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to display the 'Checkout' label within the header.\nDepending on the locale, the label may be translated."},{"name":"logo","slug":"logo","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Logo","referenceFqn":"docs/ecom-v1-checkout-settings.Logo"},"description":"Specifications for when a logo is included in the header."},{"name":"text","slug":"text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Textual content to be included in the header (e.g. Business Name)\nTODO: update maxLength validation once limitation is known"}]},"docs/ecom-v1-checkout-settings.Alignment":{"name":"Alignment","fqn":"docs/ecom-v1-checkout-settings.Alignment","slug":"alignment","actions":[],"enumValues":["CENTER","SIDE","UNKNOWN_ALIGNMENT"],"properties":[]},"docs/ecom-v1-checkout-settings.Logo":{"name":"Logo","fqn":"docs/ecom-v1-checkout-settings.Logo","slug":"logo","actions":[],"properties":[{"name":"size","slug":"size","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LogoSize","referenceFqn":"docs/ecom-v1-checkout-settings.LogoSize"},"description":"Size of the logo."}]},"docs/ecom-v1-checkout-settings.LogoSize":{"name":"LogoSize","fqn":"docs/ecom-v1-checkout-settings.LogoSize","slug":"logo-size","actions":[],"enumValues":["LARGE","MEDIUM","SMALL","UNKNOWN_LOGO_SIZE"],"properties":[]},"docs/ecom-v1-checkout-settings.CheckoutFields":{"name":"CheckoutFields","fqn":"docs/ecom-v1-checkout-settings.CheckoutFields","slug":"checkout-fields","actions":[],"properties":[{"name":"giftCardRedeemEnabled","slug":"gift-card-redeem-enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the ability to redeem a gift card is enabled.

\n\nDefault: `false`"},{"name":"mitEnabled","slug":"mit-enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to allow for MIT transactions.

\n\nDefault: `false`"},{"name":"policyAgreementCheckbox","slug":"policy-agreement-checkbox","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckboxField","referenceFqn":"docs/ecom-v1-checkout-settings.CheckboxField"},"description":"Policy agreement checkbox.

\n\nDefaults:\n+ `visible`: `true`\n+ `checkedByDefault`: `true`"},{"name":"subscriptionCheckbox","slug":"subscription-checkbox","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckboxField","referenceFqn":"docs/ecom-v1-checkout-settings.CheckboxField"},"description":"Subscription checkbox.

\n\nDefaults:\n+ `visible`: `false`\n+ `checkedByDefault`: `false`"}]},"docs/ecom-v1-checkout-settings.CheckboxField":{"name":"CheckboxField","fqn":"docs/ecom-v1-checkout-settings.CheckboxField","slug":"checkbox-field","actions":[],"properties":[{"name":"checkedByDefault","slug":"checked-by-default","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the checkbox is checked by default."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the checkbox is visible to the customer."}]},"docs/ecom-v1-checkout-settings.CheckoutPolicies":{"name":"CheckoutPolicies","fqn":"docs/ecom-v1-checkout-settings.CheckoutPolicies","slug":"checkout-policies","actions":[],"properties":[{"name":"contactUs","slug":"contact-us","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ContactUsPolicy","referenceFqn":"docs/ecom-v1-checkout-settings.ContactUsPolicy"},"description":"\"Contact us\" information."},{"name":"customPolicy","slug":"custom-policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomCheckoutPolicy","referenceFqn":"docs/ecom-v1-checkout-settings.CustomCheckoutPolicy"},"description":"Custom policy."},{"name":"digitalItemPolicy","slug":"digital-item-policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DigitalItemPolicy","referenceFqn":"docs/ecom-v1-checkout-settings.DigitalItemPolicy"},"description":"Digital item policy."},{"name":"privacyPolicy","slug":"privacy-policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PrivacyPolicy","referenceFqn":"docs/ecom-v1-checkout-settings.PrivacyPolicy"},"description":"Privacy policy."},{"name":"returnPolicy","slug":"return-policy","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ReturnPolicy","referenceFqn":"docs/ecom-v1-checkout-settings.ReturnPolicy"},"description":"Return policy."},{"name":"termsAndConditions","slug":"terms-and-conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TermsAndConditionsPolicy","referenceFqn":"docs/ecom-v1-checkout-settings.TermsAndConditionsPolicy"},"description":"Terms and conditions."}]},"docs/ecom-v1-checkout-settings.ContactUsPolicy":{"name":"ContactUsPolicy","fqn":"docs/ecom-v1-checkout-settings.ContactUsPolicy","slug":"contact-us-policy","actions":[],"properties":[{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact us policy content."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the contact us policy is visible to the customer in the checkout page.

\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-settings.CustomCheckoutPolicy":{"name":"CustomCheckoutPolicy","fqn":"docs/ecom-v1-checkout-settings.CustomCheckoutPolicy","slug":"custom-checkout-policy","actions":[],"properties":[{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy content."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Policy title."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the policy is visible to the customer in the checkout page.

\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-settings.DigitalItemPolicy":{"name":"DigitalItemPolicy","fqn":"docs/ecom-v1-checkout-settings.DigitalItemPolicy","slug":"digital-item-policy","actions":[],"properties":[{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Digital item policy content."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the digital item policy is visible to the customer in the checkout page.

\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-settings.PrivacyPolicy":{"name":"PrivacyPolicy","fqn":"docs/ecom-v1-checkout-settings.PrivacyPolicy","slug":"privacy-policy","actions":[],"properties":[{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Privacy policy content."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the privacy policy is visible to the customer in the checkout page.

\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-settings.ReturnPolicy":{"name":"ReturnPolicy","fqn":"docs/ecom-v1-checkout-settings.ReturnPolicy","slug":"return-policy","actions":[],"properties":[{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Return policy content."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the return policy is visible to the customer in the checkout page.

\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-settings.TermsAndConditionsPolicy":{"name":"TermsAndConditionsPolicy","fqn":"docs/ecom-v1-checkout-settings.TermsAndConditionsPolicy","slug":"terms-and-conditions-policy","actions":[],"properties":[{"name":"content","slug":"content","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Terms and conditions policy content."},{"name":"visible","slug":"visible","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the terms & conditions policy is visible to the customer in the checkout page.

\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-settings.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-checkout-settings.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-checkout-template.CheckoutTemplateCreated":{"name":"CheckoutTemplateCreated","fqn":"docs/ecom-v1-checkout-template.CheckoutTemplateCreated","slug":"checkout-template-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplate","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplate"},"description":"Created checkout template."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout-template.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout-template.CheckoutTemplate":{"name":"CheckoutTemplate","fqn":"docs/ecom-v1-checkout-template.CheckoutTemplate","slug":"checkout-template","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout template ID."},{"name":"couponCode","slug":"coupon-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code.\n\nNote that a checkout can only hold one `couponCode` at a time. If an additional `couponCode` is added, it will override the existing `couponCode`.\nFor additional information, see the [Coupons API](https://dev.wix.com/docs/rest/api-reference/coupons/coupons/introduction)."},{"name":"customContentReference","slug":"custom-content-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomContentReference","referenceFqn":"docs/ecom-v1-checkout-template.CustomContentReference"},"description":"Customize the content of the checkout page.\n\nIncludes IDs for the app and the component providing the content"},{"name":"customLineItems","slug":"custom-line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomLineItem","referenceFqn":"docs/ecom-v1-checkout-template.CustomLineItem"}},"description":"Custom line items.\n\nMax: 300 items"},{"name":"customization","slug":"customization","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutCustomization","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutCustomization"},"description":"Custom settings to apply to the checkout page created from this template."},{"name":"externalReference","slug":"external-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExternalReference","referenceFqn":"docs/ecom-v1-checkout-template.ExternalReference"},"description":"Used for integration and tracking across different platforms.\nContains external system IDs (e.g., app ID, external ID) to link the checkout template with other systems."},{"name":"lineItems","slug":"line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"V1LineItem","referenceFqn":"docs/ecom-v1-checkout-template.V1LineItem"}},"description":"Line items.\n\nMax: 300 items"},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Status","referenceFqn":"docs/ecom-v1-checkout-template.Status"},"description":"Status of the checkout template.\n\nWhen `status` is `INACTIVE` checkouts will not be created with this template `id`. Instead, the endpoint will redirect to the domain site.\n\nDefault: `ACTIVE`"}]},"docs/ecom-v1-checkout-template.CustomContentReference":{"name":"CustomContentReference","fqn":"docs/ecom-v1-checkout-template.CustomContentReference","slug":"custom-content-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the content.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps)."},{"name":"componentId","slug":"component-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the component within the app it belongs to.\n\nYou can get your component's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps)."}]},"docs/ecom-v1-checkout-template.CustomLineItem":{"name":"CustomLineItem","fqn":"docs/ecom-v1-checkout-template.CustomLineItem","slug":"custom-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom line item ID. If passed, `id` must be unique.\nDefault: auto-generated ID."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-checkout-template.CatalogReference"},"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info."},{"name":"depositAmount","slug":"deposit-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - partial payment for the given item to be paid upfront during the checkout.\nEligible for catalog items with type `DEPOSIT_ONLINE`.\nIf omitted - item's price will not be split and is expected to be paid in single installment"},{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-checkout-template.DescriptionLine"}},"description":"Custom line item description lines. Used for display purposes for the cart, checkout and order."},{"name":"fullPrice","slug":"full-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - Item price **before** catalog-defined discount. Defaults to `price` when not provided."},{"name":"itemType","slug":"item-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-checkout-template.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"media","slug":"media","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom line item's media."},{"name":"paymentOption","slug":"payment-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentOptionType","referenceFqn":"docs/ecom-v1-checkout-template.PaymentOptionType"},"description":"Optional - Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE` - Entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - Entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Amount to be paid is defined by deposit_amount field."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-checkout-template.PhysicalProperties"},"description":"Optional - Physical properties of the item. When relevant, contains information such as SKU and item weight."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom line item price.\n\nMust be a number or a decimal without symbols."},{"name":"priceDescription","slug":"price-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-checkout-template.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-checkout-template.ProductName"},"description":"Name of the item or product."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Custom line item quantity.\n\nMin: `1`\nMax: `100000`"},{"name":"quantityAvailable","slug":"quantity-available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Optional - Item quantity available for purchase. Only return this if inventory is managed.\nNot returning this field means that the buyer can \"infinitely\" tick up the number of items in the cart."},{"name":"rootCatalogItemId","slug":"root-catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ in most cases, this field is the name as `catalogReference.catalogItemId`.\n+ Used in membership validation."},{"name":"serviceProperties","slug":"service-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ServiceProperties","referenceFqn":"docs/ecom-v1-checkout-template.ServiceProperties"},"description":"Optional - Service properties. When relevant, this contains information such as date and number of participants.\nUsed, among other things, when checking for valid memberships."},{"name":"taxGroupId","slug":"tax-group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax group ID for this custom line item."},{"name":"url","slug":"url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - URL to the item's page on the site. When not provided, the link back from the cart page to the relevant product page will not work.\nThe URL is optional and if not provided, the site URL will be used."}]},"docs/ecom-v1-checkout-template.CatalogReference":{"name":"CatalogReference","fqn":"docs/ecom-v1-checkout-template.CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"docs/ecom-v1-checkout-template.DescriptionLine":{"name":"DescriptionLine","fqn":"docs/ecom-v1-checkout-template.DescriptionLine","slug":"description-line","actions":[],"oneofProperties":{"value":[{"name":"colorInfo","slug":"color-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/ecom-v1-checkout-template.Color"},"description":"Description line color value."},{"name":"plainText","slug":"plain-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PlainTextValue","referenceFqn":"docs/ecom-v1-checkout-template.PlainTextValue"},"description":"Description line plain text value."}],"descriptionLineValue":[]},"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DescriptionLineName","referenceFqn":"docs/ecom-v1-checkout-template.DescriptionLineName"},"description":"Description line name."}]},"docs/ecom-v1-checkout-template.Color":{"name":"Color","fqn":"docs/ecom-v1-checkout-template.Color","slug":"color","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HEX or RGB color code for display."},{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout-template.DescriptionLineType":{"name":"DescriptionLineType","fqn":"docs/ecom-v1-checkout-template.DescriptionLineType","slug":"description-line-type","actions":[],"enumValues":["COLOR","PLAIN_TEXT","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-checkout-template.DescriptionLineName":{"name":"DescriptionLineName","fqn":"docs/ecom-v1-checkout-template.DescriptionLineName","slug":"description-line-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout-template.PlainTextValue":{"name":"PlainTextValue","fqn":"docs/ecom-v1-checkout-template.PlainTextValue","slug":"plain-text-value","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout-template.SecuredMedia":{"name":"SecuredMedia","fqn":"docs/ecom-v1-checkout-template.SecuredMedia","slug":"secured-media","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Media ID in Wix Media Manager."},{"name":"fileName","slug":"file-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original filename."},{"name":"fileType","slug":"file-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FileType","referenceFqn":"docs/ecom-v1-checkout-template.FileType"},"description":"File type."}]},"docs/ecom-v1-checkout-template.FileType":{"name":"FileType","fqn":"docs/ecom-v1-checkout-template.FileType","slug":"file-type","actions":[],"enumValues":["SECURE_ARCHIVE","SECURE_DOCUMENT","SECURE_MUSIC","SECURE_PICTURE","SECURE_VIDEO","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-checkout-template.ItemType":{"name":"ItemType","fqn":"docs/ecom-v1-checkout-template.ItemType","slug":"item-type","actions":[],"oneofProperties":{"itemTypeData":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom item type. When none of the preset types are suitable, specifies the custom type."},{"name":"preset","slug":"preset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTypeItemType","referenceFqn":"docs/ecom-v1-checkout-template.ItemTypeItemType"},"description":"Preset item type."}]},"properties":[]},"docs/ecom-v1-checkout-template.ItemTypeItemType":{"name":"ItemTypeItemType","fqn":"docs/ecom-v1-checkout-template.ItemTypeItemType","slug":"item-type-item-type","actions":[],"enumValues":["DIGITAL","GIFT_CARD","PHYSICAL","SERVICE","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-checkout-template.PaymentOptionType":{"name":"PaymentOptionType","fqn":"docs/ecom-v1-checkout-template.PaymentOptionType","slug":"payment-option-type","actions":[],"enumValues":["DEPOSIT_ONLINE","FULL_PAYMENT_OFFLINE","FULL_PAYMENT_ONLINE","MEMBERSHIP","MEMBERSHIP_OFFLINE"],"properties":[]},"docs/ecom-v1-checkout-template.PhysicalProperties":{"name":"PhysicalProperties","fqn":"docs/ecom-v1-checkout-template.PhysicalProperties","slug":"physical-properties","actions":[],"properties":[{"name":"shippable","slug":"shippable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this line item is shippable."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."}]},"docs/ecom-v1-checkout-template.PriceDescription":{"name":"PriceDescription","fqn":"docs/ecom-v1-checkout-template.PriceDescription","slug":"price-description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Price description 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Price description translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout-template.ProductName":{"name":"ProductName","fqn":"docs/ecom-v1-checkout-template.ProductName","slug":"product-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Item 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).\n\nMin: 1 character.\nMax: 200 characters."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout-template.ServiceProperties":{"name":"ServiceProperties","fqn":"docs/ecom-v1-checkout-template.ServiceProperties","slug":"service-properties","actions":[],"properties":[{"name":"numberOfParticipants","slug":"number-of-participants","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room."},{"name":"scheduledDate","slug":"scheduled-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"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.\nFor example, the start time of a class."}]},"docs/ecom-v1-checkout-template.SubscriptionOptionInfo":{"name":"SubscriptionOptionInfo","fqn":"docs/ecom-v1-checkout-template.SubscriptionOptionInfo","slug":"subscription-option-info","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Description","referenceFqn":"docs/ecom-v1-checkout-template.Description"},"description":"Subscription option description."},{"name":"subscriptionSettings","slug":"subscription-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionSettings","referenceFqn":"docs/ecom-v1-checkout-template.SubscriptionSettings"},"description":"Subscription option settings."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Title","referenceFqn":"docs/ecom-v1-checkout-template.Title"},"description":"Subscription option title."}]},"docs/ecom-v1-checkout-template.Description":{"name":"Description","fqn":"docs/ecom-v1-checkout-template.Description","slug":"description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option description."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated subscription option description."}]},"docs/ecom-v1-checkout-template.SubscriptionSettings":{"name":"SubscriptionSettings","fqn":"docs/ecom-v1-checkout-template.SubscriptionSettings","slug":"subscription-settings","actions":[],"properties":[{"name":"autoRenewal","slug":"auto-renewal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether subscription is renewed automatically at the end of each period."},{"name":"billingCycles","slug":"billing-cycles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal` is `true`."},{"name":"frequency","slug":"frequency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionFrequency","referenceFqn":"docs/ecom-v1-checkout-template.SubscriptionFrequency"},"description":"Frequency of recurring payment."}]},"docs/ecom-v1-checkout-template.SubscriptionFrequency":{"name":"SubscriptionFrequency","fqn":"docs/ecom-v1-checkout-template.SubscriptionFrequency","slug":"subscription-frequency","actions":[],"enumValues":["DAY","MONTH","UNDEFINED","WEEK","YEAR"],"properties":[]},"docs/ecom-v1-checkout-template.Title":{"name":"Title","fqn":"docs/ecom-v1-checkout-template.Title","slug":"title","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-checkout-template.CheckoutCustomization":{"name":"CheckoutCustomization","fqn":"docs/ecom-v1-checkout-template.CheckoutCustomization","slug":"checkout-customization","actions":[],"properties":[{"name":"disabledManualPayment","slug":"disabled-manual-payment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"},{"name":"lockedCoupon","slug":"locked-coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to lock the ability to apply or remove a coupon code.\n\nDefault: `false`"},{"name":"lockedGiftCard","slug":"locked-gift-card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to lock the ability to add or remove a gift card.\n\nDefault: `false`"},{"name":"webClient","slug":"web-client","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WebClientCustomization","referenceFqn":"docs/ecom-v1-checkout-template.WebClientCustomization"},"description":"Web client customizations. These customizations only apply to the standard Wix checkout page."}]},"docs/ecom-v1-checkout-template.WebClientCustomization":{"name":"WebClientCustomization","fqn":"docs/ecom-v1-checkout-template.WebClientCustomization","slug":"web-client-customization","actions":[],"properties":[{"name":"disabledContinueShoppingButton","slug":"disabled-continue-shopping-button","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable the \"Continue shopping\" button.\n\nDefault: `false`"},{"name":"disabledPolicyAgreementCheckbox","slug":"disabled-policy-agreement-checkbox","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-template.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-checkout-template.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-checkout-template.ExternalReference":{"name":"ExternalReference","fqn":"docs/ecom-v1-checkout-template.ExternalReference","slug":"external-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that associated with the purchase flow."},{"name":"resourceId","slug":"resource-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reference to an external system ID, used to link the purchase flow to a specific ID in another system"}]},"docs/ecom-v1-checkout-template.V1LineItem":{"name":"V1LineItem","fqn":"docs/ecom-v1-checkout-template.V1LineItem","slug":"v1line-item","actions":[],"properties":[{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-checkout-template.CatalogReference"},"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info.\n\n> **Note:** For more information on what to pass to `lineItems.catalogReference`, see [eCommerce Integration in the Wix Stores Catalog API](https://dev.wix.com/api/rest/wix-stores/catalog/ecommerce-integration)."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item quantity.\n\nMin: `1`
\nMax: `100000`"}]},"docs/ecom-v1-checkout-template.CatalogOverrideFields":{"name":"CatalogOverrideFields","fqn":"docs/ecom-v1-checkout-template.CatalogOverrideFields","slug":"catalog-override-fields","actions":[],"properties":[{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-checkout-template.DescriptionLine"}},"description":"Line item description lines. Used for displaying the cart, checkout and order."},{"name":"fullPrice","slug":"full-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price **before** discount."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image details."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-checkout-template.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item price **after** discounts."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-checkout-template.ProductName"},"description":"Item product name"}]},"docs/ecom-v1-checkout-template.Status":{"name":"Status","fqn":"docs/ecom-v1-checkout-template.Status","slug":"status","actions":[],"enumValues":["ACTIVE","INACTIVE","UNKNOWN_STATUS"],"properties":[]},"docs/ecom-v1-checkout-template.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-checkout-template.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-checkout-template.CheckoutTemplateDeleted":{"name":"CheckoutTemplateDeleted","fqn":"docs/ecom-v1-checkout-template.CheckoutTemplateDeleted","slug":"checkout-template-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout-template.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout-template.CheckoutTemplateUpdated":{"name":"CheckoutTemplateUpdated","fqn":"docs/ecom-v1-checkout-template.CheckoutTemplateUpdated","slug":"checkout-template-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplate","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplate"},"description":"Updated checkout template."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout-template.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout-template.CheckoutTemplateUsedEvent":{"name":"CheckoutTemplateUsedEvent","fqn":"docs/ecom-v1-checkout-template.CheckoutTemplateUsedEvent","slug":"checkout-template-used-event","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplateUsed","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplateUsed"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-checkout-template.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-checkout-template.CheckoutTemplateUsed":{"name":"CheckoutTemplateUsed","fqn":"docs/ecom-v1-checkout-template.CheckoutTemplateUsed","slug":"checkout-template-used","actions":[],"properties":[{"name":"checkout","slug":"checkout","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Checkout","referenceFqn":"docs/ecom-v1-checkout-template.Checkout"},"description":"newly created checkout"},{"name":"checkoutTemplate","slug":"checkout-template","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplate","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplate"},"description":"checkout template"}]},"docs/ecom-v1-checkout-template.Checkout":{"name":"Checkout","fqn":"docs/ecom-v1-checkout-template.Checkout","slug":"checkout","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the checkout was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the checkout was updated."},{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalFee","referenceFqn":"docs/ecom-v1-checkout-template.AdditionalFee"}},"description":"Additional Fees."},{"name":"appliedDiscounts","slug":"applied-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AppliedDiscount","referenceFqn":"docs/ecom-v1-checkout-template.AppliedDiscount"}},"description":"Applied discounts."},{"name":"billingInfo","slug":"billing-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-checkout-template.AddressWithContact"},"description":"Billing information."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BuyerInfo","referenceFqn":"docs/ecom-v1-checkout-template.BuyerInfo"},"description":"Buyer information."},{"name":"buyerLanguage","slug":"buyer-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected."},{"name":"buyerNote","slug":"buyer-note","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer."},{"name":"calculationErrors","slug":"calculation-errors","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalculationErrors","referenceFqn":"docs/ecom-v1-checkout-template.CalculationErrors"},"description":"Errors when calculating totals."},{"name":"cartId","slug":"cart-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cart ID that this checkout was created from. Empty if this checkout wasn't created from a cart."},{"name":"channelType","slug":"channel-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChannelType","referenceFqn":"docs/ecom-v1-checkout-template.ChannelType"},"description":"Sales channel that submitted the order.\n+ `\"UNSPECIFIED\"`: Unspecified sales channel. This value is not supported.\n+ `\"WEB\"`: A web client.\n+ `\"POS\"`: [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395)\n+ `\"EBAY\"`: [eBay](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop)\n+ `\"AMAZON\"`: [Amazon](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop)\n+ `\"WISH\"`: [Wish](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-a-wish-shop)\n+ `\"WIX_INVOICES\"`: 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)\n+ `\"WIX_APP_STORE\"`: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview)\n+ `\"BACKOFFICE_MERCHANT\"`: Wix merchant backoffice\n+ `\"OTHER_PLATFORM\"`: Other sales platform."},{"name":"completed","slug":"completed","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether an order was successfully created from this checkout.\nFor an order to be successful, it must be successfully paid for (unless the total is 0)."},{"name":"conversionCurrency","slug":"conversion-currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"All converted prices are displayed in this currency in three-letter [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format."},{"name":"createdBy","slug":"created-by","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreatedBy","referenceFqn":"docs/ecom-v1-checkout-template.CreatedBy"},"description":"ID of the checkout's initiator."},{"name":"currency","slug":"currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The currency used when submitting the order."},{"name":"customContentReference","slug":"custom-content-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomContentReference","referenceFqn":"docs/ecom-v1-checkout-template.CustomContentReference"},"description":"Customize the content of the checkout page.\n\nIncludes IDs for the app and the component providing the content"},{"name":"customFields","slug":"custom-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomField","referenceFqn":"docs/ecom-v1-checkout-template.CustomField"}},"description":"Custom fields."},{"name":"customSettings","slug":"custom-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomSettings","referenceFqn":"docs/ecom-v1-checkout-template.CustomSettings"},"description":"Additional settings for customization of the checkout process.\n\nCustom settings can only be set when [creating a checkout](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/checkout/create-checkout)."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-checkout-template.ExtendedFields"},"description":"Custom field data for the checkout object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls."},{"name":"externalReference","slug":"external-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExternalReference","referenceFqn":"docs/ecom-v1-checkout-template.ExternalReference"},"description":"Used for integration and tracking across different platforms.\nContains external system IDs (e.g., app ID, external ID) to link the checkout with other systems."},{"name":"giftCard","slug":"gift-card","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GiftCard","referenceFqn":"docs/ecom-v1-checkout-template.GiftCard"},"description":"Applied gift card details.\n\n>**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/wix-stores-setting-up-wix-gift-cards)."},{"name":"lineItems","slug":"line-items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItem","referenceFqn":"docs/ecom-v1-checkout-template.LineItem"}},"description":"Line items.\n\nMax: 300 items"},{"name":"membershipOptions","slug":"membership-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipOptions","referenceFqn":"docs/ecom-v1-checkout-template.MembershipOptions"},"description":"Memberships to apply when creating the order."},{"name":"payLater","slug":"pay-later","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-checkout-template.PriceSummary"},"description":"Remaining amount for the order to be fully paid."},{"name":"payNow","slug":"pay-now","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-checkout-template.PriceSummary"},"description":"Minimal amount to pay in order to place the order."},{"name":"priceSummary","slug":"price-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-checkout-template.PriceSummary"},"description":"Calculated price summary for the checkout."},{"name":"purchaseFlowId","slug":"purchase-flow-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order."},{"name":"shippingInfo","slug":"shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingInfo","referenceFqn":"docs/ecom-v1-checkout-template.ShippingInfo"},"description":"Shipping information."},{"name":"siteLanguage","slug":"site-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Site language in which original values are shown."},{"name":"taxIncludedInPrice","slug":"tax-included-in-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether tax is included in line item prices."},{"name":"taxSummary","slug":"tax-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaxSummary","referenceFqn":"docs/ecom-v1-checkout-template.TaxSummary"},"description":"Tax summary."},{"name":"violations","slug":"violations","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Violation","referenceFqn":"docs/ecom-v1-checkout-template.Violation"}},"description":"List of validation violations raised by the [Validations service plugin](https://dev.wix.com/api/rest/wix-ecommerce/validations-integration-spi/introduction)."},{"name":"weightUnit","slug":"weight-unit","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WeightUnit","referenceFqn":"docs/ecom-v1-checkout-template.WeightUnit"},"description":"Weight measurement unit - defaults to site's weight unit."}]},"docs/ecom-v1-checkout-template.AdditionalFee":{"name":"AdditionalFee","fqn":"docs/ecom-v1-checkout-template.AdditionalFee","slug":"additional-fee","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee's unique code (or ID) for future processing."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Optional - Line items associated with this additional fee.\nIf no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated additional fee's name."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Additional fee's price."},{"name":"priceAfterTax","slug":"price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Additional fee's price after tax."},{"name":"priceBeforeTax","slug":"price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Additional fee's price before tax."},{"name":"providerAppId","slug":"provider-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Provider's app id."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-checkout-template.ItemTaxFullDetails"},"description":"Tax details."}]},"docs/ecom-v1-checkout-template.MultiCurrencyPrice":{"name":"MultiCurrencyPrice","fqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice","slug":"multi-currency-price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"convertedAmount","slug":"converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."},{"name":"formattedConvertedAmount","slug":"formatted-converted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Converted amount formatted with currency symbol."}]},"docs/ecom-v1-checkout-template.ItemTaxFullDetails":{"name":"ItemTaxFullDetails","fqn":"docs/ecom-v1-checkout-template.ItemTaxFullDetails","slug":"item-tax-full-details","actions":[],"properties":[{"name":"rateBreakdown","slug":"rate-breakdown","isReadOnly":true,"isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TaxRateBreakdown","referenceFqn":"docs/ecom-v1-checkout-template.TaxRateBreakdown"}},"description":"If breakdown exists, the sum of rates in the breakdown must equal `tax_rate`. Deprecated - use 'tax_breakdown' instead."},{"name":"taxRate","slug":"tax-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate %, as a decimal point between 0 and 1."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Amount for which tax is calculated."},{"name":"totalTax","slug":"total-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Calculated tax, based on `taxable_amount` and `tax_rate`."}]},"docs/ecom-v1-checkout-template.TaxRateBreakdown":{"name":"TaxRateBreakdown","fqn":"docs/ecom-v1-checkout-template.TaxRateBreakdown","slug":"tax-rate-breakdown","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of tax against which the calculation was performed."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Rate at which this tax detail was calculated."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Amount of tax for this tax detail."}]},"docs/ecom-v1-checkout-template.TaxBreakdown":{"name":"TaxBreakdown","fqn":"docs/ecom-v1-checkout-template.TaxBreakdown","slug":"tax-breakdown","actions":[],"properties":[{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the jurisdiction to which this tax detail applies. For example, \"New York\" or \"Quebec\"."},{"name":"jurisdictionType","slug":"jurisdiction-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-checkout-template.JurisdictionType"},"description":"The type of the jurisdiction in which this tax detail applies."},{"name":"nonTaxableAmount","slug":"non-taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"The amount of this line item price that was considered nontaxable. (Decimal value)"},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.0000 signifies 200% tax. (Decimal value)"},{"name":"taxAmount","slug":"tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"The amount of tax estimated for this line item. (Decimal value)"},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\nThis name should be explicit enough to allow the merchant to understand what tax was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"The taxable amount of this line item."}]},"docs/ecom-v1-checkout-template.JurisdictionType":{"name":"JurisdictionType","fqn":"docs/ecom-v1-checkout-template.JurisdictionType","slug":"jurisdiction-type","actions":[],"enumValues":["CITY","COUNTRY","COUNTY","SPECIAL","STATE","UNDEFINED"],"properties":[]},"docs/ecom-v1-checkout-template.AppliedDiscount":{"name":"AppliedDiscount","fqn":"docs/ecom-v1-checkout-template.AppliedDiscount","slug":"applied-discount","actions":[],"oneofProperties":{"discountSource":[{"name":"coupon","slug":"coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Coupon","referenceFqn":"docs/ecom-v1-checkout-template.Coupon"},"description":"Coupon details."},{"name":"discountRule","slug":"discount-rule","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRule","referenceFqn":"docs/ecom-v1-checkout-template.DiscountRule"},"description":"Discount rule"},{"name":"merchantDiscount","slug":"merchant-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MerchantDiscount","referenceFqn":"docs/ecom-v1-checkout-template.MerchantDiscount"},"description":"Merchant discount."}]},"properties":[{"name":"discountType","slug":"discount-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountType","referenceFqn":"docs/ecom-v1-checkout-template.DiscountType"},"description":"Discount type."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"IDs of line items the discount applies to.","replacedBy":"line_items_discounts","targetRemovalDate":"2024-06-01"},"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of line items the discount applies to."}]},"docs/ecom-v1-checkout-template.Coupon":{"name":"Coupon","fqn":"docs/ecom-v1-checkout-template.Coupon","slug":"coupon","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Coupon value."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"docs/ecom-v1-checkout-template.DiscountRule":{"name":"DiscountRule","fqn":"docs/ecom-v1-checkout-template.DiscountRule","slug":"discount-rule","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rule ID"},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Discount value."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleName","referenceFqn":"docs/ecom-v1-checkout-template.DiscountRuleName"},"description":"Discount rule name"}]},"docs/ecom-v1-checkout-template.DiscountRuleName":{"name":"DiscountRuleName","fqn":"docs/ecom-v1-checkout-template.DiscountRuleName","slug":"discount-rule-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original discount rule name (in site's default language)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated discount rule name according to buyer language. Defaults to `original` when not provided."}]},"docs/ecom-v1-checkout-template.DiscountType":{"name":"DiscountType","fqn":"docs/ecom-v1-checkout-template.DiscountType","slug":"discount-type","actions":[],"enumValues":["GLOBAL","SHIPPING","SPECIFIC_ITEMS"],"properties":[]},"docs/ecom-v1-checkout-template.LineItemDiscount":{"name":"LineItemDiscount","fqn":"docs/ecom-v1-checkout-template.LineItemDiscount","slug":"line-item-discount","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of line item the discount applies to."},{"name":"totalDiscountAmount","slug":"total-discount-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Discount value."}]},"docs/ecom-v1-checkout-template.MerchantDiscount":{"name":"MerchantDiscount","fqn":"docs/ecom-v1-checkout-template.MerchantDiscount","slug":"merchant-discount","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Discount value."},{"name":"percentage","slug":"percentage","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Discount Percentage. Will be calculated from items price before other discounts."}]},"docs/ecom-v1-checkout-template.AddressWithContact":{"name":"AddressWithContact","fqn":"docs/ecom-v1-checkout-template.AddressWithContact","slug":"address-with-contact","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-checkout-template.Address"},"description":"Address."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FullAddressContactDetails","referenceFqn":"docs/ecom-v1-checkout-template.FullAddressContactDetails"},"description":"Contact details."}]},"docs/ecom-v1-checkout-template.Address":{"name":"Address","fqn":"docs/ecom-v1-checkout-template.Address","slug":"address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-checkout-template.StreetAddress"},"description":"Street address."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-checkout-template.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-checkout-template.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-checkout-template.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-checkout-template.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"docs/ecom-v1-checkout-template.FullAddressContactDetails":{"name":"FullAddressContactDetails","fqn":"docs/ecom-v1-checkout-template.FullAddressContactDetails","slug":"full-address-contact-details","actions":[],"properties":[{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Company name."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"vatId","slug":"vat-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatId","referenceFqn":"docs/ecom-v1-checkout-template.VatId"},"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed."}]},"docs/ecom-v1-checkout-template.VatId":{"name":"VatId","fqn":"docs/ecom-v1-checkout-template.VatId","slug":"vat-id","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Customer's tax ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatType","referenceFqn":"docs/ecom-v1-checkout-template.VatType"},"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations"}]},"docs/ecom-v1-checkout-template.VatType":{"name":"VatType","fqn":"docs/ecom-v1-checkout-template.VatType","slug":"vat-type","actions":[],"enumValues":["CNPJ","CPF","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-checkout-template.BuyerInfo":{"name":"BuyerInfo","fqn":"docs/ecom-v1-checkout-template.BuyerInfo","slug":"buyer-info","actions":[],"oneofProperties":{"id":[{"name":"memberId","slug":"member-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID (if site visitor is a site member)."},{"name":"visitorId","slug":"visitor-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID (if site visitor is **not** a member)."}]},"properties":[{"name":"contactId","slug":"contact-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email address."}]},"docs/ecom-v1-checkout-template.CalculationErrors":{"name":"CalculationErrors","fqn":"docs/ecom-v1-checkout-template.CalculationErrors","slug":"calculation-errors","actions":[],"oneofProperties":{"shippingCalculationError":[{"name":"carrierErrors","slug":"carrier-errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CarrierErrors","referenceFqn":"docs/ecom-v1-checkout-template.CarrierErrors"},"description":"Carrier errors."},{"name":"generalShippingCalculationError","slug":"general-shipping-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"General shipping calculation error."}]},"properties":[{"name":"couponCalculationError","slug":"coupon-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"Coupon calculation error."},{"name":"discountsCalculationError","slug":"discounts-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"Discount Rule calculation error."},{"name":"giftCardCalculationError","slug":"gift-card-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"Gift card calculation error."},{"name":"membershipError","slug":"membership-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"Membership payment methods calculation errors\nFor example, will indicate that a line item that must be paid with membership payment doesn't have one or selected memberships are invalid"},{"name":"orderValidationErrors","slug":"order-validation-errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"docs/ecom-v1-checkout-template.ApplicationError"}},"description":"Order validation errors."},{"name":"taxCalculationError","slug":"tax-calculation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"Tax calculation error."}]},"docs/ecom-v1-checkout-template.CarrierErrors":{"name":"CarrierErrors","fqn":"docs/ecom-v1-checkout-template.CarrierErrors","slug":"carrier-errors","actions":[],"properties":[{"name":"errors","slug":"errors","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CarrierError","referenceFqn":"docs/ecom-v1-checkout-template.CarrierError"}},"description":"Carrier errors."}]},"docs/ecom-v1-checkout-template.CarrierError":{"name":"CarrierError","fqn":"docs/ecom-v1-checkout-template.CarrierError","slug":"carrier-error","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Carrier ID."},{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Details","referenceFqn":"docs/ecom-v1-checkout-template.Details"},"description":"Error details."}]},"docs/ecom-v1-checkout-template.Details":{"name":"Details","fqn":"docs/ecom-v1-checkout-template.Details","slug":"details","actions":[],"oneofProperties":{"kind":[{"name":"applicationError","slug":"application-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"docs/ecom-v1-checkout-template.ApplicationError"}},{"name":"systemError","slug":"system-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SystemError","referenceFqn":"docs/ecom-v1-checkout-template.SystemError"}},{"name":"validationError","slug":"validation-error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ValidationError","referenceFqn":"docs/ecom-v1-checkout-template.ValidationError"}}]},"properties":[{"name":"tracing","slug":"tracing","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"string"}},"description":"deprecated in API's - to enable migration from rendering arbitrary tracing to rest response"}]},"docs/ecom-v1-checkout-template.ApplicationError":{"name":"ApplicationError","fqn":"docs/ecom-v1-checkout-template.ApplicationError","slug":"application-error","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."},{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Data related to the error."},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the error."}]},"docs/ecom-v1-checkout-template.SystemError":{"name":"SystemError","fqn":"docs/ecom-v1-checkout-template.SystemError","slug":"system-error","actions":[],"properties":[{"name":"errorCode","slug":"error-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Error code."}]},"docs/ecom-v1-checkout-template.ValidationError":{"name":"ValidationError","fqn":"docs/ecom-v1-checkout-template.ValidationError","slug":"validation-error","actions":[],"properties":[{"name":"fieldViolations","slug":"field-violations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FieldViolation","referenceFqn":"docs/ecom-v1-checkout-template.FieldViolation"}}}]},"docs/ecom-v1-checkout-template.FieldViolation":{"name":"FieldViolation","fqn":"docs/ecom-v1-checkout-template.FieldViolation","slug":"field-violation","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"field","slug":"field","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"ruleName","slug":"rule-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"applicable when violated_rule=OTHER"},{"name":"violatedRule","slug":"violated-rule","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RuleType","referenceFqn":"docs/ecom-v1-checkout-template.RuleType"}}]},"docs/ecom-v1-checkout-template.RuleType":{"name":"RuleType","fqn":"docs/ecom-v1-checkout-template.RuleType","slug":"rule-type","actions":[],"enumValues":["DECIMAL_GT","DECIMAL_GTE","DECIMAL_LT","DECIMAL_LTE","DECIMAL_MAX_SCALE","FIELD_NOT_ALLOWED","FORMAT","INVALID_ENUM_VALUE","MAX","MAX_LENGTH","MAX_SIZE","MIN","MIN_LENGTH","MIN_SIZE","ONE_OF_ALIGNMENT","OTHER","REQUIRED_FIELD","VALIDATION"],"properties":[]},"docs/ecom-v1-checkout-template.ChannelType":{"name":"ChannelType","fqn":"docs/ecom-v1-checkout-template.ChannelType","slug":"channel-type","actions":[],"enumValues":["AMAZON","BACKOFFICE_MERCHANT","CLASS_PASS","EBAY","ETSY","FACEBOOK","FAIRE_COM","GLOBAL_E","OTHER_PLATFORM","POS","TIKTOK","UNSPECIFIED","WEB","WISH","WIX_APP_STORE","WIX_INVOICES"],"properties":[]},"docs/ecom-v1-checkout-template.ConversionInfo":{"name":"ConversionInfo","fqn":"docs/ecom-v1-checkout-template.ConversionInfo","slug":"conversion-info","actions":[],"properties":[{"name":"conversionRate","slug":"conversion-rate","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate used when converting from the site currency to the checkout currency."},{"name":"siteCurrency","slug":"site-currency","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The site currency."}]},"docs/ecom-v1-checkout-template.CreatedBy":{"name":"CreatedBy","fqn":"docs/ecom-v1-checkout-template.CreatedBy","slug":"created-by","actions":[],"oneofProperties":{"id":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID - when the order was created by an external application or Wix service."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID - when the order was created by a **logged in** site visitor."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User ID - when the order was created by a Wix user on behalf of a buyer.\nFor example, via POS (point of service)."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID - when the order was created by a site visitor that was **not** logged in."}]},"properties":[]},"docs/ecom-v1-checkout-template.CustomField":{"name":"CustomField","fqn":"docs/ecom-v1-checkout-template.CustomField","slug":"custom-field","actions":[],"properties":[{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom field title."},{"name":"translatedTitle","slug":"translated-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated custom field title."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Custom field value."}]},"docs/ecom-v1-checkout-template.CustomSettings":{"name":"CustomSettings","fqn":"docs/ecom-v1-checkout-template.CustomSettings","slug":"custom-settings","actions":[],"properties":[{"name":"disabledManualPayment","slug":"disabled-manual-payment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable manual payment option for this checkout.\n\nDefault: `false`"},{"name":"disabledPolicyAgreementCheckbox","slug":"disabled-policy-agreement-checkbox","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to disable policy agreement checkout in the checkout page\n\nDefault: `false`"},{"name":"lockCouponCode","slug":"lock-coupon-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to restrict the option to add or remove a coupon code on the checkout page.\n\nDefault: `false`"},{"name":"lockGiftCard","slug":"lock-gift-card","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to restrict the option to add or remove a gift card on the checkout page.\n\nDefault: `false`"}]},"docs/ecom-v1-checkout-template.GiftCard":{"name":"GiftCard","fqn":"docs/ecom-v1-checkout-template.GiftCard","slug":"gift-card","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"string"},"description":"Gift Card ID."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Gift card value."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID of the gift card provider."},{"name":"obfuscatedCode","slug":"obfuscated-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gift card obfuscated code."}]},"docs/ecom-v1-checkout-template.LineItem":{"name":"LineItem","fqn":"docs/ecom-v1-checkout-template.LineItem","slug":"line-item","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"availability","slug":"availability","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAvailabilityInfo","referenceFqn":"docs/ecom-v1-checkout-template.ItemAvailabilityInfo"},"description":"Item availability details."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-checkout-template.CatalogReference"},"description":"Catalog and item reference. Includes IDs for the item and the catalog it came from, as well as further optional info."},{"name":"consentRequiredPaymentPolicy","slug":"consent-required-payment-policy","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item payment policy that requires customer consent to complete purchase. The payment policy will be displayed on the checkout page."},{"name":"depositAmount","slug":"deposit-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Partial payment to be paid upfront during the checkout. Eligible for catalog items with `lineItem.paymentOption` type `DEPOSIT_ONLINE` only."},{"name":"descriptionLines","slug":"description-lines","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-checkout-template.DescriptionLine"}},"description":"Line item description lines. Used for display purposes for the cart, checkout and order."},{"name":"discount","slug":"discount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Discount for this line item's entire quantity."},{"name":"fullPrice","slug":"full-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Item price **before** catalog-defined discount. Defaults to `price` when not provided."},{"name":"itemType","slug":"item-type","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-checkout-template.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"lineItemPrice","slug":"line-item-price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total line item price **after** catalog-defined discount and line item discounts."},{"name":"media","slug":"media","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image details."},{"name":"paymentOption","slug":"payment-option","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentOptionType","referenceFqn":"docs/ecom-v1-checkout-template.PaymentOptionType"},"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE`: The entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE`: The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP`: Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is `0`.\n+ `DEPOSIT_ONLINE`: Partial payment to be paid upfront during the checkout. Initial amount to be paid for each line item is defined by `lineItem.deposit`.\n+ `MEMBERSHIP_OFFLINE`: Payment for this item can only be performed by using a membership and must be manually redeemed in the dashboard by the site owner. When this option is used, `lineItem.price.amount` is `0`."},{"name":"physicalProperties","slug":"physical-properties","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-checkout-template.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU, item weight, and shippability."},{"name":"price","slug":"price","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Item price **after** catalog-defined discount and line item discounts."},{"name":"priceBeforeDiscounts","slug":"price-before-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Item price **before** line item discounts and **after** catalog-defined discount. Defaults to `price` when not provided."},{"name":"priceDescription","slug":"price-description","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-checkout-template.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-checkout-template.ProductName"},"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`"},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item quantity.\n\nMin: `\"1\"`\nMax: `\"100000\"`"},{"name":"rootCatalogItemId","slug":"root-catalog-item-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"In cases where `catalogReference.catalogItemId` is NOT the actual catalog item ID, this field will return the true item's ID.\n+ For example, for Wix Bookings, `catalogReference.catalogItemId` is the booking ID. Therefore this value is set to the service ID.\n+ In most cases, this field has the same value as `catalogReference.catalogItemId`.\n+ Used in membership validation."},{"name":"savePaymentMethod","slug":"save-payment-method","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to save the payment method on the order.\n\nDefault: `false`"},{"name":"serviceProperties","slug":"service-properties","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ServiceProperties","referenceFqn":"docs/ecom-v1-checkout-template.ServiceProperties"},"description":"Service properties. When relevant, this contains information such as date and number of participants."},{"name":"taxDetails","slug":"tax-details","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-checkout-template.ItemTaxFullDetails"},"description":"Tax details for this line item."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total price after all discounts and tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total price after discounts, and before tax."},{"name":"url","slug":"url","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL to the item's page on the site."}]},"docs/ecom-v1-checkout-template.ItemAvailabilityInfo":{"name":"ItemAvailabilityInfo","fqn":"docs/ecom-v1-checkout-template.ItemAvailabilityInfo","slug":"item-availability-info","actions":[],"properties":[{"name":"quantityAvailable","slug":"quantity-available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Quantity available."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemAvailabilityStatus","referenceFqn":"docs/ecom-v1-checkout-template.ItemAvailabilityStatus"},"description":"Item availability status.\n+ `\"NOT_FOUND\"`: Item does not exist\n+ `\"NOT_AVAILABLE\"`: Item not in stock\n+ `\"PARTIALLY_AVAILABLE\"`: Available quantity is less than requested"}]},"docs/ecom-v1-checkout-template.ItemAvailabilityStatus":{"name":"ItemAvailabilityStatus","fqn":"docs/ecom-v1-checkout-template.ItemAvailabilityStatus","slug":"item-availability-status","actions":[],"enumValues":["AVAILABLE","NOT_AVAILABLE","NOT_FOUND","PARTIALLY_AVAILABLE"],"properties":[]},"docs/ecom-v1-checkout-template.Scope":{"name":"Scope","fqn":"docs/ecom-v1-checkout-template.Scope","slug":"scope","actions":[],"properties":[{"name":"group","slug":"group","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Group","referenceFqn":"docs/ecom-v1-checkout-template.Group"},"description":"Coupon scope's applied group (e.g., event or ticket in Wix Events)"},{"name":"namespace","slug":"namespace","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Scope namespace (Wix Stores, Wix Bookings, Wix Events, Wix Pricing Plans)"}]},"docs/ecom-v1-checkout-template.Group":{"name":"Group","fqn":"docs/ecom-v1-checkout-template.Group","slug":"group","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item ID (when the coupon scope is limited to just one item)."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"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)."}]},"docs/ecom-v1-checkout-template.MembershipOptions":{"name":"MembershipOptions","fqn":"docs/ecom-v1-checkout-template.MembershipOptions","slug":"membership-options","actions":[],"properties":[{"name":"eligibleMemberships","slug":"eligible-memberships","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Membership","referenceFqn":"docs/ecom-v1-checkout-template.Membership"}},"description":"Reserved for internal use."},{"name":"invalidMemberships","slug":"invalid-memberships","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InvalidMembership","referenceFqn":"docs/ecom-v1-checkout-template.InvalidMembership"}},"description":"Reserved for internal use."},{"name":"selectedMemberships","slug":"selected-memberships","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedMemberships","referenceFqn":"docs/ecom-v1-checkout-template.SelectedMemberships"},"description":"Selected membership to apply to this checkout."}]},"docs/ecom-v1-checkout-template.Membership":{"name":"Membership","fqn":"docs/ecom-v1-checkout-template.Membership","slug":"membership","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Membership ID."},{"name":"additionalData","slug":"additional-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional data about this membership."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the application providing this payment option."},{"name":"credits","slug":"credits","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipPaymentCredits","referenceFqn":"docs/ecom-v1-checkout-template.MembershipPaymentCredits"},"description":"Optional - For a membership that has limited credits, information about credit usage."},{"name":"expirationDate","slug":"expiration-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Optional - TMembership expiry date."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Line item IDs which are \"paid\" for by this membership."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipName","referenceFqn":"docs/ecom-v1-checkout-template.MembershipName"},"description":"The name of this membership."}]},"docs/ecom-v1-checkout-template.MembershipPaymentCredits":{"name":"MembershipPaymentCredits","fqn":"docs/ecom-v1-checkout-template.MembershipPaymentCredits","slug":"membership-payment-credits","actions":[],"properties":[{"name":"remaining","slug":"remaining","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"How much credit remained for this membership"},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"How much credit this membership has in total"}]},"docs/ecom-v1-checkout-template.MembershipName":{"name":"MembershipName","fqn":"docs/ecom-v1-checkout-template.MembershipName","slug":"membership-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of this membership"},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - Translated name of this membership. Defaults to `original` when not provided."}]},"docs/ecom-v1-checkout-template.InvalidMembership":{"name":"InvalidMembership","fqn":"docs/ecom-v1-checkout-template.InvalidMembership","slug":"invalid-membership","actions":[],"properties":[{"name":"membership","slug":"membership","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Membership","referenceFqn":"docs/ecom-v1-checkout-template.Membership"},"description":"Membership details."},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reason why this membership is invalid and cannot be used."}]},"docs/ecom-v1-checkout-template.SelectedMemberships":{"name":"SelectedMemberships","fqn":"docs/ecom-v1-checkout-template.SelectedMemberships","slug":"selected-memberships","actions":[],"properties":[{"name":"memberships","slug":"memberships","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SelectedMembership","referenceFqn":"docs/ecom-v1-checkout-template.SelectedMembership"}},"description":"Selected memberships."}]},"docs/ecom-v1-checkout-template.SelectedMembership":{"name":"SelectedMembership","fqn":"docs/ecom-v1-checkout-template.SelectedMembership","slug":"selected-membership","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Membership ID."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing this payment option."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the line items this membership applies to."}]},"docs/ecom-v1-checkout-template.PriceSummary":{"name":"PriceSummary","fqn":"docs/ecom-v1-checkout-template.PriceSummary","slug":"price-summary","actions":[],"properties":[{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total additional fees price before tax."},{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total calculated discount value."},{"name":"shipping","slug":"shipping","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total shipping price, before discounts and before tax."},{"name":"subtotal","slug":"subtotal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Subtotal of all line items, before discounts and before tax."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total tax."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total price after discounts, gift cards, and tax."}]},"docs/ecom-v1-checkout-template.ShippingInfo":{"name":"ShippingInfo","fqn":"docs/ecom-v1-checkout-template.ShippingInfo","slug":"shipping-info","actions":[],"properties":[{"name":"carrierServiceOptions","slug":"carrier-service-options","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CarrierServiceOption","referenceFqn":"docs/ecom-v1-checkout-template.CarrierServiceOption"}},"description":"All carrier options for this shipping rule."},{"name":"region","slug":"region","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingRegion","referenceFqn":"docs/ecom-v1-checkout-template.ShippingRegion"},"description":"Shipping region. Based on the address provided."},{"name":"selectedCarrierServiceOption","slug":"selected-carrier-service-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedCarrierServiceOption","referenceFqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOption"},"description":"Selected option out of the options allowed for the `region`."},{"name":"shippingDestination","slug":"shipping-destination","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-checkout-template.AddressWithContact"},"description":"Shipping address and contact details."}]},"docs/ecom-v1-checkout-template.CarrierServiceOption":{"name":"CarrierServiceOption","fqn":"docs/ecom-v1-checkout-template.CarrierServiceOption","slug":"carrier-service-option","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Carrier ID."},{"name":"shippingOptions","slug":"shipping-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ShippingOption","referenceFqn":"docs/ecom-v1-checkout-template.ShippingOption"}},"description":"Shipping options offered by this carrier for this request."}]},"docs/ecom-v1-checkout-template.ShippingOption":{"name":"ShippingOption","fqn":"docs/ecom-v1-checkout-template.ShippingOption","slug":"shipping-option","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique code of provided shipping option like \"usps_std_overnight\".\nFor legacy calculators this would be the UUID of the option."},{"name":"cost","slug":"cost","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingPrice","referenceFqn":"docs/ecom-v1-checkout-template.ShippingPrice"},"description":"Sipping price information."},{"name":"logistics","slug":"logistics","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryLogistics","referenceFqn":"docs/ecom-v1-checkout-template.DeliveryLogistics"},"description":"Delivery logistics."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\nFor example, \"Standard\" or \"First-Class Package International\"."}]},"docs/ecom-v1-checkout-template.ShippingPrice":{"name":"ShippingPrice","fqn":"docs/ecom-v1-checkout-template.ShippingPrice","slug":"shipping-price","actions":[],"properties":[{"name":"otherCharges","slug":"other-charges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OtherCharge","referenceFqn":"docs/ecom-v1-checkout-template.OtherCharge"}},"description":"Other costs such as insurance, handling & packaging for fragile items, etc."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Shipping price."}]},"docs/ecom-v1-checkout-template.OtherCharge":{"name":"OtherCharge","fqn":"docs/ecom-v1-checkout-template.OtherCharge","slug":"other-charge","actions":[],"properties":[{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Price of added cost."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChargeType","referenceFqn":"docs/ecom-v1-checkout-template.ChargeType"},"description":"Type of additional cost."}]},"docs/ecom-v1-checkout-template.ChargeType":{"name":"ChargeType","fqn":"docs/ecom-v1-checkout-template.ChargeType","slug":"charge-type","actions":[],"enumValues":["HANDLING_FEE","INSURANCE"],"properties":[]},"docs/ecom-v1-checkout-template.DeliveryLogistics":{"name":"DeliveryLogistics","fqn":"docs/ecom-v1-checkout-template.DeliveryLogistics","slug":"delivery-logistics","actions":[],"properties":[{"name":"deliveryTime","slug":"delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Expected delivery time, in free text. For example, \"3-5 business days\"."},{"name":"instructions","slug":"instructions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Instructions for caller, e.g for pickup: \"Please deliver during opening hours, and please don't park in disabled parking spot\"."},{"name":"pickupDetails","slug":"pickup-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupDetails","referenceFqn":"docs/ecom-v1-checkout-template.PickupDetails"},"description":"Pickup details."}]},"docs/ecom-v1-checkout-template.DeliveryTimeSlot":{"name":"DeliveryTimeSlot","fqn":"docs/ecom-v1-checkout-template.DeliveryTimeSlot","slug":"delivery-time-slot","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"starting time of the delivery time slot"},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"ending time of the delivery time slot"}]},"docs/ecom-v1-checkout-template.PickupDetails":{"name":"PickupDetails","fqn":"docs/ecom-v1-checkout-template.PickupDetails","slug":"pickup-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-checkout-template.Address"},"description":"Pickup address."},{"name":"businessLocation","slug":"business-location","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the pickup address is that of a business - this may effect tax calculation."},{"name":"pickupMethod","slug":"pickup-method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupMethod","referenceFqn":"docs/ecom-v1-checkout-template.PickupMethod"},"description":"Pickup method"}]},"docs/ecom-v1-checkout-template.PickupMethod":{"name":"PickupMethod","fqn":"docs/ecom-v1-checkout-template.PickupMethod","slug":"pickup-method","actions":[],"enumValues":["PICKUP_POINT","STORE_PICKUP","UNKNOWN_METHOD"],"properties":[]},"docs/ecom-v1-checkout-template.ShippingRegion":{"name":"ShippingRegion","fqn":"docs/ecom-v1-checkout-template.ShippingRegion","slug":"shipping-region","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping region ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping region name."}]},"docs/ecom-v1-checkout-template.SelectedCarrierServiceOption":{"name":"SelectedCarrierServiceOption","fqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOption","slug":"selected-carrier-service-option","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"This carrier's unique ID"},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique identifier of selected option. For example, \"usps_std_overnight\"."},{"name":"cost","slug":"cost","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedCarrierServiceOptionPrices","referenceFqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionPrices"},"description":"Shipping costs."},{"name":"logistics","slug":"logistics","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryLogistics","referenceFqn":"docs/ecom-v1-checkout-template.DeliveryLogistics"},"description":"Delivery logistics."},{"name":"otherCharges","slug":"other-charges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"SelectedCarrierServiceOptionOtherCharge","referenceFqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionOtherCharge"}},"description":"Other charges"},{"name":"requestedShippingOption","slug":"requested-shipping-option","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Were we able to find the requested shipping option, or otherwise we fallback to the default one (the first)"},{"name":"title","slug":"title","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Title of the option, such as USPS Standard Overnight Delivery (in the requested locale).\nFor example, \"Standard\" or \"First-Class Package International\"."}]},"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionPrices":{"name":"SelectedCarrierServiceOptionPrices","fqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionPrices","slug":"selected-carrier-service-option-prices","actions":[],"properties":[{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Shipping price before discount and before tax."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-checkout-template.ItemTaxFullDetails"},"description":"Tax details."},{"name":"totalDiscount","slug":"total-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Shipping discount before tax."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total shipping price, after discount and after tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Total price of shipping after discounts (when relevant), and before tax."}]},"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionOtherCharge":{"name":"SelectedCarrierServiceOptionOtherCharge","fqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionOtherCharge","slug":"selected-carrier-service-option-other-charge","actions":[],"properties":[{"name":"cost","slug":"cost","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SelectedCarrierServiceOptionPrices","referenceFqn":"docs/ecom-v1-checkout-template.SelectedCarrierServiceOptionPrices"},"description":"Price of added charge."},{"name":"details","slug":"details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Details of the charge, such as 'Full Coverage Insurance of up to 80% of value of shipment'."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChargeType","referenceFqn":"docs/ecom-v1-checkout-template.ChargeType"},"description":"Type of additional cost."}]},"docs/ecom-v1-checkout-template.TaxSummary":{"name":"TaxSummary","fqn":"docs/ecom-v1-checkout-template.TaxSummary","slug":"tax-summary","actions":[],"properties":[{"name":"calculationDetails","slug":"calculation-details","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"REFERENCE","name":"TaxCalculationDetails","referenceFqn":"docs/ecom-v1-checkout-template.TaxCalculationDetails"},"description":"Tax calculator that was active when the order was created."},{"name":"taxableAmount","slug":"taxable-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Amount for which tax is calculated, added from line items."},{"name":"totalTax","slug":"total-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"Calculated tax, added from line items."}]},"docs/ecom-v1-checkout-template.AggregatedTaxBreakdown":{"name":"AggregatedTaxBreakdown","fqn":"docs/ecom-v1-checkout-template.AggregatedTaxBreakdown","slug":"aggregated-tax-breakdown","actions":[],"properties":[{"name":"aggregatedTaxAmount","slug":"aggregated-tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MultiCurrencyPrice","referenceFqn":"docs/ecom-v1-checkout-template.MultiCurrencyPrice"},"description":"The sum of all the tax from line items that calculated by the tax identifiers."},{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the jurisdiction in which this tax detail applies."},{"name":"jurisdictionTypeEnum","slug":"jurisdiction-type-enum","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-checkout-template.JurisdictionType"},"description":"The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special)."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate at which this tax detail was calculated, e.g 0.1000 signifies 10% tax and 2.000 signifies 200% tax. (Decimal value)"},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws."}]},"docs/ecom-v1-checkout-template.TaxCalculationDetails":{"name":"TaxCalculationDetails","fqn":"docs/ecom-v1-checkout-template.TaxCalculationDetails","slug":"tax-calculation-details","actions":[],"oneofProperties":{"calculationDetails":[{"name":"autoTaxFallbackDetails","slug":"auto-tax-fallback-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AutoTaxFallbackCalculationDetails","referenceFqn":"docs/ecom-v1-checkout-template.AutoTaxFallbackCalculationDetails"},"description":"Details of the fallback rate calculation."},{"name":"manualRateReason","slug":"manual-rate-reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManualCalculationReason","referenceFqn":"docs/ecom-v1-checkout-template.ManualCalculationReason"},"description":"Reason the manual calculation was used."}]},"properties":[{"name":"rateType","slug":"rate-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RateType","referenceFqn":"docs/ecom-v1-checkout-template.RateType"},"description":"Rate calculation type."}]},"docs/ecom-v1-checkout-template.AutoTaxFallbackCalculationDetails":{"name":"AutoTaxFallbackCalculationDetails","fqn":"docs/ecom-v1-checkout-template.AutoTaxFallbackCalculationDetails","slug":"auto-tax-fallback-calculation-details","actions":[],"properties":[{"name":"error","slug":"error","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ApplicationError","referenceFqn":"docs/ecom-v1-checkout-template.ApplicationError"},"description":"invalid request (i.e. address), timeout, internal error, license error, and others will be encoded here"},{"name":"fallbackReason","slug":"fallback-reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FallbackReason","referenceFqn":"docs/ecom-v1-checkout-template.FallbackReason"},"description":"reason for fallback"}]},"docs/ecom-v1-checkout-template.FallbackReason":{"name":"FallbackReason","fqn":"docs/ecom-v1-checkout-template.FallbackReason","slug":"fallback-reason","actions":[],"enumValues":["AUTO_TAX_DEACTIVATED","AUTO_TAX_FAILED"],"properties":[]},"docs/ecom-v1-checkout-template.ManualCalculationReason":{"name":"ManualCalculationReason","fqn":"docs/ecom-v1-checkout-template.ManualCalculationReason","slug":"manual-calculation-reason","actions":[],"enumValues":["GLOBAL_SETTING_TO_MANUAL","REGION_SETTING_TO_MANUAL"],"properties":[]},"docs/ecom-v1-checkout-template.RateType":{"name":"RateType","fqn":"docs/ecom-v1-checkout-template.RateType","slug":"rate-type","actions":[],"enumValues":["AUTO_RATE","FALLBACK_RATE","MANUAL_RATE","NO_TAX_COLLECTED"],"properties":[]},"docs/ecom-v1-checkout-template.Violation":{"name":"Violation","fqn":"docs/ecom-v1-checkout-template.Violation","slug":"violation","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Violation description. Can include rich text. Only HTTP or HTTPS links in the following format are allowed: `Click me`."},{"name":"severity","slug":"severity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Severity","referenceFqn":"docs/ecom-v1-checkout-template.Severity"},"description":"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."},{"name":"target","slug":"target","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Target","referenceFqn":"docs/ecom-v1-checkout-template.Target"},"description":"Target location on a checkout or cart page where the violation will be displayed."}]},"docs/ecom-v1-checkout-template.Severity":{"name":"Severity","fqn":"docs/ecom-v1-checkout-template.Severity","slug":"severity","actions":[],"enumValues":["ERROR","WARNING"],"properties":[]},"docs/ecom-v1-checkout-template.Target":{"name":"Target","fqn":"docs/ecom-v1-checkout-template.Target","slug":"target","actions":[],"oneofProperties":{"targetType":[{"name":"lineItem","slug":"line-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TargetLineItem","referenceFqn":"docs/ecom-v1-checkout-template.TargetLineItem"},"description":"Specific line item violation."},{"name":"other","slug":"other","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Other","referenceFqn":"docs/ecom-v1-checkout-template.Other"},"description":"General (other) violation."}]},"properties":[]},"docs/ecom-v1-checkout-template.TargetLineItem":{"name":"TargetLineItem","fqn":"docs/ecom-v1-checkout-template.TargetLineItem","slug":"target-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the line item containing the violation."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location on a checkout or a cart page where the specific line item violation will be displayed."}]},"docs/ecom-v1-checkout-template.Other":{"name":"Other","fqn":"docs/ecom-v1-checkout-template.Other","slug":"other","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location on a checkout or a cart page where a general (other) violation will be displayed."}]},"docs/ecom-v1-checkout-template.WeightUnit":{"name":"WeightUnit","fqn":"docs/ecom-v1-checkout-template.WeightUnit","slug":"weight-unit","actions":[],"enumValues":["KG","LB","UNSPECIFIED_WEIGHT_UNIT"],"properties":[]},"docs/ecom-v1-delivery-profile.DeliveryProfileCreated":{"name":"DeliveryProfileCreated","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfileCreated","slug":"delivery-profile-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryProfile","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryProfile"},"description":"Created delivery profile."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-delivery-profile.DeliveryProfile":{"name":"DeliveryProfile","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfile","slug":"delivery-profile","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the DeliveryProfile was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"DeliveryProfile ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the DeliveryProfile was last updated."},{"name":"default","slug":"default","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that this DeliveryProfile is the default DeliveryProfile."},{"name":"deliveryRegions","slug":"delivery-regions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DeliveryRegion","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryRegion"}},"description":"A list of DeliveryProfile regions."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-delivery-profile.ExtendedFields"},"description":"Extended fields."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"DeliveryProfile name."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"DeliveryProfile revision."}]},"docs/ecom-v1-delivery-profile.DeliveryRegion":{"name":"DeliveryRegion","fqn":"docs/ecom-v1-delivery-profile.DeliveryRegion","slug":"delivery-region","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Represents the time this Profile was created"},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The delivery region id."},{"name":"active","slug":"active","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that this rule is active, default value is true."},{"name":"deliveryCarriers","slug":"delivery-carriers","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DeliveryCarrier","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryCarrier"}},"description":"The spi implementers id of shipping-rates spi, assigned to this rule."},{"name":"destinations","slug":"destinations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Destination","referenceFqn":"docs/ecom-v1-delivery-profile.Destination"}},"description":"The operation region of this rule, if empty than it is global."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional name of the rule, for example: \"Domestic\"."}]},"docs/ecom-v1-delivery-profile.DeliveryCarrier":{"name":"DeliveryCarrier","fqn":"docs/ecom-v1-delivery-profile.DeliveryCarrier","slug":"delivery-carrier","actions":[],"properties":[{"name":"additionalCharges","slug":"additional-charges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalCharge","referenceFqn":"docs/ecom-v1-delivery-profile.AdditionalCharge"}},"description":"Additional charges to add to the delivery rate for this carrier"},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"AppDefId of the provider as it is registered in Wix Dev Center. Can be fetched by listDeliveryProvider api."},{"name":"backupRate","slug":"backup-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackupRate","referenceFqn":"docs/ecom-v1-delivery-profile.BackupRate"},"description":"Backup rate to be used in case the cost returned by the provider is empty."}]},"docs/ecom-v1-delivery-profile.AdditionalCharge":{"name":"AdditionalCharge","fqn":"docs/ecom-v1-delivery-profile.AdditionalCharge","slug":"additional-charge","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description of the additional charge. For example, `\"Handling fee of $5 applied for gift wrapping\"`."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cost of additional charge. For example, `12.5`."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional charge type."}]},"docs/ecom-v1-delivery-profile.BackupRate":{"name":"BackupRate","fqn":"docs/ecom-v1-delivery-profile.BackupRate","slug":"backup-rate","actions":[],"properties":[{"name":"enabled","slug":"enabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Should the default rate be used. Default value is false."},{"name":"prefix","slug":"prefix","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Default rate prefix that will concatenate to the delivery options the provider will offer."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Default rate price for all delivery options that the provider will offer."}]},"docs/ecom-v1-delivery-profile.Destination":{"name":"Destination","fqn":"docs/ecom-v1-delivery-profile.Destination","slug":"destination","actions":[],"properties":[{"name":"countryCode","slug":"country-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"2-letters code represents the country of the delivery destinations"},{"name":"subdivisions","slug":"subdivisions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).\nIf empty, the rule applies to the entire country."}]},"docs/ecom-v1-delivery-profile.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-delivery-profile.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-delivery-profile.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-delivery-profile.DeliveryProfileDeleted":{"name":"DeliveryProfileDeleted","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfileDeleted","slug":"delivery-profile-deleted","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryProfile","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryProfile"},"description":"Deleted delivery profile."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-delivery-profile.DeliveryProfileDeliveryRegionAdded":{"name":"DeliveryProfileDeliveryRegionAdded","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfileDeliveryRegionAdded","slug":"delivery-profile-delivery-region-added","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryRegionAdded","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryRegionAdded"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-delivery-profile.DeliveryRegionAdded":{"name":"DeliveryRegionAdded","fqn":"docs/ecom-v1-delivery-profile.DeliveryRegionAdded","slug":"delivery-region-added","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Represents the time this Profile was created"},{"name":"active","slug":"active","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that this rule is active, default value is true."},{"name":"deliveryCarriers","slug":"delivery-carriers","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DeliveryCarrier","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryCarrier"}},"description":"The spi implementers id of shipping-rates spi, assigned to this rule."},{"name":"deliveryProfileId","slug":"delivery-profile-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The DeliveryProfile owns this region."},{"name":"deliveryRegionId","slug":"delivery-region-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The delivery region id."},{"name":"destinations","slug":"destinations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Destination","referenceFqn":"docs/ecom-v1-delivery-profile.Destination"}},"description":"The operation region of this rule, if empty than it is global."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional name of the rule, for example: \"Domestic\"."}]},"docs/ecom-v1-delivery-profile.DeliveryProfileDeliveryRegionRemoved":{"name":"DeliveryProfileDeliveryRegionRemoved","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfileDeliveryRegionRemoved","slug":"delivery-profile-delivery-region-removed","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryRegionRemoved","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryRegionRemoved"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-delivery-profile.DeliveryRegionRemoved":{"name":"DeliveryRegionRemoved","fqn":"docs/ecom-v1-delivery-profile.DeliveryRegionRemoved","slug":"delivery-region-removed","actions":[],"properties":[{"name":"deliveryProfileId","slug":"delivery-profile-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The DeliveryProfile owns this region."},{"name":"deliveryRegionId","slug":"delivery-region-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The removed DeliveryRegion id."}]},"docs/ecom-v1-delivery-profile.DeliveryProfileDeliveryRegionUpdated":{"name":"DeliveryProfileDeliveryRegionUpdated","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfileDeliveryRegionUpdated","slug":"delivery-profile-delivery-region-updated","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryRegionUpdated","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryRegionUpdated"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-delivery-profile.DeliveryRegionUpdated":{"name":"DeliveryRegionUpdated","fqn":"docs/ecom-v1-delivery-profile.DeliveryRegionUpdated","slug":"delivery-region-updated","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Represents the time this Profile was created"},{"name":"active","slug":"active","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that this rule is active, default value is true."},{"name":"deliveryCarriers","slug":"delivery-carriers","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DeliveryCarrier","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryCarrier"}},"description":"The spi implementers id of shipping-rates spi, assigned to this rule."},{"name":"deliveryProfileId","slug":"delivery-profile-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The DeliveryProfile owns this DeliveryRegion."},{"name":"deliveryRegionId","slug":"delivery-region-id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The delivery region id."},{"name":"destinations","slug":"destinations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Destination","referenceFqn":"docs/ecom-v1-delivery-profile.Destination"}},"description":"The operation region of this rule, if empty than it is global."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional name of the rule, for example: \"Domestic\"."}]},"docs/ecom-v1-delivery-profile.DeliveryProfileUpdated":{"name":"DeliveryProfileUpdated","fqn":"docs/ecom-v1-delivery-profile.DeliveryProfileUpdated","slug":"delivery-profile-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryProfile","referenceFqn":"docs/ecom-v1-delivery-profile.DeliveryProfile"},"description":"Updated delivery profile."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-delivery-profile.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-draft-order.DraftOrderCreated":{"name":"DraftOrderCreated","fqn":"docs/ecom-v1-draft-order.DraftOrderCreated","slug":"draft-order-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DraftOrder","referenceFqn":"docs/ecom-v1-draft-order.DraftOrder"},"description":"Created draft order."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-draft-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-draft-order.DraftOrder":{"name":"DraftOrder","fqn":"docs/ecom-v1-draft-order.DraftOrder","slug":"draft-order","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the draft order was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Draft order ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the draft order was updated."},{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalFeeDetails","referenceFqn":"docs/ecom-v1-draft-order.AdditionalFeeDetails"}},"description":"Additional fees.\nIncludes details about the source, and whether the additional fee is applied to the order."},{"name":"balanceSummary","slug":"balance-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BalanceSummary","referenceFqn":"docs/ecom-v1-draft-order.BalanceSummary"},"description":"Balance summary."},{"name":"billingInfo","slug":"billing-info","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Billing address and contact details.","replacedBy":"billing_info_details","targetRemovalDate":"2024-08-30"},"type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-draft-order.AddressWithContact"},"description":"Billing address and contact details."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Buyer information.","replacedBy":"buyer_info_details","targetRemovalDate":"2024-08-30"},"type":{"kind":"REFERENCE","name":"BuyerInfo","referenceFqn":"docs/ecom-v1-draft-order.BuyerInfo"},"description":"Buyer information."},{"name":"commitSettings","slug":"commit-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DraftOrderCommitSettings","referenceFqn":"docs/ecom-v1-draft-order.DraftOrderCommitSettings"},"description":"Side effects to perform on commit."},{"name":"createdBy","slug":"created-by","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreatedBy","referenceFqn":"docs/ecom-v1-draft-order.CreatedBy"},"description":"Identity of the draft order's initiator."},{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency used for pricing."},{"name":"discounts","slug":"discounts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DiscountDetails","referenceFqn":"docs/ecom-v1-draft-order.DiscountDetails"}},"description":"Discounts.\nIncludes details about the source, and whether the discount is applied to the order."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-draft-order.ExtendedFields"},"description":"Custom field data for the draft order object.\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls."},{"name":"lineItems","slug":"line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ItemDetails","referenceFqn":"docs/ecom-v1-draft-order.ItemDetails"}},"description":"Line items.\nIncludes details about changes when relevant."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID (if order created by a member)."},{"name":"orderId","slug":"order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the order this draft commits to."},{"name":"priceSummary","slug":"price-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-draft-order.PriceSummary"},"description":"Price summary."},{"name":"purchaseFlowId","slug":"purchase-flow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order."},{"name":"recipientInfo","slug":"recipient-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RecipientInfoDetails","referenceFqn":"docs/ecom-v1-draft-order.RecipientInfoDetails"}},{"name":"shippingInfo","slug":"shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingDetails","referenceFqn":"docs/ecom-v1-draft-order.ShippingDetails"},"description":"Shipping info.\nIncludes details about changes when relevant."},{"name":"status","slug":"status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EditingStatus","referenceFqn":"docs/ecom-v1-draft-order.EditingStatus"},"description":"Draft order status."},{"name":"taxSummary","slug":"tax-summary","isReadOnly":true,"isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Deprecated. Use ","replacedBy":"tax_info","targetRemovalDate":"2024-09-30"},"type":{"kind":"REFERENCE","name":"TaxSummary","referenceFqn":"docs/ecom-v1-draft-order.TaxSummary"},"description":"Deprecated. Use `taxInfo` instead.\nThis field will be removed on September 30, 2024.\nTax summary."},{"name":"weightUnit","slug":"weight-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WeightUnit","referenceFqn":"docs/ecom-v1-draft-order.WeightUnit"},"description":"Weight measurement unit. Defaults to the site's weight unit."}]},"docs/ecom-v1-draft-order.AdditionalFeeDetails":{"name":"AdditionalFeeDetails","fqn":"docs/ecom-v1-draft-order.AdditionalFeeDetails","slug":"additional-fee-details","actions":[],"properties":[{"name":"additionalFee","slug":"additional-fee","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AdditionalFee","referenceFqn":"docs/ecom-v1-draft-order.AdditionalFee"},"description":"Additional fee."},{"name":"applied","slug":"applied","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this additional fee is applied to the order."},{"name":"source","slug":"source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SourceType","referenceFqn":"docs/ecom-v1-draft-order.SourceType"},"description":"Source of the additional fee.\n\nSupported values:\n+ `ORIGINAL_ORDER`: This additional fee is part of the original order.\n+ `CUSTOM`: This additional fee was created by the [Create Custom Additional Fees](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-additional-fees) API."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TaxDetails","referenceFqn":"docs/ecom-v1-draft-order.TaxDetails"},"description":"Tax details related to the additional fee."}]},"docs/ecom-v1-draft-order.AdditionalFee":{"name":"AdditionalFee","fqn":"docs/ecom-v1-draft-order.AdditionalFee","slug":"additional-fee","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee's id."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee's unique code for future processing."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Optional - Line items associated with this additional fee.\nIf no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of additional fee."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Additional fee's price."},{"name":"priceAfterTax","slug":"price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Additional fee's price after tax."},{"name":"priceBeforeTax","slug":"price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Additional fee's price before tax."},{"name":"providerAppId","slug":"provider-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"SPI implementer's `appId`."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-draft-order.ItemTaxFullDetails"},"description":"Tax details."}]},"docs/ecom-v1-draft-order.Price":{"name":"Price","fqn":"docs/ecom-v1-draft-order.Price","slug":"price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."}]},"docs/ecom-v1-draft-order.ItemTaxFullDetails":{"name":"ItemTaxFullDetails","fqn":"docs/ecom-v1-draft-order.ItemTaxFullDetails","slug":"item-tax-full-details","actions":[],"properties":[{"name":"taxRate","slug":"tax-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate percentage, as a decimal numeral between 0 and 1. For example, `\"0.13\"`."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Taxable amount of this line item."},{"name":"totalTax","slug":"total-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"The calculated tax, based on the `taxableAmount` and `taxRate`."}]},"docs/ecom-v1-draft-order.SourceType":{"name":"SourceType","fqn":"docs/ecom-v1-draft-order.SourceType","slug":"source-type","actions":[],"enumValues":["AUTOMATIC","CUSTOM","ORIGINAL_ORDER"],"properties":[]},"docs/ecom-v1-draft-order.TaxDetails":{"name":"TaxDetails","fqn":"docs/ecom-v1-draft-order.TaxDetails","slug":"tax-details","actions":[],"properties":[{"name":"taxGroupId","slug":"tax-group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional tax group ID to use when calculating tax for this additional fee"},{"name":"taxable","slug":"taxable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indication if additional fee is taxable or not"}]},"docs/ecom-v1-draft-order.BalanceSummary":{"name":"BalanceSummary","fqn":"docs/ecom-v1-draft-order.BalanceSummary","slug":"balance-summary","actions":[],"properties":[{"name":"balance","slug":"balance","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Balance","referenceFqn":"docs/ecom-v1-draft-order.Balance"},"description":"Amount left to pay for order to be considered paid."}]},"docs/ecom-v1-draft-order.Balance":{"name":"Balance","fqn":"docs/ecom-v1-draft-order.Balance","slug":"balance","actions":[],"properties":[{"name":"amount","slug":"amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Balance amount.\n\nA negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."}]},"docs/ecom-v1-draft-order.BillingDetails":{"name":"BillingDetails","fqn":"docs/ecom-v1-draft-order.BillingDetails","slug":"billing-details","actions":[],"oneofProperties":{"changeType":[]},"properties":[]},"docs/ecom-v1-draft-order.AddressWithContact":{"name":"AddressWithContact","fqn":"docs/ecom-v1-draft-order.AddressWithContact","slug":"address-with-contact","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-draft-order.Address"},"description":"Address."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FullAddressContactDetails","referenceFqn":"docs/ecom-v1-draft-order.FullAddressContactDetails"},"description":"Contact details."}]},"docs/ecom-v1-draft-order.Address":{"name":"Address","fqn":"docs/ecom-v1-draft-order.Address","slug":"address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-draft-order.StreetAddress"},"description":"Street address."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-draft-order.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-draft-order.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-draft-order.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-draft-order.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"docs/ecom-v1-draft-order.FullAddressContactDetails":{"name":"FullAddressContactDetails","fqn":"docs/ecom-v1-draft-order.FullAddressContactDetails","slug":"full-address-contact-details","actions":[],"properties":[{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Company name."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"vatId","slug":"vat-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatId","referenceFqn":"docs/ecom-v1-draft-order.VatId"},"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed."}]},"docs/ecom-v1-draft-order.VatId":{"name":"VatId","fqn":"docs/ecom-v1-draft-order.VatId","slug":"vat-id","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Customer's tax ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatType","referenceFqn":"docs/ecom-v1-draft-order.VatType"},"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations"}]},"docs/ecom-v1-draft-order.VatType":{"name":"VatType","fqn":"docs/ecom-v1-draft-order.VatType","slug":"vat-type","actions":[],"enumValues":["CNPJ","CPF","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-draft-order.BillingChangedDetails":{"name":"BillingChangedDetails","fqn":"docs/ecom-v1-draft-order.BillingChangedDetails","slug":"billing-changed-details","actions":[],"properties":[]},"docs/ecom-v1-draft-order.BuyerDetails":{"name":"BuyerDetails","fqn":"docs/ecom-v1-draft-order.BuyerDetails","slug":"buyer-details","actions":[],"oneofProperties":{"changeType":[]},"properties":[]},"docs/ecom-v1-draft-order.BuyerInfo":{"name":"BuyerInfo","fqn":"docs/ecom-v1-draft-order.BuyerInfo","slug":"buyer-info","actions":[],"oneofProperties":{"id":[{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID (if site visitor is a site member)."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID (if site visitor is not a member)."}]},"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email address."}]},"docs/ecom-v1-draft-order.BuyerChangedDetails":{"name":"BuyerChangedDetails","fqn":"docs/ecom-v1-draft-order.BuyerChangedDetails","slug":"buyer-changed-details","actions":[],"properties":[]},"docs/ecom-v1-draft-order.DraftOrderCommitSettings":{"name":"DraftOrderCommitSettings","fqn":"docs/ecom-v1-draft-order.DraftOrderCommitSettings","slug":"draft-order-commit-settings","actions":[],"properties":[{"name":"addActivitiesToOrder","slug":"add-activities-to-order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to add activities to the order.\n\nDefault: `true`"},{"name":"sendNotificationsToBusiness","slug":"send-notifications-to-business","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to send notifications to the business.\n\nDefault: `true`"},{"name":"sendNotificationsToBuyer","slug":"send-notifications-to-buyer","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to send notifications to the buyer.\n\nDefault: `true`"},{"name":"sendNotificationsToCustomFulfillers","slug":"send-notifications-to-custom-fulfillers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to send email notifications to custom fulfillers when there is a change in the shippable items they fulfill.\n\nDefault: `true`"},{"name":"updateInventory","slug":"update-inventory","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InventoryUpdate","referenceFqn":"docs/ecom-v1-draft-order.InventoryUpdate"}},"description":"Line item IDs for which to perform an inventory change.\nWhen not provided, inventory will not change."}]},"docs/ecom-v1-draft-order.InventoryUpdate":{"name":"InventoryUpdate","fqn":"docs/ecom-v1-draft-order.InventoryUpdate","slug":"inventory-update","actions":[],"properties":[{"name":"lineItemId","slug":"line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."}]},"docs/ecom-v1-draft-order.CreatedBy":{"name":"CreatedBy","fqn":"docs/ecom-v1-draft-order.CreatedBy","slug":"created-by","actions":[],"oneofProperties":{"string":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID. When the draft order was created by an app."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User ID. When the draft order was created by a Wix user."}]},"properties":[]},"docs/ecom-v1-draft-order.DiscountDetails":{"name":"DiscountDetails","fqn":"docs/ecom-v1-draft-order.DiscountDetails","slug":"discount-details","actions":[],"properties":[{"name":"applied","slug":"applied","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this discount is applied to the order."},{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppliedDiscount","referenceFqn":"docs/ecom-v1-draft-order.AppliedDiscount"},"description":"Discount details."},{"name":"source","slug":"source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SourceType","referenceFqn":"docs/ecom-v1-draft-order.SourceType"},"description":"Source of the discount.\n\nSupported values:\n+ `ORIGINAL_ORDER`: This discount is part of the original order.\n+ `CUSTOM`: This discount was created by the [Create Custom Discounts](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/draft-orders/create-custom-discounts) API."}]},"docs/ecom-v1-draft-order.AppliedDiscount":{"name":"AppliedDiscount","fqn":"docs/ecom-v1-draft-order.AppliedDiscount","slug":"applied-discount","actions":[],"oneofProperties":{"discountSource":[{"name":"coupon","slug":"coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Coupon","referenceFqn":"docs/ecom-v1-draft-order.Coupon"},"description":"Applied coupon info."},{"name":"discountRule","slug":"discount-rule","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRule","referenceFqn":"docs/ecom-v1-draft-order.DiscountRule"},"description":"Automatic Discount"},{"name":"merchantDiscount","slug":"merchant-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MerchantDiscount","referenceFqn":"docs/ecom-v1-draft-order.MerchantDiscount"},"description":"Merchant discount."}]},"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount id."},{"name":"discountType","slug":"discount-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppliedDiscountDiscountType","referenceFqn":"docs/ecom-v1-draft-order.AppliedDiscountDiscountType"},"description":"Discount type.\n* `\"GLOBAL\"` - discount applies to entire order.\n* `\"SPECIFIC-ITEMS\"` - discount applies to specific items.\n* `\"SHIPPING\"` - discount applies to shipping. For example, free shipping."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"IDs of line items discount applies to.\nDeprecated. Use ","replacedBy":"line_item_discounts","targetRemovalDate":"2024-10-30"},"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of line items discount applies to.\nDeprecated. Use `line_item_discounts` instead."}]},"docs/ecom-v1-draft-order.Coupon":{"name":"Coupon","fqn":"docs/ecom-v1-draft-order.Coupon","slug":"coupon","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Coupon value."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"docs/ecom-v1-draft-order.DiscountRule":{"name":"DiscountRule","fqn":"docs/ecom-v1-draft-order.DiscountRule","slug":"discount-rule","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rule ID"},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Discount value."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleName","referenceFqn":"docs/ecom-v1-draft-order.DiscountRuleName"},"description":"Discount rule name"}]},"docs/ecom-v1-draft-order.DiscountRuleName":{"name":"DiscountRuleName","fqn":"docs/ecom-v1-draft-order.DiscountRuleName","slug":"discount-rule-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original discount rule name (in site's default language)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated discount rule name according to buyer language. Defaults to `original` when not provided."}]},"docs/ecom-v1-draft-order.AppliedDiscountDiscountType":{"name":"AppliedDiscountDiscountType","fqn":"docs/ecom-v1-draft-order.AppliedDiscountDiscountType","slug":"applied-discount-discount-type","actions":[],"enumValues":["GLOBAL","SHIPPING","SPECIFIC_ITEMS"],"properties":[]},"docs/ecom-v1-draft-order.LineItemDiscount":{"name":"LineItemDiscount","fqn":"docs/ecom-v1-draft-order.LineItemDiscount","slug":"line-item-discount","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of line item the discount applies to."},{"name":"totalDiscount","slug":"total-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total discount for this line item."}]},"docs/ecom-v1-draft-order.MerchantDiscount":{"name":"MerchantDiscount","fqn":"docs/ecom-v1-draft-order.MerchantDiscount","slug":"merchant-discount","actions":[],"oneofProperties":{"merchantDiscountReason":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount description as free text (optional)."},{"name":"discountReason","slug":"discount-reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountReason","referenceFqn":"docs/ecom-v1-draft-order.DiscountReason"},"description":"Pre-defined discount reason (optional).\n* `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange."}]},"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Discount amount."}]},"docs/ecom-v1-draft-order.DiscountReason":{"name":"DiscountReason","fqn":"docs/ecom-v1-draft-order.DiscountReason","slug":"discount-reason","actions":[],"enumValues":["EXCHANGED_ITEMS","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-draft-order.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-draft-order.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-draft-order.ItemDetails":{"name":"ItemDetails","fqn":"docs/ecom-v1-draft-order.ItemDetails","slug":"item-details","actions":[],"oneofProperties":{"changeType":[{"name":"added","slug":"added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the line item was added as part of the draft."},{"name":"changedDetails","slug":"changed-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemChangedDetails","referenceFqn":"docs/ecom-v1-draft-order.ItemChangedDetails"},"description":"Line item fields before the change."},{"name":"removed","slug":"removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the line item was removed as part of the draft."}]},"properties":[{"name":"lineItem","slug":"line-item","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderLineItem","referenceFqn":"docs/ecom-v1-draft-order.OrderLineItem"},"description":"Line item details after applied changes."}]},"docs/ecom-v1-draft-order.ItemChangedDetails":{"name":"ItemChangedDetails","fqn":"docs/ecom-v1-draft-order.ItemChangedDetails","slug":"item-changed-details","actions":[],"properties":[{"name":"priceBeforeChange","slug":"price-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Line item price before change."},{"name":"priceDescriptionBeforeChange","slug":"price-description-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-draft-order.PriceDescription"},"description":"Line item price description before change."},{"name":"quantityBeforeChange","slug":"quantity-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity before change."}]},"docs/ecom-v1-draft-order.PriceDescription":{"name":"PriceDescription","fqn":"docs/ecom-v1-draft-order.PriceDescription","slug":"price-description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Price description 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Price description translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-draft-order.OrderLineItem":{"name":"OrderLineItem","fqn":"docs/ecom-v1-draft-order.OrderLineItem","slug":"order-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-draft-order.CatalogReference"},"description":"References to the line item's origin catalog.\nThis field is empty in the case of a custom line item."},{"name":"depositAmount","slug":"deposit-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `\"DEPOSIT_ONLINE\"`."},{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-draft-order.DescriptionLine"}},"description":"Line item description lines. Used for display purposes for the cart, checkout and order."},{"name":"digitalFile","slug":"digital-file","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DigitalFile","referenceFqn":"docs/ecom-v1-draft-order.DigitalFile"},"description":"Digital file identifier, relevant only for items with type DIGITAL."},{"name":"fulfillerId","slug":"fulfiller-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfiller ID. Field is empty when the line item is self-fulfilled.\nTo get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order)."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image."},{"name":"itemType","slug":"item-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-draft-order.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"paymentOption","slug":"payment-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentOptionType","referenceFqn":"docs/ecom-v1-draft-order.PaymentOptionType"},"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-draft-order.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU and item weight."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Line item price after line item discounts for display purposes."},{"name":"priceBeforeDiscounts","slug":"price-before-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Line item price before line item discounts for display purposes. Defaults to `price` when not provided."},{"name":"priceDescription","slug":"price-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-draft-order.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-draft-order.ProductName"},"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`"},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity."},{"name":"refundQuantity","slug":"refund-quantity","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were refunded."},{"name":"restockQuantity","slug":"restock-quantity","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items restocked."},{"name":"subscriptionInfo","slug":"subscription-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionInfo","referenceFqn":"docs/ecom-v1-draft-order.SubscriptionInfo"},"description":"Subscription info."},{"name":"taxDetails","slug":"tax-details","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Deprecated. Use ","replacedBy":"tax_info","targetRemovalDate":"2024-09-30"},"type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-draft-order.ItemTaxFullDetails"},"description":"Deprecated. Use `taxInfo` instead.\nThis field will be removed on September 30, 2024.\nTax details for this line item."},{"name":"taxInfo","slug":"tax-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineItemTaxInfo","referenceFqn":"docs/ecom-v1-draft-order.LineItemTaxInfo"},"description":"Represents all the relevant tax details for a specific line item."},{"name":"totalDiscount","slug":"total-discount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total discount for this line item's entire quantity."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total price after all discounts and tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total price after discounts, and before tax."}]},"docs/ecom-v1-draft-order.CatalogReference":{"name":"CatalogReference","fqn":"docs/ecom-v1-draft-order.CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"docs/ecom-v1-draft-order.DescriptionLine":{"name":"DescriptionLine","fqn":"docs/ecom-v1-draft-order.DescriptionLine","slug":"description-line","actions":[],"oneofProperties":{"value":[{"name":"colorInfo","slug":"color-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/ecom-v1-draft-order.Color"},"description":"Description line color value."},{"name":"plainText","slug":"plain-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PlainTextValue","referenceFqn":"docs/ecom-v1-draft-order.PlainTextValue"},"description":"Description line plain text value."}],"descriptionLineValue":[]},"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DescriptionLineName","referenceFqn":"docs/ecom-v1-draft-order.DescriptionLineName"},"description":"Description line name."}]},"docs/ecom-v1-draft-order.Color":{"name":"Color","fqn":"docs/ecom-v1-draft-order.Color","slug":"color","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HEX or RGB color code for display."},{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-draft-order.DescriptionLineType":{"name":"DescriptionLineType","fqn":"docs/ecom-v1-draft-order.DescriptionLineType","slug":"description-line-type","actions":[],"enumValues":["COLOR","PLAIN_TEXT","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-draft-order.DescriptionLineName":{"name":"DescriptionLineName","fqn":"docs/ecom-v1-draft-order.DescriptionLineName","slug":"description-line-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-draft-order.PlainTextValue":{"name":"PlainTextValue","fqn":"docs/ecom-v1-draft-order.PlainTextValue","slug":"plain-text-value","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-draft-order.DigitalFile":{"name":"DigitalFile","fqn":"docs/ecom-v1-draft-order.DigitalFile","slug":"digital-file","actions":[],"properties":[{"name":"expirationDate","slug":"expiration-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Link expiration time and date."},{"name":"fileId","slug":"file-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the secure file in media."},{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Link will exist after the digital links have been generated on the order."}]},"docs/ecom-v1-draft-order.ItemType":{"name":"ItemType","fqn":"docs/ecom-v1-draft-order.ItemType","slug":"item-type","actions":[],"oneofProperties":{"itemTypeData":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom item type. When none of the preset types are suitable, specifies the custom type."},{"name":"preset","slug":"preset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTypeItemType","referenceFqn":"docs/ecom-v1-draft-order.ItemTypeItemType"},"description":"Preset item type."}]},"properties":[]},"docs/ecom-v1-draft-order.ItemTypeItemType":{"name":"ItemTypeItemType","fqn":"docs/ecom-v1-draft-order.ItemTypeItemType","slug":"item-type-item-type","actions":[],"enumValues":["DIGITAL","GIFT_CARD","PHYSICAL","SERVICE","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-draft-order.LocationAndQuantity":{"name":"LocationAndQuantity","fqn":"docs/ecom-v1-draft-order.LocationAndQuantity","slug":"location-and-quantity","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location id in the associated owner app."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location owner app, if not provided then the site business info locations will be used."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Quantity for specific location."}]},"docs/ecom-v1-draft-order.PaymentOptionType":{"name":"PaymentOptionType","fqn":"docs/ecom-v1-draft-order.PaymentOptionType","slug":"payment-option-type","actions":[],"enumValues":["DEPOSIT_ONLINE","FULL_PAYMENT_OFFLINE","FULL_PAYMENT_ONLINE","MEMBERSHIP","MEMBERSHIP_OFFLINE"],"properties":[]},"docs/ecom-v1-draft-order.PhysicalProperties":{"name":"PhysicalProperties","fqn":"docs/ecom-v1-draft-order.PhysicalProperties","slug":"physical-properties","actions":[],"properties":[{"name":"shippable","slug":"shippable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this line item is shippable."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."}]},"docs/ecom-v1-draft-order.ProductName":{"name":"ProductName","fqn":"docs/ecom-v1-draft-order.ProductName","slug":"product-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Item 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).\n\nMin: 1 character.\nMax: 200 characters."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."}]},"docs/ecom-v1-draft-order.SubscriptionInfo":{"name":"SubscriptionInfo","fqn":"docs/ecom-v1-draft-order.SubscriptionInfo","slug":"subscription-info","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription ID."},{"name":"cycleNumber","slug":"cycle-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`."},{"name":"subscriptionOptionDescription","slug":"subscription-option-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option description. For example, `\"1kg of selected coffee, once a month\"`."},{"name":"subscriptionOptionTitle","slug":"subscription-option-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option title. For example, `\"Monthly coffee Subscription\"`."},{"name":"subscriptionSettings","slug":"subscription-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionSettings","referenceFqn":"docs/ecom-v1-draft-order.SubscriptionSettings"},"description":"Subscription detailed information."}]},"docs/ecom-v1-draft-order.SubscriptionSettings":{"name":"SubscriptionSettings","fqn":"docs/ecom-v1-draft-order.SubscriptionSettings","slug":"subscription-settings","actions":[],"properties":[{"name":"autoRenewal","slug":"auto-renewal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether subscription is renewed automatically at the end of each period."},{"name":"billingCycles","slug":"billing-cycles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`."},{"name":"frequency","slug":"frequency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionFrequency","referenceFqn":"docs/ecom-v1-draft-order.SubscriptionFrequency"},"description":"Frequency of recurring payment."},{"name":"interval","slug":"interval","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Interval of recurring payment."}]},"docs/ecom-v1-draft-order.SubscriptionFrequency":{"name":"SubscriptionFrequency","fqn":"docs/ecom-v1-draft-order.SubscriptionFrequency","slug":"subscription-frequency","actions":[],"enumValues":["DAY","MONTH","UNDEFINED","WEEK","YEAR"],"properties":[]},"docs/ecom-v1-draft-order.LineItemTaxInfo":{"name":"LineItemTaxInfo","fqn":"docs/ecom-v1-draft-order.LineItemTaxInfo","slug":"line-item-tax-info","actions":[],"properties":[{"name":"taxAmount","slug":"tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Calculated tax, based on `taxable_amount` and `tax_rate`."},{"name":"taxBreakdown","slug":"tax-breakdown","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItemTaxBreakdown","referenceFqn":"docs/ecom-v1-draft-order.LineItemTaxBreakdown"}},"description":"Tax information for a line item."},{"name":"taxGroupId","slug":"tax-group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax group ID.\nLearn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction)."},{"name":"taxIncludedInPrice","slug":"tax-included-in-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the price already includes tax."},{"name":"taxRate","slug":"tax-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate %, as a decimal point."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Amount for which tax is calculated."}]},"docs/ecom-v1-draft-order.LineItemTaxBreakdown":{"name":"LineItemTaxBreakdown","fqn":"docs/ecom-v1-draft-order.LineItemTaxBreakdown","slug":"line-item-tax-breakdown","actions":[],"properties":[{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Jurisdiction that taxes were calculated for. For example, \"New York\", or \"Quebec\"."},{"name":"jurisdictionType","slug":"jurisdiction-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-draft-order.JurisdictionType"},"description":"Type of jurisdiction that taxes were calculated for."},{"name":"nonTaxableAmount","slug":"non-taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Non-taxable amount of the line item price."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000."},{"name":"taxAmount","slug":"tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Amount of tax calculated for this line item."},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\nThis name should be explicit enough to allow the merchant to understand what tax was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Taxable amount of the line item price."}]},"docs/ecom-v1-draft-order.JurisdictionType":{"name":"JurisdictionType","fqn":"docs/ecom-v1-draft-order.JurisdictionType","slug":"jurisdiction-type","actions":[],"enumValues":["CITY","COUNTRY","COUNTY","SPECIAL","STATE","UNDEFINED"],"properties":[]},"docs/ecom-v1-draft-order.PriceSummary":{"name":"PriceSummary","fqn":"docs/ecom-v1-draft-order.PriceSummary","slug":"price-summary","actions":[],"properties":[{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total calculated discount value."},{"name":"shipping","slug":"shipping","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total shipping price, before discounts and before tax."},{"name":"subtotal","slug":"subtotal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Subtotal of all the line items, before discounts and before tax."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total tax on this order."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Order’s total price after discounts and tax."},{"name":"totalAdditionalFees","slug":"total-additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total price of additional fees before tax."}]},"docs/ecom-v1-draft-order.RecipientInfoDetails":{"name":"RecipientInfoDetails","fqn":"docs/ecom-v1-draft-order.RecipientInfoDetails","slug":"recipient-info-details","actions":[],"oneofProperties":{"changeType":[{"name":"added","slug":"added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that recipient information was added during draft."},{"name":"changedDetails","slug":"changed-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RecipientInfoChangedDetails","referenceFqn":"docs/ecom-v1-draft-order.RecipientInfoChangedDetails"},"description":"Indicates that recipient information was changed. Contains recipient information before draft."},{"name":"removed","slug":"removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates that recipient information was removed during draft."}]},"properties":[{"name":"recipientInfo","slug":"recipient-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-draft-order.AddressWithContact"},"description":"Order recipient address and contact details."}]},"docs/ecom-v1-draft-order.RecipientInfoChangedDetails":{"name":"RecipientInfoChangedDetails","fqn":"docs/ecom-v1-draft-order.RecipientInfoChangedDetails","slug":"recipient-info-changed-details","actions":[],"properties":[{"name":"recipientInfoBeforeChange","slug":"recipient-info-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-draft-order.AddressWithContact"},"description":"Order recipient address and contact details before draft."}]},"docs/ecom-v1-draft-order.ShippingDetails":{"name":"ShippingDetails","fqn":"docs/ecom-v1-draft-order.ShippingDetails","slug":"shipping-details","actions":[],"oneofProperties":{"changeType":[{"name":"added","slug":"added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether shipping info was added as part of the draft."},{"name":"changedDetails","slug":"changed-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingChangedDetails","referenceFqn":"docs/ecom-v1-draft-order.ShippingChangedDetails"},"description":"Shipping info before the change."},{"name":"removed","slug":"removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether shipping info was removed as part of the draft."}]},"properties":[{"name":"shippingInfo","slug":"shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1ShippingInformation","referenceFqn":"docs/ecom-v1-draft-order.V1ShippingInformation"},"description":"Selected Shipping details."}]},"docs/ecom-v1-draft-order.ShippingChangedDetails":{"name":"ShippingChangedDetails","fqn":"docs/ecom-v1-draft-order.ShippingChangedDetails","slug":"shipping-changed-details","actions":[],"properties":[{"name":"shippingInfoBeforeChange","slug":"shipping-info-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1ShippingInformation","referenceFqn":"docs/ecom-v1-draft-order.V1ShippingInformation"},"description":"Shipping info before the change."}]},"docs/ecom-v1-draft-order.V1ShippingInformation":{"name":"V1ShippingInformation","fqn":"docs/ecom-v1-draft-order.V1ShippingInformation","slug":"v1shipping-information","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App Def Id of external provider which was a source of shipping info"},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique code (or ID) of selected shipping option. For example, `\"usps_std_overnight\"``."},{"name":"cost","slug":"cost","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1ShippingPrice","referenceFqn":"docs/ecom-v1-draft-order.V1ShippingPrice"},"description":"Shipping costs."},{"name":"logistics","slug":"logistics","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1DeliveryLogistics","referenceFqn":"docs/ecom-v1-draft-order.V1DeliveryLogistics"},"description":"Shipping logistics."},{"name":"region","slug":"region","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingRegion","referenceFqn":"docs/ecom-v1-draft-order.ShippingRegion"},"description":"Shipping region."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping option title.\nFor example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"` or `\"First-Class Package International\"`."}]},"docs/ecom-v1-draft-order.V1ShippingPrice":{"name":"V1ShippingPrice","fqn":"docs/ecom-v1-draft-order.V1ShippingPrice","slug":"v1shipping-price","actions":[],"properties":[{"name":"discount","slug":"discount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Shipping discount before tax."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Shipping price for display purposes."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-draft-order.ItemTaxFullDetails"},"description":"Tax details."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Shipping price after all discounts (if any exist), and after tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total price of shipping after discounts (when relevant), and before tax."}]},"docs/ecom-v1-draft-order.V1DeliveryLogistics":{"name":"V1DeliveryLogistics","fqn":"docs/ecom-v1-draft-order.V1DeliveryLogistics","slug":"v1delivery-logistics","actions":[],"oneofProperties":{"address":[{"name":"pickupDetails","slug":"pickup-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1PickupDetails","referenceFqn":"docs/ecom-v1-draft-order.V1PickupDetails"},"description":"Pickup details."},{"name":"shippingDestination","slug":"shipping-destination","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-draft-order.AddressWithContact"},"description":"Shipping address and contact details."}]},"properties":[{"name":"deliverByDate","slug":"deliver-by-date","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"DATE"},"description":"Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"deliveryTime","slug":"delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Expected delivery time in free text. For example, `\"3-5 business days\"`."},{"name":"deliveryTimeSlot","slug":"delivery-time-slot","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1DeliveryTimeSlot","referenceFqn":"docs/ecom-v1-draft-order.V1DeliveryTimeSlot"},"description":"Expected delivery time."},{"name":"instructions","slug":"instructions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Instructions for carrier. For example, `\"Please knock on the door. If unanswered, please call contact number. Thanks.\"`."}]},"docs/ecom-v1-draft-order.V1DeliveryTimeSlot":{"name":"V1DeliveryTimeSlot","fqn":"docs/ecom-v1-draft-order.V1DeliveryTimeSlot","slug":"v1delivery-time-slot","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Delivery slot starting time."},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Delivery slot ending time."}]},"docs/ecom-v1-draft-order.V1PickupDetails":{"name":"V1PickupDetails","fqn":"docs/ecom-v1-draft-order.V1PickupDetails","slug":"v1pickup-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupAddress","referenceFqn":"docs/ecom-v1-draft-order.PickupAddress"},"description":"Pickup address."},{"name":"pickupMethod","slug":"pickup-method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupDetailsPickupMethod","referenceFqn":"docs/ecom-v1-draft-order.PickupDetailsPickupMethod"},"description":"Pickup method"}]},"docs/ecom-v1-draft-order.PickupAddress":{"name":"PickupAddress","fqn":"docs/ecom-v1-draft-order.PickupAddress","slug":"pickup-address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-draft-order.StreetAddress"},"description":"Street address object, with number, name, and apartment number in separate fields."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-draft-order.PickupDetailsPickupMethod":{"name":"PickupDetailsPickupMethod","fqn":"docs/ecom-v1-draft-order.PickupDetailsPickupMethod","slug":"pickup-details-pickup-method","actions":[],"enumValues":["PICKUP_POINT","STORE_PICKUP","UNKNOWN_METHOD"],"properties":[]},"docs/ecom-v1-draft-order.ShippingRegion":{"name":"ShippingRegion","fqn":"docs/ecom-v1-draft-order.ShippingRegion","slug":"shipping-region","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of shipping region. For example, `\"Metropolitan London\"`, or `\"Outer Melbourne suburbs\"`."}]},"docs/ecom-v1-draft-order.EditingStatus":{"name":"EditingStatus","fqn":"docs/ecom-v1-draft-order.EditingStatus","slug":"editing-status","actions":[],"enumValues":["COMMITTED","DRAFT"],"properties":[]},"docs/ecom-v1-draft-order.OrderTaxInfo":{"name":"OrderTaxInfo","fqn":"docs/ecom-v1-draft-order.OrderTaxInfo","slug":"order-tax-info","actions":[],"properties":[{"name":"taxBreakdown","slug":"tax-breakdown","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OrderTaxBreakdown","referenceFqn":"docs/ecom-v1-draft-order.OrderTaxBreakdown"}},"description":"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."},{"name":"totalTax","slug":"total-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Calculated tax, added from line items."}]},"docs/ecom-v1-draft-order.OrderTaxBreakdown":{"name":"OrderTaxBreakdown","fqn":"docs/ecom-v1-draft-order.OrderTaxBreakdown","slug":"order-tax-breakdown","actions":[],"properties":[{"name":"aggregatedTaxAmount","slug":"aggregated-tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"The sum of all the tax from line items that calculated by the tax identifiers."},{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the jurisdiction in which this tax detail applies."},{"name":"jurisdictionType","slug":"jurisdiction-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-draft-order.JurisdictionType"},"description":"The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special)."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate at which this tax detail was calculated."},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws."}]},"docs/ecom-v1-draft-order.TaxSummary":{"name":"TaxSummary","fqn":"docs/ecom-v1-draft-order.TaxSummary","slug":"tax-summary","actions":[],"properties":[{"name":"totalTax","slug":"total-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-draft-order.Price"},"description":"Total tax."}]},"docs/ecom-v1-draft-order.WeightUnit":{"name":"WeightUnit","fqn":"docs/ecom-v1-draft-order.WeightUnit","slug":"weight-unit","actions":[],"enumValues":["KG","LB","UNSPECIFIED_WEIGHT_UNIT"],"properties":[]},"docs/ecom-v1-draft-order.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-draft-order.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-draft-order.DraftOrderDeleted":{"name":"DraftOrderDeleted","fqn":"docs/ecom-v1-draft-order.DraftOrderDeleted","slug":"draft-order-deleted","actions":[],"properties":[{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-draft-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-draft-order.DraftOrderUpdated":{"name":"DraftOrderUpdated","fqn":"docs/ecom-v1-draft-order.DraftOrderUpdated","slug":"draft-order-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DraftOrder","referenceFqn":"docs/ecom-v1-draft-order.DraftOrder"},"description":"Updated draft order."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-draft-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-fulfillments.FulfillmentsUpdated":{"name":"FulfillmentsUpdated","fqn":"docs/ecom-v1-fulfillments.FulfillmentsUpdated","slug":"fulfillments-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderWithFulfillments","referenceFqn":"docs/ecom-v1-fulfillments.OrderWithFulfillments"},"description":"Updated fulfillments."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-fulfillments.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-fulfillments.OrderWithFulfillments":{"name":"OrderWithFulfillments","fqn":"docs/ecom-v1-fulfillments.OrderWithFulfillments","slug":"order-with-fulfillments","actions":[],"properties":[{"name":"fulfillments","slug":"fulfillments","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Fulfillment","referenceFqn":"docs/ecom-v1-fulfillments.Fulfillment"}},"description":"Fulfillments associated with the order."},{"name":"orderId","slug":"order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order ID."}]},"docs/ecom-v1-fulfillments.Fulfillment":{"name":"Fulfillment","fqn":"docs/ecom-v1-fulfillments.Fulfillment","slug":"fulfillment","actions":[],"oneofProperties":{"fulfillmentInfo":[{"name":"customInfo","slug":"custom-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomFulfillmentInfo","referenceFqn":"docs/ecom-v1-fulfillments.CustomFulfillmentInfo"},"description":"Custom fulfillment info."},{"name":"trackingInfo","slug":"tracking-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentTrackingInfo","referenceFqn":"docs/ecom-v1-fulfillments.FulfillmentTrackingInfo"},"description":"Tracking info."}]},"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Fulfillment creation date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfillment ID."},{"name":"completed","slug":"completed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Fulfillment handling complete."},{"name":"lineItems","slug":"line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentLineItem","referenceFqn":"docs/ecom-v1-fulfillments.FulfillmentLineItem"}},"description":"Line items being fulfilled."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfillment status.\n\nSupported values:\n+ `\"Pending\"`\n+ `\"Accepted\"`\n+ `\"Ready\"`\n+ `\"In_Delivery\"`\n+ `\"Fulfilled\"`"}]},"docs/ecom-v1-fulfillments.CustomFulfillmentInfo":{"name":"CustomFulfillmentInfo","fqn":"docs/ecom-v1-fulfillments.CustomFulfillmentInfo","slug":"custom-fulfillment-info","actions":[],"properties":[{"name":"fieldsData","slug":"fields-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"string"}},"description":"Custom fulfillment info in key:value form."}]},"docs/ecom-v1-fulfillments.FulfillmentLineItem":{"name":"FulfillmentLineItem","fqn":"docs/ecom-v1-fulfillments.FulfillmentLineItem","slug":"fulfillment-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID (mirrors the ID of the order line item)."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity.\n* If this property isn't passed on creation, it defaults to the number of items not already linked to a fulfillment.\n* If the order does not have the requested quantity of line items available to add to this fulfillment, the fulfillment will not be created and an error is returned.\n\nMin: `1`\nMax: `100000`"}]},"docs/ecom-v1-fulfillments.FulfillmentTrackingInfo":{"name":"FulfillmentTrackingInfo","fqn":"docs/ecom-v1-fulfillments.FulfillmentTrackingInfo","slug":"fulfillment-tracking-info","actions":[],"properties":[{"name":"shippingProvider","slug":"shipping-provider","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping provider. Using one of the following shipping providers will allow for auto-filling the tracking link:\n* `'fedex'`\n* `'ups'`\n* `'usps'`\n* `'dhl'`\n* `'canadaPost'`"},{"name":"trackingLink","slug":"tracking-link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tracking link. Auto-filled if a predefined shipping provider is used, otherwise provided on creation."},{"name":"trackingNumber","slug":"tracking-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping/delivery tracking number."}]},"docs/ecom-v1-fulfillments.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-fulfillments.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-local-delivery-option.LocalDeliveryOptionCreated":{"name":"LocalDeliveryOptionCreated","fqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOptionCreated","slug":"local-delivery-option-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocalDeliveryOption","referenceFqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOption"},"description":"Created local delivery option."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-local-delivery-option.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-local-delivery-option.LocalDeliveryOption":{"name":"LocalDeliveryOption","fqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOption","slug":"local-delivery-option","actions":[],"oneofProperties":{"config":[{"name":"customAreaConfig","slug":"custom-area-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomAreaConfig","referenceFqn":"docs/ecom-v1-local-delivery-option.CustomAreaConfig"}},{"name":"radiusConfig","slug":"radius-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RadiusConfig","referenceFqn":"docs/ecom-v1-local-delivery-option.RadiusConfig"}},{"name":"zipConfig","slug":"zip-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ZipCodeConfig","referenceFqn":"docs/ecom-v1-local-delivery-option.ZipCodeConfig"}}]},"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the LocalDeliveryOption was created."},{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"LocalDeliveryOptionId - unique identifier of local delivery option"},{"name":"areaName","slug":"area-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of Local Delivery Option"},{"name":"destinations","slug":"destinations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Destination","referenceFqn":"docs/ecom-v1-local-delivery-option.Destination"}},"description":"List of countries with subdivisions"},{"name":"estimatedDeliveryTime","slug":"estimated-delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Estimated delivery time description text"},{"name":"externalId","slug":"external-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"External id of shipping rule which LocalDeliveryOption is linked to. Most commonly it would be shippingRuleId from WixStores"},{"name":"minimumFreeDeliveryOrderAmount","slug":"minimum-free-delivery-order-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum order total to be eligible for free delivery"},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Flat price of local delivery"},{"name":"rates","slug":"rates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ConditionalRates","referenceFqn":"docs/ecom-v1-local-delivery-option.ConditionalRates"}},"description":"at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Database revision of LocalDeliveryOption entity. Incremented on each modification"},{"name":"scheduledDeliveryConfig","slug":"scheduled-delivery-config","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ScheduledDelivery","referenceFqn":"docs/ecom-v1-local-delivery-option.ScheduledDelivery"}}]},"docs/ecom-v1-local-delivery-option.CustomAreaConfig":{"name":"CustomAreaConfig","fqn":"docs/ecom-v1-local-delivery-option.CustomAreaConfig","slug":"custom-area-config","actions":[],"properties":[{"name":"geocodes","slug":"geocodes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AddressLocation","referenceFqn":"docs/ecom-v1-local-delivery-option.AddressLocation"}},"description":"Geocodes of the polygon defining the delivery area."}]},"docs/ecom-v1-local-delivery-option.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-local-delivery-option.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-local-delivery-option.Destination":{"name":"Destination","fqn":"docs/ecom-v1-local-delivery-option.Destination","slug":"destination","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Country ISO code"},{"name":"subdivisions","slug":"subdivisions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of subdivisions, empty means all"}]},"docs/ecom-v1-local-delivery-option.RadiusConfig":{"name":"RadiusConfig","fqn":"docs/ecom-v1-local-delivery-option.RadiusConfig","slug":"radius-config","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocalDeliveryAddress","referenceFqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryAddress"},"description":"Delivery-from address"},{"name":"lengthUnit","slug":"length-unit","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LengthUnit","referenceFqn":"docs/ecom-v1-local-delivery-option.LengthUnit"},"description":"Radius' unit, taken from site properties"},{"name":"radius","slug":"radius","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Delivery circle's radius"}]},"docs/ecom-v1-local-delivery-option.LocalDeliveryAddress":{"name":"LocalDeliveryAddress","fqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryAddress","slug":"local-delivery-address","actions":[],"properties":[{"name":"formatted","slug":"formatted","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A string containing the human-readable address of this location"},{"name":"location","slug":"location","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressLocation","referenceFqn":"docs/ecom-v1-local-delivery-option.AddressLocation"},"description":"coordinates of the physical address"}]},"docs/ecom-v1-local-delivery-option.LengthUnit":{"name":"LengthUnit","fqn":"docs/ecom-v1-local-delivery-option.LengthUnit","slug":"length-unit","actions":[],"enumValues":["KM","MI","UNSPECIFIED_LENGTH_UNIT"],"properties":[]},"docs/ecom-v1-local-delivery-option.ConditionalRates":{"name":"ConditionalRates","fqn":"docs/ecom-v1-local-delivery-option.ConditionalRates","slug":"conditional-rates","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"conditions","slug":"conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Condition","referenceFqn":"docs/ecom-v1-local-delivery-option.Condition"}},"description":"there is an AND logic between all the conditions. Empty conditions means true.\nFor example: weight > 0 and weight <= 10"}]},"docs/ecom-v1-local-delivery-option.Condition":{"name":"Condition","fqn":"docs/ecom-v1-local-delivery-option.Condition","slug":"condition","actions":[],"properties":[{"name":"operator","slug":"operator","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LogicalOperator","referenceFqn":"docs/ecom-v1-local-delivery-option.LogicalOperator"}},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ConditionType","referenceFqn":"docs/ecom-v1-local-delivery-option.ConditionType"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value in respective to the condition type\nWeight values should be in the same weight units of the store: KG / LB\nTotal price is according to the store currency\nQuantity of items should be integers"}]},"docs/ecom-v1-local-delivery-option.LogicalOperator":{"name":"LogicalOperator","fqn":"docs/ecom-v1-local-delivery-option.LogicalOperator","slug":"logical-operator","actions":[],"enumValues":["EQ","GT","GTE","LT","LTE","UNKNOWN_LOGICAL_OPERATOR_TYPE"],"properties":[]},"docs/ecom-v1-local-delivery-option.ConditionType":{"name":"ConditionType","fqn":"docs/ecom-v1-local-delivery-option.ConditionType","slug":"condition-type","actions":[],"enumValues":["BY_TOTAL_PRICE","BY_TOTAL_QUANTITY","BY_TOTAL_WEIGHT","UNKNOWN_TYPE"],"properties":[]},"docs/ecom-v1-local-delivery-option.ScheduledDelivery":{"name":"ScheduledDelivery","fqn":"docs/ecom-v1-local-delivery-option.ScheduledDelivery","slug":"scheduled-delivery","actions":[],"properties":[{"name":"cutOffTime","slug":"cut-off-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimePoint","referenceFqn":"docs/ecom-v1-local-delivery-option.TimePoint"},"description":"Cut off time after which first delivery option would be for next day"},{"name":"days","slug":"days","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Days config which contain days when delivery is enabled with it's time slots","replacedBy":"time_windows","targetRemovalDate":"2025-01-01"},"type":{"kind":"REFERENCE","name":"Days","referenceFqn":"docs/ecom-v1-local-delivery-option.Days"},"description":"Days config which contain days when delivery is enabled with it's time slots"},{"name":"handlingDays","slug":"handling-days","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Amount of days before first delivery option date"},{"name":"timeWindows","slug":"time-windows","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TimeWindow","referenceFqn":"docs/ecom-v1-local-delivery-option.TimeWindow"}},"description":"availability times configuration."}]},"docs/ecom-v1-local-delivery-option.TimePoint":{"name":"TimePoint","fqn":"docs/ecom-v1-local-delivery-option.TimePoint","slug":"time-point","actions":[],"properties":[{"name":"hours","slug":"hours","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Hours in format 0-23"},{"name":"minutes","slug":"minutes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minutes 0-59"}]},"docs/ecom-v1-local-delivery-option.Days":{"name":"Days","fqn":"docs/ecom-v1-local-delivery-option.Days","slug":"days","actions":[],"properties":[{"name":"friday","slug":"friday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}},{"name":"monday","slug":"monday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}},{"name":"saturday","slug":"saturday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}},{"name":"sunday","slug":"sunday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}},{"name":"thursday","slug":"thursday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}},{"name":"tuesday","slug":"tuesday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}},{"name":"wednesday","slug":"wednesday","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DaySlot","referenceFqn":"docs/ecom-v1-local-delivery-option.DaySlot"}}]},"docs/ecom-v1-local-delivery-option.DaySlot":{"name":"DaySlot","fqn":"docs/ecom-v1-local-delivery-option.DaySlot","slug":"day-slot","actions":[],"properties":[{"name":"enabledForDelivery","slug":"enabled-for-delivery","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Shows whether this day slot is enabled for delivery"},{"name":"timeSlots","slug":"time-slots","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TimeSlot","referenceFqn":"docs/ecom-v1-local-delivery-option.TimeSlot"}},"description":"Time slots for scheduled delivery during day"}]},"docs/ecom-v1-local-delivery-option.TimeSlot":{"name":"TimeSlot","fqn":"docs/ecom-v1-local-delivery-option.TimeSlot","slug":"time-slot","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimePoint","referenceFqn":"docs/ecom-v1-local-delivery-option.TimePoint"},"description":"Starting time point of time slot"},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimePoint","referenceFqn":"docs/ecom-v1-local-delivery-option.TimePoint"},"description":"End time point of time slot"}]},"docs/ecom-v1-local-delivery-option.TimeWindow":{"name":"TimeWindow","fqn":"docs/ecom-v1-local-delivery-option.TimeWindow","slug":"time-window","actions":[],"properties":[{"name":"day","slug":"day","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DayOfWeek","referenceFqn":"docs/ecom-v1-local-delivery-option.DayOfWeek"},"description":"The day of week this availability relates to."},{"name":"end","slug":"end","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeOfDay","referenceFqn":"docs/ecom-v1-local-delivery-option.TimeOfDay"},"description":"The end time in time of day representation."},{"name":"start","slug":"start","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeOfDay","referenceFqn":"docs/ecom-v1-local-delivery-option.TimeOfDay"},"description":"The start time in time of day representation."}]},"docs/ecom-v1-local-delivery-option.DayOfWeek":{"name":"DayOfWeek","fqn":"docs/ecom-v1-local-delivery-option.DayOfWeek","slug":"day-of-week","actions":[],"enumValues":["FRI","MON","SAT","SUN","THU","TUE","WED"],"properties":[]},"docs/ecom-v1-local-delivery-option.TimeOfDay":{"name":"TimeOfDay","fqn":"docs/ecom-v1-local-delivery-option.TimeOfDay","slug":"time-of-day","actions":[],"properties":[{"name":"hours","slug":"hours","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Hours"},{"name":"minutes","slug":"minutes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minutes"}]},"docs/ecom-v1-local-delivery-option.ZipCodeConfig":{"name":"ZipCodeConfig","fqn":"docs/ecom-v1-local-delivery-option.ZipCodeConfig","slug":"zip-code-config","actions":[],"properties":[{"name":"zipCodes","slug":"zip-codes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of ZipCodes and ZipCode regexes. Examples: 10001, 10002 or 1000*"}]},"docs/ecom-v1-local-delivery-option.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-local-delivery-option.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-local-delivery-option.LocalDeliveryOptionDeleted":{"name":"LocalDeliveryOptionDeleted","fqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOptionDeleted","slug":"local-delivery-option-deleted","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocalDeliveryOption","referenceFqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOption"},"description":"Deleted local delivery option."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-local-delivery-option.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-local-delivery-option.LocalDeliveryOptionUpdated":{"name":"LocalDeliveryOptionUpdated","fqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOptionUpdated","slug":"local-delivery-option-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LocalDeliveryOption","referenceFqn":"docs/ecom-v1-local-delivery-option.LocalDeliveryOption"},"description":"Updated local delivery option."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-local-delivery-option.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order.OrderApprovedEvent":{"name":"OrderApprovedEvent","fqn":"docs/ecom-v1-order.OrderApprovedEvent","slug":"order-approved-event","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderApproved","referenceFqn":"docs/ecom-v1-order.OrderApproved"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order.OrderApproved":{"name":"OrderApproved","fqn":"docs/ecom-v1-order.OrderApproved","slug":"order-approved","actions":[],"properties":[{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"docs/ecom-v1-order.Order"},"description":"The order that was updated"}]},"docs/ecom-v1-order.Order":{"name":"Order","fqn":"docs/ecom-v1-order.Order","slug":"order","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"activities","slug":"activities","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Activity","referenceFqn":"docs/ecom-v1-order.Activity"}},"description":"Order activities."},{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalFee","referenceFqn":"docs/ecom-v1-order.AdditionalFee"}},"description":"Additional fees applied to the order."},{"name":"appliedDiscounts","slug":"applied-discounts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AppliedDiscount","referenceFqn":"docs/ecom-v1-order.AppliedDiscount"}},"description":"Applied discounts."},{"name":"archived","slug":"archived","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether order is archived."},{"name":"attributionSource","slug":"attribution-source","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AttributionSource","referenceFqn":"docs/ecom-v1-order.AttributionSource"},"description":"Order attribution source."},{"name":"balanceSummary","slug":"balance-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BalanceSummary","referenceFqn":"docs/ecom-v1-order.BalanceSummary"},"description":"Balance summary."},{"name":"billingInfo","slug":"billing-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-order.AddressWithContact"},"description":"Billing address and contact details."},{"name":"buyerInfo","slug":"buyer-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BuyerInfo","referenceFqn":"docs/ecom-v1-order.BuyerInfo"},"description":"Buyer information."},{"name":"buyerLanguage","slug":"buyer-language","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Language for communication with the buyer. Defaults to the site language.\nFor a site that supports multiple languages, this is the language the buyer selected."},{"name":"buyerNote","slug":"buyer-note","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"[Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer."},{"name":"channelInfo","slug":"channel-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChannelInfo","referenceFqn":"docs/ecom-v1-order.ChannelInfo"},"description":"Information about the sales channel that submitted this order."},{"name":"checkoutId","slug":"checkout-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Checkout ID."},{"name":"createdBy","slug":"created-by","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CreatedBy","referenceFqn":"docs/ecom-v1-order.CreatedBy"},"description":"ID of the order's initiator."},{"name":"currency","slug":"currency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format."},{"name":"customFields","slug":"custom-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"CustomField","referenceFqn":"docs/ecom-v1-order.CustomField"}},"description":"Custom fields."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-order.ExtendedFields"},"description":"Custom field data for the order object.\n\n[Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the Wix Dev Center before they can be accessed with API calls."},{"name":"fulfillmentStatus","slug":"fulfillment-status","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentStatus","referenceFqn":"docs/ecom-v1-order.FulfillmentStatus"},"description":"Order fulfillment status."},{"name":"lineItems","slug":"line-items","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OrderLineItem","referenceFqn":"docs/ecom-v1-order.OrderLineItem"}},"description":"Order line items."},{"name":"number","slug":"number","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order number displayed in the site owner's dashboard (auto-generated)."},{"name":"paymentStatus","slug":"payment-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentStatus","referenceFqn":"docs/ecom-v1-order.PaymentStatus"},"description":"Order payment status.\n+ `NOT_PAID` - This can be an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.\n+ This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.\n+ `PAID` - All payments associated with this order are paid. For online payments: [`payment.regularPaymentDetails.status: APPROVED`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object). For gift cards: [`payment.giftCardPaymentDetails.voided: false`](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-transactions/order-transactions-object).\n+ `PARTIALLY_REFUNDED` - Order was refunded, but refund amount is less than order total price.\n+ `FULLY_REFUNDED` - Order fully refunded. Refund amount equals total price.\n+ `PENDING` - Payments received but not yet confirmed by the payment provider.\n+ `PARTIALLY_PAID` - At least one payment was received and approved, covering less than total price amount."},{"name":"priceSummary","slug":"price-summary","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceSummary","referenceFqn":"docs/ecom-v1-order.PriceSummary"},"description":"Order price summary."},{"name":"purchaseFlowId","slug":"purchase-flow-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order."},{"name":"recipientInfo","slug":"recipient-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-order.AddressWithContact"},"description":"Order recipient address and contact details.\n\nThis field may differ from the address in `shippingInfo.logistics` when:\n+ The chosen shipping option is pickup point or store pickup.\n+ No shipping option is selected."},{"name":"seenByAHuman","slug":"seen-by-ahuman","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether a human has seen the order. Set when an order is clicked on in the dashboard."},{"name":"shippingInfo","slug":"shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1ShippingInformation","referenceFqn":"docs/ecom-v1-order.V1ShippingInformation"},"description":"Shipping info and selected shipping option details."},{"name":"siteLanguage","slug":"site-language","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Site language in which original values are shown."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderStatus","referenceFqn":"docs/ecom-v1-order.OrderStatus"},"description":"Order status.\n+ `INITIALIZED`: Order created, but not yet approved or canceled.\n+ `APPROVED`: Order approved. This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order). Offline orders (cash payment) are automatically approved.\n+ `CANCELED`: Order canceled by the user."},{"name":"taxIncludedInPrices","slug":"tax-included-in-prices","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether tax is included in line item prices."},{"name":"taxInfo","slug":"tax-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderTaxInfo","referenceFqn":"docs/ecom-v1-order.OrderTaxInfo"},"description":"Tax information."},{"name":"taxSummary","slug":"tax-summary","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Tax summary.\nDeprecated. Use ","replacedBy":"tax_info","targetRemovalDate":"2024-09-30"},"type":{"kind":"REFERENCE","name":"TaxSummary","referenceFqn":"docs/ecom-v1-order.TaxSummary"},"description":"Tax summary.\nDeprecated. Use `taxInfo` instead.\nThis field will be removed on September 30, 2024."},{"name":"weightUnit","slug":"weight-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WeightUnit","referenceFqn":"docs/ecom-v1-order.WeightUnit"},"description":"Weight measurement unit - defaults to site's weight unit."}]},"docs/ecom-v1-order.Activity":{"name":"Activity","fqn":"docs/ecom-v1-order.Activity","slug":"activity","actions":[],"oneofProperties":{"content":[{"name":"customActivity","slug":"custom-activity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CustomActivity","referenceFqn":"docs/ecom-v1-order.CustomActivity"},"description":"Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`."},{"name":"merchantComment","slug":"merchant-comment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MerchantComment","referenceFqn":"docs/ecom-v1-order.MerchantComment"},"description":"Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`."},{"name":"orderRefunded","slug":"order-refunded","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderRefunded","referenceFqn":"docs/ecom-v1-order.OrderRefunded"},"description":"Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`."}]},"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Activity creation date and time."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Activity ID."},{"name":"authorEmail","slug":"author-email","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Activity author's email."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActivityType","referenceFqn":"docs/ecom-v1-order.ActivityType"},"description":"Activity type."}]},"docs/ecom-v1-order.AuthorizedPaymentCaptured":{"name":"AuthorizedPaymentCaptured","fqn":"docs/ecom-v1-order.AuthorizedPaymentCaptured","slug":"authorized-payment-captured","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Payment amount"},{"name":"brand","slug":"brand","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Card issuer's brand."},{"name":"lastFourDigits","slug":"last-four-digits","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The last 4 digits of the card number."},{"name":"paymentId","slug":"payment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment ID of payment associated with this activity"}]},"docs/ecom-v1-order.Price":{"name":"Price","fqn":"docs/ecom-v1-order.Price","slug":"price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."}]},"docs/ecom-v1-order.AuthorizedPaymentCreated":{"name":"AuthorizedPaymentCreated","fqn":"docs/ecom-v1-order.AuthorizedPaymentCreated","slug":"authorized-payment-created","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Payment amount"},{"name":"brand","slug":"brand","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Card issuer's brand."},{"name":"lastFourDigits","slug":"last-four-digits","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The last 4 digits of the card number."},{"name":"paymentId","slug":"payment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment ID of payment associated with this activity"}]},"docs/ecom-v1-order.AuthorizedPaymentVoided":{"name":"AuthorizedPaymentVoided","fqn":"docs/ecom-v1-order.AuthorizedPaymentVoided","slug":"authorized-payment-voided","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Payment amount"},{"name":"brand","slug":"brand","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Card issuer's brand."},{"name":"lastFourDigits","slug":"last-four-digits","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The last 4 digits of the card number."},{"name":"paymentId","slug":"payment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment ID of payment associated with this activity"}]},"docs/ecom-v1-order.CustomActivity":{"name":"CustomActivity","fqn":"docs/ecom-v1-order.CustomActivity","slug":"custom-activity","actions":[],"properties":[{"name":"additionalData","slug":"additional-data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"string"}},"description":"Additional data in key-value form. For example, `{ \"Ticket number\": \"123456\" }`."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that created the custom activity."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom activity type. For example, `\"Ticket number set\"`."}]},"docs/ecom-v1-order.DraftOrderChangesApplied":{"name":"DraftOrderChangesApplied","fqn":"docs/ecom-v1-order.DraftOrderChangesApplied","slug":"draft-order-changes-applied","actions":[],"properties":[{"name":"changes","slug":"changes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OrderChange","referenceFqn":"docs/ecom-v1-order.OrderChange"}},"description":"Changes applied to order."},{"name":"draftOrderId","slug":"draft-order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Draft order id."},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reason for edit, given by user (optional)."}]},"docs/ecom-v1-order.OrderChange":{"name":"OrderChange","fqn":"docs/ecom-v1-order.OrderChange","slug":"order-change","actions":[],"oneofProperties":{"value":[{"name":"additionalFeeAdded","slug":"additional-fee-added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManagedAdditionalFee","referenceFqn":"docs/ecom-v1-order.ManagedAdditionalFee"}},{"name":"additionalFeeRemoved","slug":"additional-fee-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManagedAdditionalFee","referenceFqn":"docs/ecom-v1-order.ManagedAdditionalFee"}},{"name":"discountAdded","slug":"discount-added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManagedDiscount","referenceFqn":"docs/ecom-v1-order.ManagedDiscount"}},{"name":"discountRemoved","slug":"discount-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManagedDiscount","referenceFqn":"docs/ecom-v1-order.ManagedDiscount"}},{"name":"lineItemAdded","slug":"line-item-added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManagedLineItem","referenceFqn":"docs/ecom-v1-order.ManagedLineItem"}},{"name":"lineItemChanged","slug":"line-item-changed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineItemChanges","referenceFqn":"docs/ecom-v1-order.LineItemChanges"}},{"name":"lineItemRemoved","slug":"line-item-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ManagedLineItem","referenceFqn":"docs/ecom-v1-order.ManagedLineItem"}},{"name":"shippingInformationChanged","slug":"shipping-information-changed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingInformationChange","referenceFqn":"docs/ecom-v1-order.ShippingInformationChange"}},{"name":"totalPriceChanged","slug":"total-price-changed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TotalPriceChange","referenceFqn":"docs/ecom-v1-order.TotalPriceChange"}}]},"properties":[]},"docs/ecom-v1-order.ManagedAdditionalFee":{"name":"ManagedAdditionalFee","fqn":"docs/ecom-v1-order.ManagedAdditionalFee","slug":"managed-additional-fee","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee id."},{"name":"affectedLineItems","slug":"affected-line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItemAmount","referenceFqn":"docs/ecom-v1-order.LineItemAmount"}},"description":"Line items additional fee applies to."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TranslatedValue","referenceFqn":"docs/ecom-v1-order.TranslatedValue"},"description":"Additional fee name."},{"name":"totalAmount","slug":"total-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Additional fee amount."}]},"docs/ecom-v1-order.LineItemAmount":{"name":"LineItemAmount","fqn":"docs/ecom-v1-order.LineItemAmount","slug":"line-item-amount","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order line item id"},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Amount associated with this item. (Discount amount for item / additional fee amount for item)"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-order.ProductName"},"description":"Item name."}]},"docs/ecom-v1-order.ProductName":{"name":"ProductName","fqn":"docs/ecom-v1-order.ProductName","slug":"product-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Item 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).\n\nMin: 1 character.\nMax: 200 characters."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Item name translated into the buyer's language.\n\nMin: 1 character.\nMax: 400 characters.\nDefault: Same as `original`."}]},"docs/ecom-v1-order.TranslatedValue":{"name":"TranslatedValue","fqn":"docs/ecom-v1-order.TranslatedValue","slug":"translated-value","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value in site default language."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated value."}]},"docs/ecom-v1-order.ManagedDiscount":{"name":"ManagedDiscount","fqn":"docs/ecom-v1-order.ManagedDiscount","slug":"managed-discount","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount id."},{"name":"affectedLineItems","slug":"affected-line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItemAmount","referenceFqn":"docs/ecom-v1-order.LineItemAmount"}},"description":"Line items discount applies to."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TranslatedValue","referenceFqn":"docs/ecom-v1-order.TranslatedValue"},"description":"Discount name: coupon name / discount rule name / merchant discount description."},{"name":"totalAmount","slug":"total-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Discount amount."}]},"docs/ecom-v1-order.ManagedLineItem":{"name":"ManagedLineItem","fqn":"docs/ecom-v1-order.ManagedLineItem","slug":"managed-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-order.ProductName"},"description":"Item name."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Added or removed item quantity."}]},"docs/ecom-v1-order.LineItemChanges":{"name":"LineItemChanges","fqn":"docs/ecom-v1-order.LineItemChanges","slug":"line-item-changes","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-order.ProductName"},"description":"Item name."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineItemPriceChange","referenceFqn":"docs/ecom-v1-order.LineItemPriceChange"},"description":"Item price change."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineItemQuantityChange","referenceFqn":"docs/ecom-v1-order.LineItemQuantityChange"},"description":"Item quantity change."}]},"docs/ecom-v1-order.LineItemPriceChange":{"name":"LineItemPriceChange","fqn":"docs/ecom-v1-order.LineItemPriceChange","slug":"line-item-price-change","actions":[],"properties":[{"name":"newPrice","slug":"new-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Item price after update."},{"name":"originalPrice","slug":"original-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Item price before update."}]},"docs/ecom-v1-order.LineItemQuantityChange":{"name":"LineItemQuantityChange","fqn":"docs/ecom-v1-order.LineItemQuantityChange","slug":"line-item-quantity-change","actions":[],"properties":[{"name":"deltaType","slug":"delta-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineItemQuantityChangeType","referenceFqn":"docs/ecom-v1-order.LineItemQuantityChangeType"},"description":"Type of quantity change: increase or decrease."},{"name":"diff","slug":"diff","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Difference between original and new quantity. Absolute value."},{"name":"newQuantity","slug":"new-quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item quantity after update."},{"name":"originalQuantity","slug":"original-quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Item quantity before update."}]},"docs/ecom-v1-order.LineItemQuantityChangeType":{"name":"LineItemQuantityChangeType","fqn":"docs/ecom-v1-order.LineItemQuantityChangeType","slug":"line-item-quantity-change-type","actions":[],"enumValues":["QUANTITY_DECREASED","QUANTITY_INCREASED"],"properties":[]},"docs/ecom-v1-order.ShippingInformationChange":{"name":"ShippingInformationChange","fqn":"docs/ecom-v1-order.ShippingInformationChange","slug":"shipping-information-change","actions":[],"properties":[{"name":"newShippingInfo","slug":"new-shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingInformation","referenceFqn":"docs/ecom-v1-order.ShippingInformation"},"description":"Order’s Shipping Information. After update"},{"name":"originalShippingInfo","slug":"original-shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingInformation","referenceFqn":"docs/ecom-v1-order.ShippingInformation"},"description":"Order’s Shipping Information. Before update"}]},"docs/ecom-v1-order.ShippingInformation":{"name":"ShippingInformation","fqn":"docs/ecom-v1-order.ShippingInformation","slug":"shipping-information","actions":[],"properties":[{"name":"shippingTitle","slug":"shipping-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order’s shipping title."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Order’s shipping price."}]},"docs/ecom-v1-order.TotalPriceChange":{"name":"TotalPriceChange","fqn":"docs/ecom-v1-order.TotalPriceChange","slug":"total-price-change","actions":[],"properties":[{"name":"newTotal","slug":"new-total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Order’s total price after discounts and tax. After update"},{"name":"originalTotal","slug":"original-total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Order’s total price after discounts and tax. Before update"}]},"docs/ecom-v1-order.MerchantComment":{"name":"MerchantComment","fqn":"docs/ecom-v1-order.MerchantComment","slug":"merchant-comment","actions":[],"properties":[{"name":"message","slug":"message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Merchant comment message."}]},"docs/ecom-v1-order.NewExchangeOrderCreated":{"name":"NewExchangeOrderCreated","fqn":"docs/ecom-v1-order.NewExchangeOrderCreated","slug":"new-exchange-order-created","actions":[],"properties":[{"name":"exchangeOrderId","slug":"exchange-order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the new order created as a result of an exchange of items."},{"name":"lineItems","slug":"line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItemExchangeData","referenceFqn":"docs/ecom-v1-order.LineItemExchangeData"}},"description":"IDs of the items that were exchanged."}]},"docs/ecom-v1-order.LineItemExchangeData":{"name":"LineItemExchangeData","fqn":"docs/ecom-v1-order.LineItemExchangeData","slug":"line-item-exchange-data","actions":[],"properties":[{"name":"lineItemId","slug":"line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the exchanged line item."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity being exchanged."}]},"docs/ecom-v1-order.OrderCreatedFromExchange":{"name":"OrderCreatedFromExchange","fqn":"docs/ecom-v1-order.OrderCreatedFromExchange","slug":"order-created-from-exchange","actions":[],"properties":[{"name":"originalOrderId","slug":"original-order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the original order for which the exchange happened."}]},"docs/ecom-v1-order.OrderRefunded":{"name":"OrderRefunded","fqn":"docs/ecom-v1-order.OrderRefunded","slug":"order-refunded","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Refund amount."},{"name":"manual","slug":"manual","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether order was refunded manually. For example, via payment provider or using cash."},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reason for refund."}]},"docs/ecom-v1-order.SavedPaymentMethod":{"name":"SavedPaymentMethod","fqn":"docs/ecom-v1-order.SavedPaymentMethod","slug":"saved-payment-method","actions":[],"properties":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment method description"},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment method name"}]},"docs/ecom-v1-order.ActivityType":{"name":"ActivityType","fqn":"docs/ecom-v1-order.ActivityType","slug":"activity-type","actions":[],"enumValues":["AUTHORIZED_PAYMENT_CAPTURED","AUTHORIZED_PAYMENT_CREATED","AUTHORIZED_PAYMENT_VOIDED","CUSTOM_ACTIVITY","DOWNLOAD_LINK_SENT","DRAFT_ORDER_CHANGES_APPLIED","EMAIL_EDITED","FULFILLER_EMAIL_SENT","INVOICE_ADDED","INVOICE_REMOVED","INVOICE_SENT","MERCHANT_COMMENT","NEW_EXCHANGE_ORDER_CREATED","ORDER_CANCELED","ORDER_CREATED_FROM_EXCHANGE","ORDER_FULFILLED","ORDER_NOT_FULFILLED","ORDER_PAID","ORDER_PARTIALLY_PAID","ORDER_PLACED","ORDER_REFUNDED","PICKUP_READY_EMAIL_SENT","SAVED_PAYMENT_METHOD","SHIPPING_ADDRESS_EDITED","SHIPPING_CONFIRMATION_EMAIL_SENT","TRACKING_LINK_ADDED","TRACKING_NUMBER_ADDED","TRACKING_NUMBER_EDITED"],"properties":[]},"docs/ecom-v1-order.AdditionalFee":{"name":"AdditionalFee","fqn":"docs/ecom-v1-order.AdditionalFee","slug":"additional-fee","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee's id."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee's unique code for future processing."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Optional - Line items associated with this additional fee.\nIf no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of additional fee."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Additional fee's price."},{"name":"priceAfterTax","slug":"price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Additional fee's price after tax."},{"name":"priceBeforeTax","slug":"price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Additional fee's price before tax."},{"name":"providerAppId","slug":"provider-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"SPI implementer's `appId`."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-order.ItemTaxFullDetails"},"description":"Tax details."}]},"docs/ecom-v1-order.ItemTaxFullDetails":{"name":"ItemTaxFullDetails","fqn":"docs/ecom-v1-order.ItemTaxFullDetails","slug":"item-tax-full-details","actions":[],"properties":[{"name":"taxRate","slug":"tax-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate percentage, as a decimal numeral between 0 and 1. For example, `\"0.13\"`."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Taxable amount of this line item."},{"name":"totalTax","slug":"total-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"The calculated tax, based on the `taxableAmount` and `taxRate`."}]},"docs/ecom-v1-order.AppliedDiscount":{"name":"AppliedDiscount","fqn":"docs/ecom-v1-order.AppliedDiscount","slug":"applied-discount","actions":[],"oneofProperties":{"discountSource":[{"name":"coupon","slug":"coupon","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Coupon","referenceFqn":"docs/ecom-v1-order.Coupon"},"description":"Applied coupon info."},{"name":"discountRule","slug":"discount-rule","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRule","referenceFqn":"docs/ecom-v1-order.DiscountRule"},"description":"Automatic Discount"},{"name":"merchantDiscount","slug":"merchant-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MerchantDiscount","referenceFqn":"docs/ecom-v1-order.MerchantDiscount"},"description":"Merchant discount."}]},"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount id."},{"name":"discountType","slug":"discount-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountType","referenceFqn":"docs/ecom-v1-order.DiscountType"},"description":"Discount type.\n* `\"GLOBAL\"` - discount applies to entire order.\n* `\"SPECIFIC-ITEMS\"` - discount applies to specific items.\n* `\"SHIPPING\"` - discount applies to shipping. For example, free shipping."},{"name":"lineItemIds","slug":"line-item-ids","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"IDs of line items discount applies to.\nDeprecated. Use ","replacedBy":"line_item_discounts","targetRemovalDate":"2024-10-30"},"type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of line items discount applies to.\nDeprecated. Use `line_item_discounts` instead."}]},"docs/ecom-v1-order.Coupon":{"name":"Coupon","fqn":"docs/ecom-v1-order.Coupon","slug":"coupon","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon ID."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Coupon value."},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon code."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Coupon name."}]},"docs/ecom-v1-order.DiscountRule":{"name":"DiscountRule","fqn":"docs/ecom-v1-order.DiscountRule","slug":"discount-rule","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount rule ID"},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Discount value."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleName","referenceFqn":"docs/ecom-v1-order.DiscountRuleName"},"description":"Discount rule name"}]},"docs/ecom-v1-order.DiscountRuleName":{"name":"DiscountRuleName","fqn":"docs/ecom-v1-order.DiscountRuleName","slug":"discount-rule-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Original discount rule name (in site's default language)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated discount rule name according to buyer language. Defaults to `original` when not provided."}]},"docs/ecom-v1-order.DiscountType":{"name":"DiscountType","fqn":"docs/ecom-v1-order.DiscountType","slug":"discount-type","actions":[],"enumValues":["GLOBAL","SHIPPING","SPECIFIC_ITEMS"],"properties":[]},"docs/ecom-v1-order.LineItemDiscount":{"name":"LineItemDiscount","fqn":"docs/ecom-v1-order.LineItemDiscount","slug":"line-item-discount","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of line item the discount applies to."},{"name":"totalDiscount","slug":"total-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total discount for this line item."}]},"docs/ecom-v1-order.MerchantDiscount":{"name":"MerchantDiscount","fqn":"docs/ecom-v1-order.MerchantDiscount","slug":"merchant-discount","actions":[],"oneofProperties":{"merchantDiscountReason":[{"name":"description","slug":"description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount description as free text (optional)."},{"name":"discountReason","slug":"discount-reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountReason","referenceFqn":"docs/ecom-v1-order.DiscountReason"},"description":"Pre-defined discount reason (optional).\n* `\"ITEMS_EXCHANGE\"` - exchange balance acquired as a result of items exchange."}]},"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Discount amount."}]},"docs/ecom-v1-order.DiscountReason":{"name":"DiscountReason","fqn":"docs/ecom-v1-order.DiscountReason","slug":"discount-reason","actions":[],"enumValues":["EXCHANGED_ITEMS","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-order.AttributionSource":{"name":"AttributionSource","fqn":"docs/ecom-v1-order.AttributionSource","slug":"attribution-source","actions":[],"enumValues":["FACEBOOK_ADS","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-order.BalanceSummary":{"name":"BalanceSummary","fqn":"docs/ecom-v1-order.BalanceSummary","slug":"balance-summary","actions":[],"properties":[{"name":"balance","slug":"balance","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Balance","referenceFqn":"docs/ecom-v1-order.Balance"},"description":"Current amount left to pay."},{"name":"paid","slug":"paid","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Sum of all approved and successful payments.\n\nThe value includes payments that have subsequently been fully or partially refunded."},{"name":"refunded","slug":"refunded","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Sum of all successfully refunded payments."}]},"docs/ecom-v1-order.Balance":{"name":"Balance","fqn":"docs/ecom-v1-order.Balance","slug":"balance","actions":[],"properties":[{"name":"amount","slug":"amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Balance amount.\n\nA negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."}]},"docs/ecom-v1-order.AddressWithContact":{"name":"AddressWithContact","fqn":"docs/ecom-v1-order.AddressWithContact","slug":"address-with-contact","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-order.Address"},"description":"Address."},{"name":"contactDetails","slug":"contact-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FullAddressContactDetails","referenceFqn":"docs/ecom-v1-order.FullAddressContactDetails"},"description":"Contact details."}]},"docs/ecom-v1-order.Address":{"name":"Address","fqn":"docs/ecom-v1-order.Address","slug":"address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-order.StreetAddress"},"description":"Street address."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-order.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-order.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-order.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-order.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"docs/ecom-v1-order.FullAddressContactDetails":{"name":"FullAddressContactDetails","fqn":"docs/ecom-v1-order.FullAddressContactDetails","slug":"full-address-contact-details","actions":[],"properties":[{"name":"company","slug":"company","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Company name."},{"name":"firstName","slug":"first-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"First name."},{"name":"lastName","slug":"last-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Last name."},{"name":"phone","slug":"phone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Phone number."},{"name":"vatId","slug":"vat-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatId","referenceFqn":"docs/ecom-v1-order.VatId"},"description":"Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed."}]},"docs/ecom-v1-order.VatId":{"name":"VatId","fqn":"docs/ecom-v1-order.VatId","slug":"vat-id","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Customer's tax ID."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"VatType","referenceFqn":"docs/ecom-v1-order.VatType"},"description":"Tax type.\n\nSupported values:\n+ `CPF`: for individual tax payers\n+ `CNPJ`: for corporations"}]},"docs/ecom-v1-order.VatType":{"name":"VatType","fqn":"docs/ecom-v1-order.VatType","slug":"vat-type","actions":[],"enumValues":["CNPJ","CPF","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-order.BuyerInfo":{"name":"BuyerInfo","fqn":"docs/ecom-v1-order.BuyerInfo","slug":"buyer-info","actions":[],"oneofProperties":{"id":[{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID (if site visitor is a site member)."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID (if site visitor is not a member)."}]},"properties":[{"name":"contactId","slug":"contact-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction)."},{"name":"email","slug":"email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Buyer email address."}]},"docs/ecom-v1-order.ChannelInfo":{"name":"ChannelInfo","fqn":"docs/ecom-v1-order.ChannelInfo","slug":"channel-info","actions":[],"properties":[{"name":"externalOrderId","slug":"external-order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reference to an order ID from an external system."},{"name":"externalOrderUrl","slug":"external-order-url","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"URL to the order in the external system."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ChannelType","referenceFqn":"docs/ecom-v1-order.ChannelType"},"description":"Sales channel that submitted the order."}]},"docs/ecom-v1-order.ChannelType":{"name":"ChannelType","fqn":"docs/ecom-v1-order.ChannelType","slug":"channel-type","actions":[],"enumValues":["AMAZON","BACKOFFICE_MERCHANT","CLASS_PASS","EBAY","ETSY","FACEBOOK","FAIRE_COM","GLOBAL_E","OTHER_PLATFORM","POS","TIKTOK","UNSPECIFIED","WEB","WISH","WIX_APP_STORE","WIX_INVOICES"],"properties":[]},"docs/ecom-v1-order.CreatedBy":{"name":"CreatedBy","fqn":"docs/ecom-v1-order.CreatedBy","slug":"created-by","actions":[],"oneofProperties":{"string":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App ID - when the order was created by an external application."},{"name":"memberId","slug":"member-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Member ID - when the order was created by a **logged in** site visitor."},{"name":"userId","slug":"user-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"User ID - when the order was created by a Wix user on behalf of a buyer.\nFor example, via POS (point of service)."},{"name":"visitorId","slug":"visitor-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Visitor ID - when the order was created by a site visitor that was **not** logged in."}]},"properties":[]},"docs/ecom-v1-order.CustomField":{"name":"CustomField","fqn":"docs/ecom-v1-order.CustomField","slug":"custom-field","actions":[],"properties":[{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom field title."},{"name":"translatedTitle","slug":"translated-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Translated custom field title."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Custom field value."}]},"docs/ecom-v1-order.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-order.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-order.FulfillmentStatus":{"name":"FulfillmentStatus","fqn":"docs/ecom-v1-order.FulfillmentStatus","slug":"fulfillment-status","actions":[],"enumValues":["FULFILLED","NOT_FULFILLED","PARTIALLY_FULFILLED"],"properties":[]},"docs/ecom-v1-order.FulfillmentStatusesAggregate":{"name":"FulfillmentStatusesAggregate","fqn":"docs/ecom-v1-order.FulfillmentStatusesAggregate","slug":"fulfillment-statuses-aggregate","actions":[],"properties":[{"name":"statuses","slug":"statuses","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Unique string values based on Fulfillment entities statuses"}]},"docs/ecom-v1-order.OrderLineItem":{"name":"OrderLineItem","fqn":"docs/ecom-v1-order.OrderLineItem","slug":"order-line-item","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."},{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-order.CatalogReference"},"description":"References to the line item's origin catalog.\nThis field is empty in the case of a custom line item."},{"name":"depositAmount","slug":"deposit-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `\"DEPOSIT_ONLINE\"`."},{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-order.DescriptionLine"}},"description":"Line item description lines. Used for display purposes for the cart, checkout and order."},{"name":"digitalFile","slug":"digital-file","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DigitalFile","referenceFqn":"docs/ecom-v1-order.DigitalFile"},"description":"Digital file identifier, relevant only for items with type DIGITAL."},{"name":"fulfillerId","slug":"fulfiller-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfiller ID. Field is empty when the line item is self-fulfilled.\nTo get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order)."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image."},{"name":"itemType","slug":"item-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-order.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"paymentOption","slug":"payment-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentOptionType","referenceFqn":"docs/ecom-v1-order.PaymentOptionType"},"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_ONLINE` - The entire payment for this item happens as part of the checkout.\n+ `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.\n+ `DEPOSIT_ONLINE` - Partial payment for the given item to be paid upfront during the checkout. Eligible for catalog items with type `DEPOSIT_ONLINE` only."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-order.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU and item weight."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Line item price after line item discounts for display purposes."},{"name":"priceBeforeDiscounts","slug":"price-before-discounts","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Line item price before line item discounts for display purposes. Defaults to `price` when not provided."},{"name":"priceDescription","slug":"price-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-order.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-order.ProductName"},"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`"},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity."},{"name":"refundQuantity","slug":"refund-quantity","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items that were refunded."},{"name":"restockQuantity","slug":"restock-quantity","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items restocked."},{"name":"subscriptionInfo","slug":"subscription-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionInfo","referenceFqn":"docs/ecom-v1-order.SubscriptionInfo"},"description":"Subscription info."},{"name":"taxDetails","slug":"tax-details","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Deprecated. Use ","replacedBy":"tax_info","targetRemovalDate":"2024-09-30"},"type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-order.ItemTaxFullDetails"},"description":"Deprecated. Use `taxInfo` instead.\nThis field will be removed on September 30, 2024.\nTax details for this line item."},{"name":"taxInfo","slug":"tax-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LineItemTaxInfo","referenceFqn":"docs/ecom-v1-order.LineItemTaxInfo"},"description":"Represents all the relevant tax details for a specific line item."},{"name":"totalDiscount","slug":"total-discount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total discount for this line item's entire quantity."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price after all discounts and tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price after discounts, and before tax."}]},"docs/ecom-v1-order.CatalogReference":{"name":"CatalogReference","fqn":"docs/ecom-v1-order.CatalogReference","slug":"catalog-reference","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app providing the catalog.\n\nYou can get your app's ID from its page in the [Wix Dev Center](https://dev.wix.com/apps).\n\nFor items from Wix catalogs, the following values always apply:\n+ Wix Stores: `\"215238eb-22a5-4c36-9e7b-e7c08025e04e\"`\n+ Wix Bookings: `\"13d21c63-b5ec-5912-8397-c3a5ddb27a97\"`\n+ Wix Restaurants: `\"9a5d83fd-8570-482e-81ab-cfa88942ee60\"`"},{"name":"catalogItemId","slug":"catalog-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the item within the catalog it belongs to."},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}},"description":"Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.\n\nFor products and variants from a Wix Stores catalog, learn more about [eCommerce integration](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)."}]},"docs/ecom-v1-order.DescriptionLine":{"name":"DescriptionLine","fqn":"docs/ecom-v1-order.DescriptionLine","slug":"description-line","actions":[],"oneofProperties":{"value":[{"name":"colorInfo","slug":"color-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Color","referenceFqn":"docs/ecom-v1-order.Color"},"description":"Description line color value."},{"name":"plainText","slug":"plain-text","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PlainTextValue","referenceFqn":"docs/ecom-v1-order.PlainTextValue"},"description":"Description line plain text value."}],"descriptionLineValue":[]},"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DescriptionLineName","referenceFqn":"docs/ecom-v1-order.DescriptionLineName"},"description":"Description line name."}]},"docs/ecom-v1-order.Color":{"name":"Color","fqn":"docs/ecom-v1-order.Color","slug":"color","actions":[],"properties":[{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"HEX or RGB color code for display."},{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line color name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-order.DescriptionLineType":{"name":"DescriptionLineType","fqn":"docs/ecom-v1-order.DescriptionLineType","slug":"description-line-type","actions":[],"enumValues":["COLOR","PLAIN_TEXT","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-order.DescriptionLineName":{"name":"DescriptionLineName","fqn":"docs/ecom-v1-order.DescriptionLineName","slug":"description-line-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line name translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-order.PlainTextValue":{"name":"PlainTextValue","fqn":"docs/ecom-v1-order.PlainTextValue","slug":"plain-text-value","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Description line plain text value translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-order.DigitalFile":{"name":"DigitalFile","fqn":"docs/ecom-v1-order.DigitalFile","slug":"digital-file","actions":[],"properties":[{"name":"expirationDate","slug":"expiration-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Link expiration time and date."},{"name":"fileId","slug":"file-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the secure file in media."},{"name":"link","slug":"link","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Link will exist after the digital links have been generated on the order."}]},"docs/ecom-v1-order.ItemType":{"name":"ItemType","fqn":"docs/ecom-v1-order.ItemType","slug":"item-type","actions":[],"oneofProperties":{"itemTypeData":[{"name":"custom","slug":"custom","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Custom item type. When none of the preset types are suitable, specifies the custom type."},{"name":"preset","slug":"preset","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTypeItemType","referenceFqn":"docs/ecom-v1-order.ItemTypeItemType"},"description":"Preset item type."}]},"properties":[]},"docs/ecom-v1-order.ItemTypeItemType":{"name":"ItemTypeItemType","fqn":"docs/ecom-v1-order.ItemTypeItemType","slug":"item-type-item-type","actions":[],"enumValues":["DIGITAL","GIFT_CARD","PHYSICAL","SERVICE","UNRECOGNISED"],"properties":[]},"docs/ecom-v1-order.LocationAndQuantity":{"name":"LocationAndQuantity","fqn":"docs/ecom-v1-order.LocationAndQuantity","slug":"location-and-quantity","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location id in the associated owner app."},{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location owner app, if not provided then the site business info locations will be used."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Quantity for specific location."}]},"docs/ecom-v1-order.PaymentOptionType":{"name":"PaymentOptionType","fqn":"docs/ecom-v1-order.PaymentOptionType","slug":"payment-option-type","actions":[],"enumValues":["DEPOSIT_ONLINE","FULL_PAYMENT_OFFLINE","FULL_PAYMENT_ONLINE","MEMBERSHIP","MEMBERSHIP_OFFLINE"],"properties":[]},"docs/ecom-v1-order.PhysicalProperties":{"name":"PhysicalProperties","fqn":"docs/ecom-v1-order.PhysicalProperties","slug":"physical-properties","actions":[],"properties":[{"name":"shippable","slug":"shippable","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether this line item is shippable."},{"name":"sku","slug":"sku","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku)."},{"name":"weight","slug":"weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request."}]},"docs/ecom-v1-order.PriceDescription":{"name":"PriceDescription","fqn":"docs/ecom-v1-order.PriceDescription","slug":"price-description","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"__Required.__ Price description 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)."},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Price description translated into the buyer's language.\n\nDefault: Same as `original`."}]},"docs/ecom-v1-order.SubscriptionInfo":{"name":"SubscriptionInfo","fqn":"docs/ecom-v1-order.SubscriptionInfo","slug":"subscription-info","actions":[],"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription ID."},{"name":"cycleNumber","slug":"cycle-number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`."},{"name":"subscriptionOptionDescription","slug":"subscription-option-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option description. For example, `\"1kg of selected coffee, once a month\"`."},{"name":"subscriptionOptionTitle","slug":"subscription-option-title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subscription option title. For example, `\"Monthly coffee Subscription\"`."},{"name":"subscriptionSettings","slug":"subscription-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionSettings","referenceFqn":"docs/ecom-v1-order.SubscriptionSettings"},"description":"Subscription detailed information."}]},"docs/ecom-v1-order.SubscriptionSettings":{"name":"SubscriptionSettings","fqn":"docs/ecom-v1-order.SubscriptionSettings","slug":"subscription-settings","actions":[],"properties":[{"name":"autoRenewal","slug":"auto-renewal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether subscription is renewed automatically at the end of each period."},{"name":"billingCycles","slug":"billing-cycles","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`."},{"name":"frequency","slug":"frequency","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SubscriptionFrequency","referenceFqn":"docs/ecom-v1-order.SubscriptionFrequency"},"description":"Frequency of recurring payment."},{"name":"interval","slug":"interval","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Interval of recurring payment."}]},"docs/ecom-v1-order.SubscriptionFrequency":{"name":"SubscriptionFrequency","fqn":"docs/ecom-v1-order.SubscriptionFrequency","slug":"subscription-frequency","actions":[],"enumValues":["DAY","MONTH","UNDEFINED","WEEK","YEAR"],"properties":[]},"docs/ecom-v1-order.LineItemTaxInfo":{"name":"LineItemTaxInfo","fqn":"docs/ecom-v1-order.LineItemTaxInfo","slug":"line-item-tax-info","actions":[],"properties":[{"name":"taxAmount","slug":"tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Calculated tax, based on `taxable_amount` and `tax_rate`."},{"name":"taxBreakdown","slug":"tax-breakdown","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItemTaxBreakdown","referenceFqn":"docs/ecom-v1-order.LineItemTaxBreakdown"}},"description":"Tax information for a line item."},{"name":"taxGroupId","slug":"tax-group-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax group ID.\nLearn more about [Tax Groups](https://dev.wix.com/docs/rest/business-management/payments/tax/tax-groups/introduction)."},{"name":"taxIncludedInPrice","slug":"tax-included-in-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indicates whether the price already includes tax."},{"name":"taxRate","slug":"tax-rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate %, as a decimal point."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Amount for which tax is calculated."}]},"docs/ecom-v1-order.LineItemTaxBreakdown":{"name":"LineItemTaxBreakdown","fqn":"docs/ecom-v1-order.LineItemTaxBreakdown","slug":"line-item-tax-breakdown","actions":[],"properties":[{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Jurisdiction that taxes were calculated for. For example, \"New York\", or \"Quebec\"."},{"name":"jurisdictionType","slug":"jurisdiction-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-order.JurisdictionType"},"description":"Type of jurisdiction that taxes were calculated for."},{"name":"nonTaxableAmount","slug":"non-taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Non-taxable amount of the line item price."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000."},{"name":"taxAmount","slug":"tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Amount of tax calculated for this line item."},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated. For example, \"NY State Sales Tax\", \"Quebec GST\", etc.\nThis name should be explicit enough to allow the merchant to understand what tax was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, \"Sales Tax\", \"Income Tax\", \"Value Added Tax\", etc."},{"name":"taxableAmount","slug":"taxable-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Taxable amount of the line item price."}]},"docs/ecom-v1-order.JurisdictionType":{"name":"JurisdictionType","fqn":"docs/ecom-v1-order.JurisdictionType","slug":"jurisdiction-type","actions":[],"enumValues":["CITY","COUNTRY","COUNTY","SPECIAL","STATE","UNDEFINED"],"properties":[]},"docs/ecom-v1-order.PriceSummary":{"name":"PriceSummary","fqn":"docs/ecom-v1-order.PriceSummary","slug":"price-summary","actions":[],"properties":[{"name":"discount","slug":"discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total calculated discount value."},{"name":"shipping","slug":"shipping","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total shipping price, before discounts and before tax."},{"name":"subtotal","slug":"subtotal","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Subtotal of all the line items, before discounts and before tax."},{"name":"tax","slug":"tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total tax on this order."},{"name":"total","slug":"total","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Order’s total price after discounts and tax."},{"name":"totalAdditionalFees","slug":"total-additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price of additional fees before tax."}]},"docs/ecom-v1-order.PaymentStatus":{"name":"PaymentStatus","fqn":"docs/ecom-v1-order.PaymentStatus","slug":"payment-status","actions":[],"enumValues":["FULLY_REFUNDED","NOT_PAID","PAID","PARTIALLY_PAID","PARTIALLY_REFUNDED","PENDING","UNSPECIFIED"],"properties":[]},"docs/ecom-v1-order.V1ShippingInformation":{"name":"V1ShippingInformation","fqn":"docs/ecom-v1-order.V1ShippingInformation","slug":"v1shipping-information","actions":[],"properties":[{"name":"carrierId","slug":"carrier-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"App Def Id of external provider which was a source of shipping info"},{"name":"code","slug":"code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Unique code (or ID) of selected shipping option. For example, `\"usps_std_overnight\"``."},{"name":"cost","slug":"cost","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingPrice","referenceFqn":"docs/ecom-v1-order.ShippingPrice"},"description":"Shipping costs."},{"name":"logistics","slug":"logistics","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryLogistics","referenceFqn":"docs/ecom-v1-order.DeliveryLogistics"},"description":"Shipping logistics."},{"name":"region","slug":"region","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingRegion","referenceFqn":"docs/ecom-v1-order.ShippingRegion"},"description":"Shipping region."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Shipping option title.\nFor example, `\"USPS Standard Overnight Delivery\"`, `\"Standard\"` or `\"First-Class Package International\"`."}]},"docs/ecom-v1-order.ShippingPrice":{"name":"ShippingPrice","fqn":"docs/ecom-v1-order.ShippingPrice","slug":"shipping-price","actions":[],"properties":[{"name":"discount","slug":"discount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Shipping discount before tax."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Shipping price for display purposes."},{"name":"taxDetails","slug":"tax-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-order.ItemTaxFullDetails"},"description":"Tax details."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Shipping price after all discounts (if any exist), and after tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price of shipping after discounts (when relevant), and before tax."}]},"docs/ecom-v1-order.DeliveryLogistics":{"name":"DeliveryLogistics","fqn":"docs/ecom-v1-order.DeliveryLogistics","slug":"delivery-logistics","actions":[],"oneofProperties":{"address":[{"name":"pickupDetails","slug":"pickup-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupDetails","referenceFqn":"docs/ecom-v1-order.PickupDetails"},"description":"Pickup details."},{"name":"shippingDestination","slug":"shipping-destination","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AddressWithContact","referenceFqn":"docs/ecom-v1-order.AddressWithContact"},"description":"Shipping address and contact details."}]},"properties":[{"name":"deliverByDate","slug":"deliver-by-date","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"","replacedBy":"","targetRemovalDate":""},"type":{"kind":"DATE"},"description":"Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"deliveryTime","slug":"delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Expected delivery time in free text. For example, `\"3-5 business days\"`."},{"name":"deliveryTimeSlot","slug":"delivery-time-slot","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryTimeSlot","referenceFqn":"docs/ecom-v1-order.DeliveryTimeSlot"},"description":"Expected delivery time."},{"name":"instructions","slug":"instructions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Instructions for carrier. For example, `\"Please knock on the door. If unanswered, please call contact number. Thanks.\"`."}]},"docs/ecom-v1-order.DeliveryTimeSlot":{"name":"DeliveryTimeSlot","fqn":"docs/ecom-v1-order.DeliveryTimeSlot","slug":"delivery-time-slot","actions":[],"properties":[{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Delivery slot starting time."},{"name":"to","slug":"to","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Delivery slot ending time."}]},"docs/ecom-v1-order.PickupDetails":{"name":"PickupDetails","fqn":"docs/ecom-v1-order.PickupDetails","slug":"pickup-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupAddress","referenceFqn":"docs/ecom-v1-order.PickupAddress"},"description":"Pickup address."},{"name":"pickupMethod","slug":"pickup-method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupMethod","referenceFqn":"docs/ecom-v1-order.PickupMethod"},"description":"Pickup method"}]},"docs/ecom-v1-order.PickupAddress":{"name":"PickupAddress","fqn":"docs/ecom-v1-order.PickupAddress","slug":"pickup-address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-order.StreetAddress"},"description":"Street address object, with number, name, and apartment number in separate fields."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-order.PickupMethod":{"name":"PickupMethod","fqn":"docs/ecom-v1-order.PickupMethod","slug":"pickup-method","actions":[],"enumValues":["PICKUP_POINT","STORE_PICKUP","UNKNOWN_METHOD"],"properties":[]},"docs/ecom-v1-order.ShippingRegion":{"name":"ShippingRegion","fqn":"docs/ecom-v1-order.ShippingRegion","slug":"shipping-region","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Name of shipping region. For example, `\"Metropolitan London\"`, or `\"Outer Melbourne suburbs\"`."}]},"docs/ecom-v1-order.OrderStatus":{"name":"OrderStatus","fqn":"docs/ecom-v1-order.OrderStatus","slug":"order-status","actions":[],"enumValues":["APPROVED","CANCELED","INITIALIZED"],"properties":[]},"docs/ecom-v1-order.Tags":{"name":"Tags","fqn":"docs/ecom-v1-order.Tags","slug":"tags","actions":[],"properties":[{"name":"privateTags","slug":"private-tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TagList","referenceFqn":"docs/ecom-v1-order.TagList"},"description":"Tags that require an additional permission in order to access them, normally not given to site members or visitors."},{"name":"tags","slug":"tags","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TagList","referenceFqn":"docs/ecom-v1-order.TagList"},"description":"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."}]},"docs/ecom-v1-order.TagList":{"name":"TagList","fqn":"docs/ecom-v1-order.TagList","slug":"tag-list","actions":[],"properties":[{"name":"tagIds","slug":"tag-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of tag IDs"}]},"docs/ecom-v1-order.OrderTaxInfo":{"name":"OrderTaxInfo","fqn":"docs/ecom-v1-order.OrderTaxInfo","slug":"order-tax-info","actions":[],"properties":[{"name":"taxBreakdown","slug":"tax-breakdown","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"OrderTaxBreakdown","referenceFqn":"docs/ecom-v1-order.OrderTaxBreakdown"}},"description":"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."},{"name":"totalTax","slug":"total-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Calculated tax, added from line items."}]},"docs/ecom-v1-order.OrderTaxBreakdown":{"name":"OrderTaxBreakdown","fqn":"docs/ecom-v1-order.OrderTaxBreakdown","slug":"order-tax-breakdown","actions":[],"properties":[{"name":"aggregatedTaxAmount","slug":"aggregated-tax-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"The sum of all the tax from line items that calculated by the tax identifiers."},{"name":"jurisdiction","slug":"jurisdiction","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the jurisdiction in which this tax detail applies."},{"name":"jurisdictionType","slug":"jurisdiction-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"JurisdictionType","referenceFqn":"docs/ecom-v1-order.JurisdictionType"},"description":"The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special)."},{"name":"rate","slug":"rate","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The rate at which this tax detail was calculated."},{"name":"taxName","slug":"tax-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of the tax against which this tax amount was calculated."},{"name":"taxType","slug":"tax-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws."}]},"docs/ecom-v1-order.TaxSummary":{"name":"TaxSummary","fqn":"docs/ecom-v1-order.TaxSummary","slug":"tax-summary","actions":[],"properties":[{"name":"totalTax","slug":"total-tax","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total tax."}]},"docs/ecom-v1-order.WeightUnit":{"name":"WeightUnit","fqn":"docs/ecom-v1-order.WeightUnit","slug":"weight-unit","actions":[],"enumValues":["KG","LB","UNSPECIFIED_WEIGHT_UNIT"],"properties":[]},"docs/ecom-v1-order.OrdersExperiments":{"name":"OrdersExperiments","fqn":"docs/ecom-v1-order.OrdersExperiments","slug":"orders-experiments","actions":[],"properties":[{"name":"enableRewrittenSideEffects","slug":"enable-rewritten-side-effects","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"epCommitTax","slug":"ep-commit-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"moveBuyerOrderConfirmationEmailToEp","slug":"move-buyer-order-confirmation-email-to-ep","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"moveMerchantEmailToEp","slug":"move-merchant-email-to-ep","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"producedByEpBridge","slug":"produced-by-ep-bridge","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}]},"docs/ecom-v1-order.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-order.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-order.OrderCanceled":{"name":"OrderCanceled","fqn":"docs/ecom-v1-order.OrderCanceled","slug":"order-canceled","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderCanceledEventOrderCanceled","referenceFqn":"docs/ecom-v1-order.OrderCanceledEventOrderCanceled"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order.OrderCanceledEventOrderCanceled":{"name":"OrderCanceledEventOrderCanceled","fqn":"docs/ecom-v1-order.OrderCanceledEventOrderCanceled","slug":"order-canceled-event-order-canceled","actions":[],"properties":[{"name":"customMessage","slug":"custom-message","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Personal note added to the email"},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"docs/ecom-v1-order.Order"},"description":"The order that was cancelled"},{"name":"restockAllItems","slug":"restock-all-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Should restock all items on that order"},{"name":"sendOrderCanceledEmail","slug":"send-order-canceled-email","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Should send a confirmation mail to the customer"}]},"docs/ecom-v1-order.OrderCommitted":{"name":"OrderCommitted","fqn":"docs/ecom-v1-order.OrderCommitted","slug":"order-committed","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderDeltasCommitted","referenceFqn":"docs/ecom-v1-order.OrderDeltasCommitted"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order.OrderDeltasCommitted":{"name":"OrderDeltasCommitted","fqn":"docs/ecom-v1-order.OrderDeltasCommitted","slug":"order-deltas-committed","actions":[],"properties":[{"name":"changes","slug":"changes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommittedDiffs","referenceFqn":"docs/ecom-v1-order.CommittedDiffs"},"description":"Applied changes."},{"name":"commitDate","slug":"commit-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time when order deltas were committed."},{"name":"commitSettings","slug":"commit-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DraftOrderCommitSettings","referenceFqn":"docs/ecom-v1-order.DraftOrderCommitSettings"},"description":"Side-effects requested to happen as a result of this edit."},{"name":"draftOrderId","slug":"draft-order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Draft order Id representing this change."},{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"docs/ecom-v1-order.Order"},"description":"The order after committed changes."}]},"docs/ecom-v1-order.CommittedDiffs":{"name":"CommittedDiffs","fqn":"docs/ecom-v1-order.CommittedDiffs","slug":"committed-diffs","actions":[],"oneofProperties":{"shippingUpdateInfo":[{"name":"changedShippingInfo","slug":"changed-shipping-info","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"V1ShippingInformation","referenceFqn":"docs/ecom-v1-order.V1ShippingInformation"},"description":"Shipping info and selected shipping option details."},{"name":"shippingInfoRemoved","slug":"shipping-info-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Remove existing shipping info."}]},"properties":[{"name":"additionalFees","slug":"additional-fees","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AdditionalFeeDelta","referenceFqn":"docs/ecom-v1-order.AdditionalFeeDelta"}},"description":"Added/updated/removed additional fee."},{"name":"appliedDiscounts","slug":"applied-discounts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AppliedDiscountDelta","referenceFqn":"docs/ecom-v1-order.AppliedDiscountDelta"}},"description":"Added/updated/removed discounts.\ntodo: set (.wix.api.maxSize). need to find it. existing : merchant can have 100 + 1 coupon + ? due to automatic discounts"},{"name":"lineItems","slug":"line-items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"LineItemDelta","referenceFqn":"docs/ecom-v1-order.LineItemDelta"}},"description":"Added/updated/removed order line items."}]},"docs/ecom-v1-order.AdditionalFeeDelta":{"name":"AdditionalFeeDelta","fqn":"docs/ecom-v1-order.AdditionalFeeDelta","slug":"additional-fee-delta","actions":[],"oneofProperties":{"delta":[{"name":"additionalFeeRemoved","slug":"additional-fee-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"editedAdditionalFee","slug":"edited-additional-fee","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AdditionalFee","referenceFqn":"docs/ecom-v1-order.AdditionalFee"}}]},"properties":[{"name":"additionalFeeId","slug":"additional-fee-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Additional fee id."}]},"docs/ecom-v1-order.AppliedDiscountDelta":{"name":"AppliedDiscountDelta","fqn":"docs/ecom-v1-order.AppliedDiscountDelta","slug":"applied-discount-delta","actions":[],"oneofProperties":{"delta":[{"name":"discountRemoved","slug":"discount-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"editedDiscount","slug":"edited-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AppliedDiscount","referenceFqn":"docs/ecom-v1-order.AppliedDiscount"}}]},"properties":[{"name":"discountId","slug":"discount-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Discount id."}]},"docs/ecom-v1-order.LineItemDelta":{"name":"LineItemDelta","fqn":"docs/ecom-v1-order.LineItemDelta","slug":"line-item-delta","actions":[],"oneofProperties":{"delta":[{"name":"changedDetails","slug":"changed-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemChangedDetails","referenceFqn":"docs/ecom-v1-order.ItemChangedDetails"}},{"name":"lineItemAdded","slug":"line-item-added","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}},{"name":"lineItemRemoved","slug":"line-item-removed","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderLineItemChangedDetails","referenceFqn":"docs/ecom-v1-order.OrderLineItemChangedDetails"}}]},"properties":[{"name":"lineItemId","slug":"line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID."}]},"docs/ecom-v1-order.ItemChangedDetails":{"name":"ItemChangedDetails","fqn":"docs/ecom-v1-order.ItemChangedDetails","slug":"item-changed-details","actions":[],"properties":[{"name":"priceBeforeChange","slug":"price-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"The price before the change."},{"name":"priceDescriptionBeforeChange","slug":"price-description-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-order.PriceDescription"},"description":"The price description before the change"},{"name":"quantityBeforeChange","slug":"quantity-before-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The quantity before the change."}]},"docs/ecom-v1-order.OrderLineItemChangedDetails":{"name":"OrderLineItemChangedDetails","fqn":"docs/ecom-v1-order.OrderLineItemChangedDetails","slug":"order-line-item-changed-details","actions":[],"properties":[{"name":"catalogReference","slug":"catalog-reference","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CatalogReference","referenceFqn":"docs/ecom-v1-order.CatalogReference"},"description":"References to the line item's origin catalog.\nThis field is empty in the case of a custom line item."},{"name":"descriptionLines","slug":"description-lines","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DescriptionLine","referenceFqn":"docs/ecom-v1-order.DescriptionLine"}},"description":"Line item description lines. Used for display purposes for the cart, checkout and order."},{"name":"fulfillerId","slug":"fulfiller-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfiller ID. Field is empty when the line item is self-fulfilled.\nTo get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order)."},{"name":"image","slug":"image","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item image."},{"name":"itemType","slug":"item-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ItemType","referenceFqn":"docs/ecom-v1-order.ItemType"},"description":"Item type. Either a preset type or custom."},{"name":"lineItemPrice","slug":"line-item-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price **after** catalog-defined discount and line item discounts."},{"name":"paymentOption","slug":"payment-option","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeltaPaymentOptionType","referenceFqn":"docs/ecom-v1-order.DeltaPaymentOptionType"},"description":"Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.\n+ `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.\n+ `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0."},{"name":"physicalProperties","slug":"physical-properties","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PhysicalProperties","referenceFqn":"docs/ecom-v1-order.PhysicalProperties"},"description":"Physical properties of the item. When relevant, contains information such as SKU and item weight."},{"name":"price","slug":"price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Line item price after line item discounts for display purposes."},{"name":"priceBeforeDiscounts","slug":"price-before-discounts","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Line item price before line item discounts for display purposes. Defaults to `price` when not provided."},{"name":"priceDescription","slug":"price-description","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PriceDescription","referenceFqn":"docs/ecom-v1-order.PriceDescription"},"description":"Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - \"Starts at $67\"."},{"name":"productName","slug":"product-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ProductName","referenceFqn":"docs/ecom-v1-order.ProductName"},"description":"Item name.\n+ Stores - `product.name`\n+ Bookings - `service.info.name`\n+ Events - `ticket.name`"},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity."},{"name":"taxDetails","slug":"tax-details","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Deprecated. Use ","replacedBy":"tax_info","targetRemovalDate":"2024-09-30"},"type":{"kind":"REFERENCE","name":"ItemTaxFullDetails","referenceFqn":"docs/ecom-v1-order.ItemTaxFullDetails"},"description":"Deprecated. Use `taxInfo` instead.\nThis field will be removed on September 30, 2024.\nTax details for this line item."},{"name":"totalDiscount","slug":"total-discount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total discount for this line item's entire quantity."},{"name":"totalPriceAfterTax","slug":"total-price-after-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price after all discounts and tax."},{"name":"totalPriceBeforeTax","slug":"total-price-before-tax","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order.Price"},"description":"Total price after all discounts excluding tax."}]},"docs/ecom-v1-order.DeltaPaymentOptionType":{"name":"DeltaPaymentOptionType","fqn":"docs/ecom-v1-order.DeltaPaymentOptionType","slug":"delta-payment-option-type","actions":[],"enumValues":["FULL_PAYMENT_OFFLINE","MEMBERSHIP_OFFLINE","UNKNOWN_PAYMENT_OPTION"],"properties":[]},"docs/ecom-v1-order.DraftOrderCommitSettings":{"name":"DraftOrderCommitSettings","fqn":"docs/ecom-v1-order.DraftOrderCommitSettings","slug":"draft-order-commit-settings","actions":[],"properties":[{"name":"addActivitiesToOrder","slug":"add-activities-to-order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If false,do not add activities to the order. Default is true."},{"name":"inventoryUpdates","slug":"inventory-updates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InventoryUpdateDetails","referenceFqn":"docs/ecom-v1-order.InventoryUpdateDetails"}},"description":"Inventory changes to be applied. Either to restock, or decrease."},{"name":"sendNotificationsToBusiness","slug":"send-notifications-to-business","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If false, do not send notifications to business. Default is true."},{"name":"sendNotificationsToBuyer","slug":"send-notifications-to-buyer","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If false, do not send notifications to buyer. Default is true."},{"name":"sendNotificationsToCustomFulfillers","slug":"send-notifications-to-custom-fulfillers","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true."}]},"docs/ecom-v1-order.InventoryUpdateDetails":{"name":"InventoryUpdateDetails","fqn":"docs/ecom-v1-order.InventoryUpdateDetails","slug":"inventory-update-details","actions":[],"properties":[{"name":"actionType","slug":"action-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"InventoryAction","referenceFqn":"docs/ecom-v1-order.InventoryAction"},"description":"Action to be applied - decrease or restock"},{"name":"lineItemId","slug":"line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order line item id"},{"name":"quantityChange","slug":"quantity-change","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The amount to be increased or restocked"}]},"docs/ecom-v1-order.InventoryAction":{"name":"InventoryAction","fqn":"docs/ecom-v1-order.InventoryAction","slug":"inventory-action","actions":[],"enumValues":["DECREASE","RESTOCK"],"properties":[]},"docs/ecom-v1-order.OrderCreated":{"name":"OrderCreated","fqn":"docs/ecom-v1-order.OrderCreated","slug":"order-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"docs/ecom-v1-order.Order"},"description":"Created order."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order.OrderPaymentStatusUpdated":{"name":"OrderPaymentStatusUpdated","fqn":"docs/ecom-v1-order.OrderPaymentStatusUpdated","slug":"order-payment-status-updated","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentStatusUpdated","referenceFqn":"docs/ecom-v1-order.PaymentStatusUpdated"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order.PaymentStatusUpdated":{"name":"PaymentStatusUpdated","fqn":"docs/ecom-v1-order.PaymentStatusUpdated","slug":"payment-status-updated","actions":[],"properties":[{"name":"order","slug":"order","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"docs/ecom-v1-order.Order"},"description":"The order that was updated"},{"name":"previousPaymentStatus","slug":"previous-payment-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentStatus","referenceFqn":"docs/ecom-v1-order.PaymentStatus"},"description":"The previous status (before the update)"}]},"docs/ecom-v1-order.OrderUpdated":{"name":"OrderUpdated","fqn":"docs/ecom-v1-order.OrderUpdated","slug":"order-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Order","referenceFqn":"docs/ecom-v1-order.Order"},"description":"Updated order."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order-transactions.OrderTransactionsUpdated":{"name":"OrderTransactionsUpdated","fqn":"docs/ecom-v1-order-transactions.OrderTransactionsUpdated","slug":"order-transactions-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PaymentsUpdated","referenceFqn":"docs/ecom-v1-order-transactions.PaymentsUpdated"},"description":"Updated order transactions."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-order-transactions.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-order-transactions.PaymentsUpdated":{"name":"PaymentsUpdated","fqn":"docs/ecom-v1-order-transactions.PaymentsUpdated","slug":"payments-updated","actions":[],"properties":[{"name":"orderTransactions","slug":"order-transactions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderTransactions","referenceFqn":"docs/ecom-v1-order-transactions.OrderTransactions"},"description":"Updated order transactions."},{"name":"paymentIds","slug":"payment-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of the updated payments."},{"name":"refundIds","slug":"refund-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of IDs of the updated refunds."}]},"docs/ecom-v1-order-transactions.OrderTransactions":{"name":"OrderTransactions","fqn":"docs/ecom-v1-order-transactions.OrderTransactions","slug":"order-transactions","actions":[],"properties":[{"name":"orderId","slug":"order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Order ID."},{"name":"payments","slug":"payments","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Payment","referenceFqn":"docs/ecom-v1-order-transactions.Payment"}},"description":"Record of payments made to the merchant."},{"name":"refunds","slug":"refunds","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Refund","referenceFqn":"docs/ecom-v1-order-transactions.Refund"}},"description":"Record of refunds made to the buyer."}]},"docs/ecom-v1-order-transactions.Payment":{"name":"Payment","fqn":"docs/ecom-v1-order-transactions.Payment","slug":"payment","actions":[],"oneofProperties":{"paymentDetails":[{"name":"giftcardPaymentDetails","slug":"giftcard-payment-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GiftCardPaymentDetails","referenceFqn":"docs/ecom-v1-order-transactions.GiftCardPaymentDetails"},"description":"Gift card payment details."},{"name":"regularPaymentDetails","slug":"regular-payment-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RegularPaymentDetails","referenceFqn":"docs/ecom-v1-order-transactions.RegularPaymentDetails"},"description":"Regular payment details."}]},"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format."},{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order-transactions.Price"},"description":"Payment amount."},{"name":"refundDisabled","slug":"refund-disabled","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether refunds for this payment are disabled.\n+ `true`: This payment is not refundable.\n+ `false`: This payment may be refunded. However, this ultimately depends on the payment provider."}]},"docs/ecom-v1-order-transactions.Price":{"name":"Price","fqn":"docs/ecom-v1-order-transactions.Price","slug":"price","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount."},{"name":"formattedAmount","slug":"formatted-amount","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount formatted with currency symbol."}]},"docs/ecom-v1-order-transactions.GiftCardPaymentDetails":{"name":"GiftCardPaymentDetails","fqn":"docs/ecom-v1-order-transactions.GiftCardPaymentDetails","slug":"gift-card-payment-details","actions":[],"properties":[{"name":"appId","slug":"app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the app that created the gift card."},{"name":"giftCardPaymentId","slug":"gift-card-payment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Gift card payment ID."},{"name":"voided","slug":"voided","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the gift card is voided."}]},"docs/ecom-v1-order-transactions.MembershipPaymentDetails":{"name":"MembershipPaymentDetails","fqn":"docs/ecom-v1-order-transactions.MembershipPaymentDetails","slug":"membership-payment-details","actions":[],"properties":[{"name":"externalTransactionId","slug":"external-transaction-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The transaction ID in the membership system. Can be used to void the transaction."},{"name":"lineItemId","slug":"line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the line item this membership applies to."},{"name":"membershipId","slug":"membership-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Membership ID."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipName","referenceFqn":"docs/ecom-v1-order-transactions.MembershipName"},"description":"Membership name."},{"name":"providerAppId","slug":"provider-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the application providing this payment option."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MembershipPaymentStatus","referenceFqn":"docs/ecom-v1-order-transactions.MembershipPaymentStatus"},"description":"Payment status."},{"name":"voided","slug":"voided","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the membership is voided."}]},"docs/ecom-v1-order-transactions.MembershipName":{"name":"MembershipName","fqn":"docs/ecom-v1-order-transactions.MembershipName","slug":"membership-name","actions":[],"properties":[{"name":"original","slug":"original","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The name of this membership"},{"name":"translated","slug":"translated","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Optional - Translated name of this membership. Defaults to `original` when not provided."}]},"docs/ecom-v1-order-transactions.MembershipPaymentStatus":{"name":"MembershipPaymentStatus","fqn":"docs/ecom-v1-order-transactions.MembershipPaymentStatus","slug":"membership-payment-status","actions":[],"enumValues":["CHARGED","CHARGE_FAILED"],"properties":[]},"docs/ecom-v1-order-transactions.RegularPaymentDetails":{"name":"RegularPaymentDetails","fqn":"docs/ecom-v1-order-transactions.RegularPaymentDetails","slug":"regular-payment-details","actions":[],"oneofProperties":{"paymentMethodDetails":[]},"properties":[{"name":"gatewayTransactionId","slug":"gateway-transaction-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment gateway's transaction ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\nThis field is only returned when the value of `offline_payment` is `false`."},{"name":"offlinePayment","slug":"offline-payment","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager."},{"name":"paymentMethod","slug":"payment-method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment method. Non-exhaustive list of supported values:\n+ `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`"},{"name":"paymentOrderId","slug":"payment-order-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Wix Payments order ID."},{"name":"providerTransactionId","slug":"provider-transaction-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments."},{"name":"savedPaymentMethod","slug":"saved-payment-method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether there is a payment agreement that allows for future charges."},{"name":"status","slug":"status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TransactionStatus","referenceFqn":"docs/ecom-v1-order-transactions.TransactionStatus"},"description":"Payment status."}]},"docs/ecom-v1-order-transactions.AuthorizationDetails":{"name":"AuthorizationDetails","fqn":"docs/ecom-v1-order-transactions.AuthorizationDetails","slug":"authorization-details","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.AuthorizationCapture":{"name":"AuthorizationCapture","fqn":"docs/ecom-v1-order-transactions.AuthorizationCapture","slug":"authorization-capture","actions":[],"properties":[{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Capture ID."}]},"docs/ecom-v1-order-transactions.AuthorizationActionFailureDetails":{"name":"AuthorizationActionFailureDetails","fqn":"docs/ecom-v1-order-transactions.AuthorizationActionFailureDetails","slug":"authorization-action-failure-details","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.AuthorizationCaptureStatus":{"name":"AuthorizationCaptureStatus","fqn":"docs/ecom-v1-order-transactions.AuthorizationCaptureStatus","slug":"authorization-capture-status","actions":[],"enumValues":["FAILED","PENDING","SUCCEEDED","UNKNOWN_STATUS"],"properties":[]},"docs/ecom-v1-order-transactions.ScheduledAction":{"name":"ScheduledAction","fqn":"docs/ecom-v1-order-transactions.ScheduledAction","slug":"scheduled-action","actions":[],"properties":[{"name":"actionType","slug":"action-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ActionType","referenceFqn":"docs/ecom-v1-order-transactions.ActionType"},"description":"type of the action"},{"name":"executionDate","slug":"execution-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"the date and time of the action"}]},"docs/ecom-v1-order-transactions.ActionType":{"name":"ActionType","fqn":"docs/ecom-v1-order-transactions.ActionType","slug":"action-type","actions":[],"enumValues":["CAPTURE","UNKNOWN_ACTION_TYPE","VOID"],"properties":[]},"docs/ecom-v1-order-transactions.AuthorizationVoid":{"name":"AuthorizationVoid","fqn":"docs/ecom-v1-order-transactions.AuthorizationVoid","slug":"authorization-void","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.Reason":{"name":"Reason","fqn":"docs/ecom-v1-order-transactions.Reason","slug":"reason","actions":[],"enumValues":["MANUAL","SCHEDULED","UNKNOWN_REASON"],"properties":[]},"docs/ecom-v1-order-transactions.AuthorizationVoidStatus":{"name":"AuthorizationVoidStatus","fqn":"docs/ecom-v1-order-transactions.AuthorizationVoidStatus","slug":"authorization-void-status","actions":[],"enumValues":["FAILED","PENDING","SUCCEEDED","UNKNOWN_STATUS"],"properties":[]},"docs/ecom-v1-order-transactions.CreditCardPaymentMethodDetails":{"name":"CreditCardPaymentMethodDetails","fqn":"docs/ecom-v1-order-transactions.CreditCardPaymentMethodDetails","slug":"credit-card-payment-method-details","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.TransactionStatus":{"name":"TransactionStatus","fqn":"docs/ecom-v1-order-transactions.TransactionStatus","slug":"transaction-status","actions":[],"enumValues":["APPROVED","AUTHORIZED","CANCELED","DECLINED","PARTIALLY_REFUNDED","PENDING","PENDING_MERCHANT","REFUNDED","UNDEFINED","VOIDED"],"properties":[]},"docs/ecom-v1-order-transactions.Refund":{"name":"Refund","fqn":"docs/ecom-v1-order-transactions.Refund","slug":"refund","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Refund ID."},{"name":"details","slug":"details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RefundDetails","referenceFqn":"docs/ecom-v1-order-transactions.RefundDetails"},"description":"Refund business details."},{"name":"transactions","slug":"transactions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RefundTransaction","referenceFqn":"docs/ecom-v1-order-transactions.RefundTransaction"}},"description":"List of transactions."}]},"docs/ecom-v1-order-transactions.RefundDetails":{"name":"RefundDetails","fqn":"docs/ecom-v1-order-transactions.RefundDetails","slug":"refund-details","actions":[],"properties":[{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"RefundItem","referenceFqn":"docs/ecom-v1-order-transactions.RefundItem"}},"description":"Order line item IDs and quantities that were refunded."},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Reason for the refund, provided by customer (optional)."},{"name":"shippingIncluded","slug":"shipping-included","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the shipping fee was also refunded."}]},"docs/ecom-v1-order-transactions.AdditionalFeeRefund":{"name":"AdditionalFeeRefund","fqn":"docs/ecom-v1-order-transactions.AdditionalFeeRefund","slug":"additional-fee-refund","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.RefundItem":{"name":"RefundItem","fqn":"docs/ecom-v1-order-transactions.RefundItem","slug":"refund-item","actions":[],"properties":[{"name":"lineItemId","slug":"line-item-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Line item ID the refunded line item."},{"name":"quantity","slug":"quantity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Line item quantity refunded."}]},"docs/ecom-v1-order-transactions.LineItemRefund":{"name":"LineItemRefund","fqn":"docs/ecom-v1-order-transactions.LineItemRefund","slug":"line-item-refund","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.ShippingRefund":{"name":"ShippingRefund","fqn":"docs/ecom-v1-order-transactions.ShippingRefund","slug":"shipping-refund","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.AggregatedRefundSummary":{"name":"AggregatedRefundSummary","fqn":"docs/ecom-v1-order-transactions.AggregatedRefundSummary","slug":"aggregated-refund-summary","actions":[],"properties":[]},"docs/ecom-v1-order-transactions.RefundTransaction":{"name":"RefundTransaction","fqn":"docs/ecom-v1-order-transactions.RefundTransaction","slug":"refund-transaction","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Price","referenceFqn":"docs/ecom-v1-order-transactions.Price"},"description":"Refund amount."},{"name":"externalRefund","slug":"external-refund","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether refund was made externally and manually on the payment provider's side."},{"name":"gatewayRefundId","slug":"gateway-refund-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Payment gateway's refund ID. This ID can be used with the Wix Payments [Transactions API](https://dev.wix.com/docs/rest/api-reference/wix-payments/transactions/introduction).\nThis field is only returned when the value of `external_refund` is `false`."},{"name":"paymentId","slug":"payment-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the payment associated with this refund."},{"name":"providerRefundId","slug":"provider-refund-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds."},{"name":"refundStatus","slug":"refund-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"RefundStatus","referenceFqn":"docs/ecom-v1-order-transactions.RefundStatus"},"description":"Refund status."}]},"docs/ecom-v1-order-transactions.RefundStatus":{"name":"RefundStatus","fqn":"docs/ecom-v1-order-transactions.RefundStatus","slug":"refund-status","actions":[],"enumValues":["FAILED","PENDING","SCHEDULED","STARTED","SUCCEEDED"],"properties":[]},"docs/ecom-v1-order-transactions.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-order-transactions.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-orders-settings.OrdersSettingsUpdated":{"name":"OrdersSettingsUpdated","fqn":"docs/ecom-v1-orders-settings.OrdersSettingsUpdated","slug":"orders-settings-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrdersSettings","referenceFqn":"docs/ecom-v1-orders-settings.OrdersSettings"},"description":"Updated orders settings."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-orders-settings.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-orders-settings.OrdersSettings":{"name":"OrdersSettings","fqn":"docs/ecom-v1-orders-settings.OrdersSettings","slug":"orders-settings","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the orders settings were created."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the orders settings were updated."},{"name":"createInvoice","slug":"create-invoice","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether to automatically create invoices for every new order paid online.\n
\nDefault: `false`\n
\n**Note**: The issued invoice for an order is not a tax invoice and doesn't reflect refunds. You are responsible for ensuring that invoices you issue conform to any relevant legal requirements."},{"name":"inventoryUpdateTrigger","slug":"inventory-update-trigger","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"InventoryUpdateTrigger","referenceFqn":"docs/ecom-v1-orders-settings.InventoryUpdateTrigger"},"description":"Defines when to update the store inventory:\n\n- `ON_ORDER_PAID`: Stock quantities will update only after the payment is approved.\n- `ON_ORDER_PLACED`: Stock quantities will update while the payment is being processed. If the payment did not go through, items will restock.\n\nDefault: `ON_ORDER_PLACED`"}]},"docs/ecom-v1-orders-settings.InventoryUpdateTrigger":{"name":"InventoryUpdateTrigger","fqn":"docs/ecom-v1-orders-settings.InventoryUpdateTrigger","slug":"inventory-update-trigger","actions":[],"enumValues":["ON_ORDER_PAID","ON_ORDER_PLACED","UNKNOWN_INVENTORY_UPDATE_TRIGGER"],"properties":[]},"docs/ecom-v1-orders-settings.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-orders-settings.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-pickup-location.PickupLocationCreated":{"name":"PickupLocationCreated","fqn":"docs/ecom-v1-pickup-location.PickupLocationCreated","slug":"pickup-location-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupLocation","referenceFqn":"docs/ecom-v1-pickup-location.PickupLocation"},"description":"Created pickup location."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-pickup-location.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-pickup-location.PickupLocation":{"name":"PickupLocation","fqn":"docs/ecom-v1-pickup-location.PickupLocation","slug":"pickup-location","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Represents the time this PickupLocation was created"},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"PickupLocation ID"},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Represents the time this PickupLocation was last updated"},{"name":"active","slug":"active","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"inactive pickup locations should not be shown in checkout"},{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-pickup-location.Address"},"description":"Pickup Location Address"},{"name":"deliveryTime","slug":"delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Expected delivery time in free text. For example, `\"3-5 business days\"`."},{"name":"instructions","slug":"instructions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Instructions for carrier. For example, `\"Please knock on the door. If unanswered, please call contact number. Thanks.\"`."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Pickup Location Name"},{"name":"rates","slug":"rates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ConditionalRates","referenceFqn":"docs/ecom-v1-pickup-location.ConditionalRates"}},"description":"at runtime for a given pickup input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one."},{"name":"revision","slug":"revision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Represents the current state of an item. Each time the item is modified, its `revision` changes. for an update operation to succeed, you MUST pass the latest revision"},{"name":"shippingRuleId","slug":"shipping-rule-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ShippingRuleId from ecom"}]},"docs/ecom-v1-pickup-location.Address":{"name":"Address","fqn":"docs/ecom-v1-pickup-location.Address","slug":"address","actions":[],"oneofProperties":{"street":[{"name":"addressLine","slug":"address-line","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-pickup-location.StreetAddress"},"description":"Street name and number."}]},"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Country code."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Zip/postal code."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Subdivision. Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)."}]},"docs/ecom-v1-pickup-location.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-pickup-location.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"docs/ecom-v1-pickup-location.ConditionalRates":{"name":"ConditionalRates","fqn":"docs/ecom-v1-pickup-location.ConditionalRates","slug":"conditional-rates","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"conditions","slug":"conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Condition","referenceFqn":"docs/ecom-v1-pickup-location.Condition"}},"description":"there is an AND logic between all the conditions. Empty conditions means true.\nFor example: weight > 0 and weight <= 10"}]},"docs/ecom-v1-pickup-location.Condition":{"name":"Condition","fqn":"docs/ecom-v1-pickup-location.Condition","slug":"condition","actions":[],"properties":[{"name":"operator","slug":"operator","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LogicalOperator","referenceFqn":"docs/ecom-v1-pickup-location.LogicalOperator"}},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ConditionType","referenceFqn":"docs/ecom-v1-pickup-location.ConditionType"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value in respective to the condition type\nWeight values should be in the same weight units of the store: KG / LB\nTotal price is according to the store currency\nQuantity of items should be integers"}]},"docs/ecom-v1-pickup-location.LogicalOperator":{"name":"LogicalOperator","fqn":"docs/ecom-v1-pickup-location.LogicalOperator","slug":"logical-operator","actions":[],"enumValues":["EQ","GT","GTE","LT","LTE","UNKNOWN_LOGICAL_OPERATOR_TYPE"],"properties":[]},"docs/ecom-v1-pickup-location.ConditionType":{"name":"ConditionType","fqn":"docs/ecom-v1-pickup-location.ConditionType","slug":"condition-type","actions":[],"enumValues":["BY_TOTAL_PRICE","BY_TOTAL_QUANTITY","BY_TOTAL_WEIGHT","UNKNOWN_TYPE"],"properties":[]},"docs/ecom-v1-pickup-location.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-pickup-location.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-pickup-location.PickupLocationDeleted":{"name":"PickupLocationDeleted","fqn":"docs/ecom-v1-pickup-location.PickupLocationDeleted","slug":"pickup-location-deleted","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupLocation","referenceFqn":"docs/ecom-v1-pickup-location.PickupLocation"},"description":"Deleted pickup location."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-pickup-location.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-pickup-location.PickupLocationUpdated":{"name":"PickupLocationUpdated","fqn":"docs/ecom-v1-pickup-location.PickupLocationUpdated","slug":"pickup-location-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupLocation","referenceFqn":"docs/ecom-v1-pickup-location.PickupLocation"},"description":"Updated pickup location."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-pickup-location.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-shipping-option.ShippingOptionCreated":{"name":"ShippingOptionCreated","fqn":"docs/ecom-v1-shipping-option.ShippingOptionCreated","slug":"shipping-option-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingOption","referenceFqn":"docs/ecom-v1-shipping-option.ShippingOption"},"description":"Created shipping option."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-shipping-option.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-shipping-option.ShippingOption":{"name":"ShippingOption","fqn":"docs/ecom-v1-shipping-option.ShippingOption","slug":"shipping-option","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the ShippingOption was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ShippingOption ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the ShippingOption was last updated."},{"name":"deliveryRegionId","slug":"delivery-region-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Associated delivery region id."},{"name":"estimateDeliveryTime","slug":"estimate-delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-shipping-option.ExtendedFields"},"description":"Data Extensions"},{"name":"rates","slug":"rates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"ConditionalRates","referenceFqn":"docs/ecom-v1-shipping-option.ConditionalRates"}},"description":"at runtime for a given shipment input, up to one rate (price) should be returned in an option. If more than one rate is valid then we return the lowest one."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number, which increments by 1 each time the ShippingOption is updated.\nTo prevent conflicting changes,\nthe current revision must be passed when updating the ShippingOption.\n\nIgnored when creating a ShippingOption."},{"name":"title","slug":"title","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Delivery option configured for the ShippingOption"}]},"docs/ecom-v1-shipping-option.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-shipping-option.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-shipping-option.ConditionalRates":{"name":"ConditionalRates","fqn":"docs/ecom-v1-shipping-option.ConditionalRates","slug":"conditional-rates","actions":[],"properties":[{"name":"amount","slug":"amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"conditions","slug":"conditions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Condition","referenceFqn":"docs/ecom-v1-shipping-option.Condition"}},"description":"there is an AND logic between all the conditions. Empty conditions means true.\nFor example: weight > 0 and weight <= 10"}]},"docs/ecom-v1-shipping-option.Condition":{"name":"Condition","fqn":"docs/ecom-v1-shipping-option.Condition","slug":"condition","actions":[],"properties":[{"name":"operator","slug":"operator","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"LogicalOperator","referenceFqn":"docs/ecom-v1-shipping-option.LogicalOperator"}},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ConditionType","referenceFqn":"docs/ecom-v1-shipping-option.ConditionType"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The value in respective to the condition type\nWeight values should be in the same weight units of the store: KG / LB\nTotal price is according to the store currency\nQuantity of items should be integers"}]},"docs/ecom-v1-shipping-option.LogicalOperator":{"name":"LogicalOperator","fqn":"docs/ecom-v1-shipping-option.LogicalOperator","slug":"logical-operator","actions":[],"enumValues":["EQ","GT","GTE","LT","LTE","UNKNOWN_LOGICAL_OPERATOR_TYPE"],"properties":[]},"docs/ecom-v1-shipping-option.ConditionType":{"name":"ConditionType","fqn":"docs/ecom-v1-shipping-option.ConditionType","slug":"condition-type","actions":[],"enumValues":["BY_TOTAL_PRICE","BY_TOTAL_QUANTITY","BY_TOTAL_WEIGHT","UNKNOWN_TYPE"],"properties":[]},"docs/ecom-v1-shipping-option.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-shipping-option.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-shipping-option.ShippingOptionDeleted":{"name":"ShippingOptionDeleted","fqn":"docs/ecom-v1-shipping-option.ShippingOptionDeleted","slug":"shipping-option-deleted","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingOption","referenceFqn":"docs/ecom-v1-shipping-option.ShippingOption"},"description":"Deleted shipping option."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-shipping-option.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-shipping-option.ShippingOptionUpdated":{"name":"ShippingOptionUpdated","fqn":"docs/ecom-v1-shipping-option.ShippingOptionUpdated","slug":"shipping-option-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippingOption","referenceFqn":"docs/ecom-v1-shipping-option.ShippingOption"},"description":"Updated shipping option."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-shipping-option.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-shippo-configuration.ShippoConfigurationCreated":{"name":"ShippoConfigurationCreated","fqn":"docs/ecom-v1-shippo-configuration.ShippoConfigurationCreated","slug":"shippo-configuration-created","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippoConfiguration","referenceFqn":"docs/ecom-v1-shippo-configuration.ShippoConfiguration"},"description":"Created shippo configuration."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-shippo-configuration.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-shippo-configuration.ShippoConfiguration":{"name":"ShippoConfiguration","fqn":"docs/ecom-v1-shippo-configuration.ShippoConfiguration","slug":"shippo-configuration","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the ShippoConfiguration was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ShippoConfiguration ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the ShippoConfiguration was last updated."},{"name":"backupWeight","slug":"backup-weight","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Backup weight."},{"name":"deliveryRegionId","slug":"delivery-region-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Associated delivery region ID."},{"name":"domesticServices","slug":"domestic-services","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DomesticServiceSettings","referenceFqn":"docs/ecom-v1-shippo-configuration.DomesticServiceSettings"}},"description":"Settings of USPS domestic services."},{"name":"extendedFields","slug":"extended-fields","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ExtendedFields","referenceFqn":"docs/ecom-v1-shippo-configuration.ExtendedFields"},"description":"Data extensions."},{"name":"internationalServices","slug":"international-services","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"InternationalServiceSettings","referenceFqn":"docs/ecom-v1-shippo-configuration.InternationalServiceSettings"}},"description":"Settings of USPS international services."},{"name":"osLocationId","slug":"os-location-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Location ID from OS location service."},{"name":"packageDetails","slug":"package-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PackageDetails","referenceFqn":"docs/ecom-v1-shippo-configuration.PackageDetails"},"description":"Package details."},{"name":"packageType","slug":"package-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PackageType","referenceFqn":"docs/ecom-v1-shippo-configuration.PackageType"},"description":"Package type."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"shipFromAddress","slug":"ship-from-address","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Address","referenceFqn":"docs/ecom-v1-shippo-configuration.Address"},"description":"Ship from address materialized from OS location."}]},"docs/ecom-v1-shippo-configuration.DomesticServiceSettings":{"name":"DomesticServiceSettings","fqn":"docs/ecom-v1-shippo-configuration.DomesticServiceSettings","slug":"domestic-service-settings","actions":[],"properties":[{"name":"service","slug":"service","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DomesticService","referenceFqn":"docs/ecom-v1-shippo-configuration.DomesticService"},"description":"USPS domestic service."},{"name":"serviceSettings","slug":"service-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ServiceSettings","referenceFqn":"docs/ecom-v1-shippo-configuration.ServiceSettings"},"description":"Service settings."}]},"docs/ecom-v1-shippo-configuration.DomesticService":{"name":"DomesticService","fqn":"docs/ecom-v1-shippo-configuration.DomesticService","slug":"domestic-service","actions":[],"enumValues":["GROUND_ADVANTAGE","PRIORITY_MAIL","PRIORITY_MAIL_EXPRESS","UNKNOWN_DOMESTIC_SERVICE"],"properties":[]},"docs/ecom-v1-shippo-configuration.ServiceSettings":{"name":"ServiceSettings","fqn":"docs/ecom-v1-shippo-configuration.ServiceSettings","slug":"service-settings","actions":[],"properties":[{"name":"estimatedDeliveryTime","slug":"estimated-delivery-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Estimated delivery time."},{"name":"freeDeliveryMinimumAmount","slug":"free-delivery-minimum-amount","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Amount above which free delivery is offered."},{"name":"handlingFee","slug":"handling-fee","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"HandlingFee","referenceFqn":"docs/ecom-v1-shippo-configuration.HandlingFee"},"description":"Handling fee."}]},"docs/ecom-v1-shippo-configuration.HandlingFee":{"name":"HandlingFee","fqn":"docs/ecom-v1-shippo-configuration.HandlingFee","slug":"handling-fee","actions":[],"properties":[{"name":"calculationType","slug":"calculation-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CalculationType","referenceFqn":"docs/ecom-v1-shippo-configuration.CalculationType"},"description":"How to calculate the fee: fixed amount or by percentage."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Value that will be used to calculate the fee. For example, percentage fee with value 5% to calculate the fee."}]},"docs/ecom-v1-shippo-configuration.CalculationType":{"name":"CalculationType","fqn":"docs/ecom-v1-shippo-configuration.CalculationType","slug":"calculation-type","actions":[],"enumValues":["FIXED","PERCENTAGE","UNKNOWN_TYPE"],"properties":[]},"docs/ecom-v1-shippo-configuration.ExtendedFields":{"name":"ExtendedFields","fqn":"docs/ecom-v1-shippo-configuration.ExtendedFields","slug":"extended-fields","actions":[],"properties":[{"name":"namespaces","slug":"namespaces","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"RECORD","keyType":{"kind":"PRIMITIVE","name":"string"},"valueType":{"kind":"PRIMITIVE","name":"any"}}},"description":"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."}]},"docs/ecom-v1-shippo-configuration.InternationalServiceSettings":{"name":"InternationalServiceSettings","fqn":"docs/ecom-v1-shippo-configuration.InternationalServiceSettings","slug":"international-service-settings","actions":[],"properties":[{"name":"service","slug":"service","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"InternationalService","referenceFqn":"docs/ecom-v1-shippo-configuration.InternationalService"},"description":"USPS international service."},{"name":"serviceSettings","slug":"service-settings","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ServiceSettings","referenceFqn":"docs/ecom-v1-shippo-configuration.ServiceSettings"},"description":"Service settings."}]},"docs/ecom-v1-shippo-configuration.InternationalService":{"name":"InternationalService","fqn":"docs/ecom-v1-shippo-configuration.InternationalService","slug":"international-service","actions":[],"enumValues":["FIRST_CLASS_PACKAGE_INTERNATIONAL","PRIORITY_MAIL_EXPRESS_INTERNATIONAL","PRIORITY_MAIL_INTERNATIONAL","UNKNOWN_INTERNATIONAL_SERVICE"],"properties":[]},"docs/ecom-v1-shippo-configuration.PackageDetails":{"name":"PackageDetails","fqn":"docs/ecom-v1-shippo-configuration.PackageDetails","slug":"package-details","actions":[],"properties":[{"name":"dimensions","slug":"dimensions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PackageDimensions","referenceFqn":"docs/ecom-v1-shippo-configuration.PackageDimensions"},"description":"Package dimensions. Can only be set when package type is CUSTOM.\nFor other package types, it is read-only, and an exception will be thrown\nif it set when creating a ShippoConfiguration."},{"name":"maxNumberOfProducts","slug":"max-number-of-products","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Maximum number of products. Must be set when package type is NOT CUSTOM.\nOtherwise, if the package type is CUSTOM, this field cannot be set and an\nexception will be thrown if it is set when creating a ShippoConfiguration."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Package name. Must be set when package type is CUSTOM.\nFor other package types, it is read-only, and an exception will be thrown\nif it set when creating a ShippoConfiguration."}]},"docs/ecom-v1-shippo-configuration.PackageDimensions":{"name":"PackageDimensions","fqn":"docs/ecom-v1-shippo-configuration.PackageDimensions","slug":"package-dimensions","actions":[],"properties":[{"name":"height","slug":"height","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Package height."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Package length."},{"name":"width","slug":"width","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Package width."}]},"docs/ecom-v1-shippo-configuration.PackageType":{"name":"PackageType","fqn":"docs/ecom-v1-shippo-configuration.PackageType","slug":"package-type","actions":[],"enumValues":["CUSTOM","FLAT_RATE_ENVELOPE","LARGE_FLAT_RATE_BOX","MEDIUM_FLAT_RATE_BOX_1","MEDIUM_FLAT_RATE_BOX_2","PADDED_FLAT_RATE_ENVELOPE","SMALL_FLAT_RATE_BOX","UNKNOWN_PACKAGE_TYPE"],"properties":[]},"docs/ecom-v1-shippo-configuration.Address":{"name":"Address","fqn":"docs/ecom-v1-shippo-configuration.Address","slug":"address","actions":[],"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line (usually street name and number)."},{"name":"addressLine2","slug":"address-line2","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Free text providing more detailed address info. Usually contains apt, suite, floor."},{"name":"city","slug":"city","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"City name."},{"name":"country","slug":"country","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format."},{"name":"postalCode","slug":"postal-code","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Postal or zip code."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"docs/ecom-v1-shippo-configuration.StreetAddress"},"description":"Street address."},{"name":"subdivision","slug":"subdivision","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format."}]},"docs/ecom-v1-shippo-configuration.AddressLocation":{"name":"AddressLocation","fqn":"docs/ecom-v1-shippo-configuration.AddressLocation","slug":"address-location","actions":[],"properties":[{"name":"latitude","slug":"latitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address latitude."},{"name":"longitude","slug":"longitude","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Address longitude."}]},"docs/ecom-v1-shippo-configuration.StreetAddress":{"name":"StreetAddress","fqn":"docs/ecom-v1-shippo-configuration.StreetAddress","slug":"street-address","actions":[],"properties":[{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street name."},{"name":"number","slug":"number","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Street number."}]},"docs/ecom-v1-shippo-configuration.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecom-v1-shippo-configuration.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]},"docs/ecom-v1-shippo-configuration.ShippoConfigurationDeleted":{"name":"ShippoConfigurationDeleted","fqn":"docs/ecom-v1-shippo-configuration.ShippoConfigurationDeleted","slug":"shippo-configuration-deleted","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippoConfiguration","referenceFqn":"docs/ecom-v1-shippo-configuration.ShippoConfiguration"},"description":"Deleted shippo configuration."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-shippo-configuration.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecom-v1-shippo-configuration.ShippoConfigurationUpdated":{"name":"ShippoConfigurationUpdated","fqn":"docs/ecom-v1-shippo-configuration.ShippoConfigurationUpdated","slug":"shippo-configuration-updated","actions":[],"properties":[{"name":"entity","slug":"entity","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"ShippoConfiguration","referenceFqn":"docs/ecom-v1-shippo-configuration.ShippoConfiguration"},"description":"Updated shippo configuration."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecom-v1-shippo-configuration.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecommerce-gift-cards-proxy-v1-gift-card.GiftCardProviderWasProvisionedEvent":{"name":"GiftCardProviderWasProvisionedEvent","fqn":"docs/ecommerce-gift-cards-proxy-v1-gift-card.GiftCardProviderWasProvisionedEvent","slug":"gift-card-provider-was-provisioned-event","actions":[],"properties":[{"name":"data","slug":"data","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"GiftCardProviderWasProvisioned","referenceFqn":"docs/ecommerce-gift-cards-proxy-v1-gift-card.GiftCardProviderWasProvisioned"},"description":"Event data."},{"name":"metadata","slug":"metadata","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackendEventMetadata","referenceFqn":"docs/ecommerce-gift-cards-proxy-v1-gift-card.BackendEventMetadata"},"description":"Event metadata."}]},"docs/ecommerce-gift-cards-proxy-v1-gift-card.GiftCardProviderWasProvisioned":{"name":"GiftCardProviderWasProvisioned","fqn":"docs/ecommerce-gift-cards-proxy-v1-gift-card.GiftCardProviderWasProvisioned","slug":"gift-card-provider-was-provisioned","actions":[],"properties":[{"name":"providerAppDefId","slug":"provider-app-def-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The gift card provider which was installed"},{"name":"providerInstanceId","slug":"provider-instance-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}]},"docs/ecommerce-gift-cards-proxy-v1-gift-card.BackendEventMetadata":{"name":"BackendEventMetadata","fqn":"docs/ecommerce-gift-cards-proxy-v1-gift-card.BackendEventMetadata","slug":"backend-event-metadata","actions":[],"properties":[{"name":"entityId","slug":"entity-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the entity associated with the event."},{"name":"eventTime","slug":"event-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event timestamp."},{"name":"id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Event ID."},{"name":"triggeredByAnonymizeRequest","slug":"triggered-by-anonymize-request","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the event was triggered as a result of a privacy regulation application (for example, [GDPR](https://support.wix.com/en/article/gdpr-frequently-asked-questions)). For advanced users."}]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.ecom.v1.order"},"actions":[{"name":"onDiscountRuleCreated","fqn":"wixEcomDiscounts_onDiscountRuleCreated","slug":"on-discount-rule-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onDiscountRuleCreated example","content":"\n export function wixEcomDiscounts_onDiscountRuleCreated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleCreated","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountRuleCreated"},"description":"Information about the discount rule that was created."}],"description":"An event that is triggered when a discount rule is created.\n\nThe `onDiscountRuleCreated()` event handler runs when a discount rule is created. The `DiscountRuleCreated` object contains information about the discount rule that was created.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcomDiscounts_onDiscountRuleCreated"},{"name":"onDiscountRuleDeleted","fqn":"wixEcomDiscounts_onDiscountRuleDeleted","slug":"on-discount-rule-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onDiscountRuleDeleted example","content":"\n export function wixEcomDiscounts_onDiscountRuleDeleted(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleDeleted","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountRuleDeleted"},"description":"Information about the discount rule that was deleted."}],"description":"An event that is triggered when a discount rule is deleted.\n\nThe `onDiscountRuleDeleted()` event handler runs when a discount rule is deleted. The received `DiscountRuleDeleted` object contains event metadata.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcomDiscounts_onDiscountRuleDeleted"},{"name":"onDiscountRuleUpdated","fqn":"wixEcomDiscounts_onDiscountRuleUpdated","slug":"on-discount-rule-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onDiscountRuleUpdated example","content":"\n export function wixEcomDiscounts_onDiscountRuleUpdated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DiscountRuleUpdated","referenceFqn":"docs/ecom-discounts-v1-discount-rule.DiscountRuleUpdated"},"description":"Information about the discount rule that was updated."}],"description":"An event that is triggered when a discount rule is updated.\n\nThe `onDiscountRuleUpdated()` event handler runs when a discount rule is updated. The received `DiscountRuleUpdated` object contains information about the discount rule that was updated.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcomDiscounts_onDiscountRuleUpdated"},{"name":"onAbandonedCheckoutRecovered","fqn":"wixEcom_onAbandonedCheckoutRecovered","slug":"on-abandoned-checkout-recovered","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when an abandoned checkout is recovered ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onAbandonedCheckoutRecovered(event) {\n const abandonedCheckoutId = event.metadata.entityId;\n const buyerEmail = event.data.abandonedCheckout.buyerInfo.email;\n console.log('Abandoned checkout recovered', event);\n}\n\n/* Full event object:\n * {\n * \"entity\": {\n * \"_createdDate\": \"2021-10-12T00:18:03.045Z\",\n * \"_id\": \"bea905ef-d7cb-49b9-bce7-19342d3e7ab3\",\n * \"_updatedDate\": \"2022-06-17T00:18:03.046Z\",\n * \"activities\": [\n * {\n * \"createdDate\": \"2022-09-10T11:49:08.538Z\",\n * \"type\": \"SCHEDULED\"\n * },\n * {\n * \"createdDate\": \"2023-04-30T11:55:01.969Z\",\n * \"type\": \"EMAIL_SENT\"\n * }\n * ],\n * \"buyerInfo\": {\n * \"contactId\": \"77efeff1f-02c3-4a3b-bd7a-2cb4ab8e9a67\",\n * \"email\":\"mabel@go.com\",\n * \"visitorId\":\"ea24a72d-4084-4ecd-b36c-541c5d0a82c9\"\n * },\n * \"buyerLanguage\": \"en\",\n * \"cartId\": \"10cd2c69-20ea-48b8-a015-a943d295392a\",\n * \"checkoutId\": \"a778cd2c69-20ea-48b8-a015-b56912\",\n * \"checkoutRecoveredDate\": \"2023-12-30T11:55:01.969Z\"\n * \"checkoutUrl\": \"http://www.wixapis.com/ecom/v1/abandoned-checkout/7-9665-bb42bf3b8e86/redirect-to-checkout?metasiteId=548f24ea-a663fb0f-9e2e-f431506133\"\n * \"contactDetails\": {\n * \"firstName\": \"Mabel\",\n * \"lastName\": \"Goza\"\n * },\n * \"conversionCurrency\": \"EUR\",\n * \"currency\":\"EUR\",\n * \"totalPrice\": {\n * \"amount\": \"45\",\n * \"convertedAmount\": \"45\",\n * \"formattedAmount\": \"€45.00\",\n * \"formattedConvertedAmount\": \"€45.00\"\n * }\n * \"metadata\": {\n * \"entityId\": \"c434acce-84f8-4f67-9665-bb42bf448e86\",\n * \"eventTime\":\"2023-12-13T13:16:11.629738Z\",\n * \"id\": \"9b1a7beb-6beb-4591-8e3a-280b5972c548\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AbandonedCheckoutRecoveredEvent","referenceFqn":"docs/ecom-v1-abandoned-checkout.AbandonedCheckoutRecoveredEvent"},"description":"Information about the abandoned checkout that was recovered."}],"description":"An event that triggers when an abandoned checkout is recovered (the customer completes the checkout).\n\nThe `onAbandonedCheckoutCreated()` event handler runs when an abandoned checkout is recovered. The `AbandonedCheckoutRecoveredEvent` object contains information about the abandoned checkout that was recovered, and the event metadata.\n\n**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onAbandonedCheckoutRecovered"},{"name":"onBackInStockNotificationRequestCreated","fqn":"wixEcom_onBackInStockNotificationRequestCreated","slug":"on-back-in-stock-notification-request-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onBackInStockNotificationRequestCreated example","content":"\n export function wixEcom_onBackInStockNotificationRequestCreated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequestCreated","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestCreated"},"description":"Information about the back in stock notification request that was created."}],"description":"Triggered when a back in stock notification request is created.\n\n\nThe `onBackInStockNotificationRequestCreated()` event handler runs when a back in stock notification request is created. The received `BackInStockNotificationRequestCreated` object contains information about the back in stock notification request that was created and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onBackInStockNotificationRequestCreated"},{"name":"onBackInStockNotificationRequestDeleted","fqn":"wixEcom_onBackInStockNotificationRequestDeleted","slug":"on-back-in-stock-notification-request-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onBackInStockNotificationRequestDeleted example","content":"\n export function wixEcom_onBackInStockNotificationRequestDeleted(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequestDeleted","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestDeleted"},"description":"Information about the back in stock notification request that was deleted."}],"description":"Triggered when a back in stock notification request is deleted.\n\n\nThe `onBackInStockNotificationRequestDeleted()` event handler runs when a back in stock notification request is deleted. The received `BackInStockNotificationRequestDeleted` object contains event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onBackInStockNotificationRequestDeleted"},{"name":"onBackInStockNotificationRequestUpdated","fqn":"wixEcom_onBackInStockNotificationRequestUpdated","slug":"on-back-in-stock-notification-request-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onBackInStockNotificationRequestUpdated example","content":"\n export function wixEcom_onBackInStockNotificationRequestUpdated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BackInStockNotificationRequestUpdated","referenceFqn":"docs/ecom-v1-back-in-stock-notification-request.BackInStockNotificationRequestUpdated"},"description":"Information about the back in stock notification request that was updated."}],"description":"Triggered when a back in stock notification request is updated.\n\n\nThe `onBackInStockNotificationRequestUpdated()` event handler runs when a back in stock notification request is updated. The received `BackInStockNotificationRequestUpdated` object contains information about the back in stock notification request that was updated and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onBackInStockNotificationRequestUpdated"},{"name":"onCartCreated","fqn":"wixEcom_onCartCreated","slug":"on-cart-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a cart is created ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onCartCreated(event) {\n const cartSubtotal = event.entity.subtotal.amount;\n const cartId = event.entity._id;\n const eventId = event.metadata.id;\n console.log('Cart created', event)\n}\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"ba8e0c2e-dd90-4060-b83c-2590aa075b65\",\n * \"entityId\": \"1c68f377-4e8f-47c1-bc72-01b18a23cb08\",\n * \"eventTime\": \"2022-07-04T12:47:21.376865Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"1c68f377-4e8f-47c1-bc72-01b18a23cb08\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"quantity\": 3,\n * \"catalogReference\": {\n * \"catalogItemId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"variantId\": \"e62fee23-7878-437a-bf0e-292f17d11cb5\"\n * }\n * },\n * \"productName\": {\n * \"original\": \"Shoe\",\n * \"translated\": \"Shoe\"\n * },\n * \"url\": \"https://example.wixsite.com\",\n * \"price\": {\n * \"amount\": \"85\",\n * \"convertedAmount\": \"85\",\n * \"formattedAmount\": \"$85.00\",\n * \"formattedConvertedAmount\": \"$85.00\"\n * },\n * \"fullPrice\": {\n * \"amount\": \"85\",\n * \"convertedAmount\": \"85\",\n * \"formattedAmount\": \"$85.00\",\n * \"formattedConvertedAmount\": \"$85.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"85\",\n * \"convertedAmount\": \"85\",\n * \"formattedAmount\": \"$85.00\",\n * \"formattedConvertedAmount\": \"$85.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Color\",\n * \"translated\": \"Color\"\n * },\n * \"colorInfo\": {\n * \"original\": \"Black\",\n * \"translated\": \"Black\",\n * \"code\": \"#000\"\n * },\n * \"lineType\": \"UNRECOGNISED\"\n * }\n * ],\n * \"image\": \"wix:image://v1/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"availability\": {\n * \"status\": \"AVAILABLE\",\n * \"quantityAvailable\": 30\n * },\n * \"physicalProperties\": {\n * \"sku\": \"364215376135191\",\n * \"shippable\": true\n * },\n * \"couponScopes\": [\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"collection\",\n * \"entityId\": \"00000000-000000-000000-000000000001\"\n * }\n * },\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"product\",\n * \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\"\n * }\n * }\n * ],\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\"\n * }\n * ],\n * \"buyerInfo\": {\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"currency\": \"USD\",\n * \"conversionCurrency\": \"USD\",\n * \"buyerLanguage\": \"en\",\n * \"siteLanguage\": \"en\",\n * \"taxIncludedInPrices\": false,\n * \"weightUnit\": \"KG\",\n * \"subtotal\": {\n * \"amount\": \"255\",\n * \"convertedAmount\": \"255\",\n * \"formattedAmount\": \"$255.00\",\n * \"formattedConvertedAmount\": \"$255.00\"\n * },\n * \"appliedDiscounts\": [],\n * \"inSync\": false,\n * \"_createdDate\": \"2022-07-04T12:47:21.371Z\",\n * \"_updatedDate\": \"2022-07-04T12:47:21.371Z\"\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartCreated","referenceFqn":"docs/ecom-v1-cart.CartCreated"},"description":"Information about the cart that was created and event metadata."}],"description":"An event that triggers when a new cart is created.\n\n\nThe `onCartCreated()` event handler runs when a new cart is created. The received `CartCreated` object contains information about the cart that was created and event metadata.\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCartCreated"},{"name":"onCartDeleted","fqn":"wixEcom_onCartDeleted","slug":"on-cart-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a cart is deleted ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onCartDeleted(event) {\n const cartId = event.metadata.entityId;\n console.log('Cart deleted', event);\n}\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"c3500825-f582-4755-81b3-fa55b8585e5c\",\n * \"entityId\": \"19716650-fd62-4e3a-b98b-7e196d0e88a3\",\n * \"eventTime\": \"2022-07-28T08:36:02.227138Z\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartDeleted","referenceFqn":"docs/ecom-v1-cart.CartDeleted"},"description":"Event metadata."}],"description":"An event that triggers when a cart is deleted.\n\n\nThe onCartDeleted() event handler runs when a cart is deleted. The received `CartDeleted` object contains event metadata.\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCartDeleted"},{"name":"onCartUpdated","fqn":"wixEcom_onCartUpdated","slug":"on-cart-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a cart is updated ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onCartUpdated(event) {\n const cartSubtotal = event.entity.subtotal.amount;\n const cartId = event.entity._id;\n const eventId = event.metadata.id;\n console.log('Cart updated', event);\n}\n\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"e508b5f9-a7d2-4b37-94ce-2b7767cfa49c\",\n * \"entityId\": \"b79fd177-ec98-4245-b9f6-f09e7afa9d04\",\n * \"eventTime\": \"2022-10-27T11:42:17.211724Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"b79fd177-ec98-4245-b9f6-f09e7afa9d04\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"quantity\": 2,\n * \"catalogReference\": {\n * \"catalogItemId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"variantId\": \"e62fee23-7878-437a-bf0e-292f17d11cb5\"\n * }\n * },\n * \"productName\": {\n * \"original\": \"Shoe\",\n * \"translated\": \"Shoe\"\n * },\n * \"url\": \"https://example.wixsite.com\",\n * \"price\": {\n * \"amount\": \"85\",\n * \"convertedAmount\": \"85\",\n * \"formattedAmount\": \"$85.00\",\n * \"formattedConvertedAmount\": \"$85.00\"\n * },\n * \"fullPrice\": {\n * \"amount\": \"85\",\n * \"convertedAmount\": \"85\",\n * \"formattedAmount\": \"$85.00\",\n * \"formattedConvertedAmount\": \"$85.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"85\",\n * \"convertedAmount\": \"85\",\n * \"formattedAmount\": \"$85.00\",\n * \"formattedConvertedAmount\": \"$85.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Color\",\n * \"translated\": \"Color\"\n * },\n * \"colorInfo\": {\n * \"original\": \"Black\",\n * \"translated\": \"Black\",\n * \"code\": \"#000\"\n * },\n * \"lineType\": \"UNRECOGNISED\"\n * }\n * ],\n * \"image\": \"wix:image://v1/3c76e2_bf235c38610f4d2a905db71095b351cf~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"availability\": {\n * \"status\": \"AVAILABLE\",\n * \"quantityAvailable\": 30\n * },\n * \"physicalProperties\": {\n * \"sku\": \"364215376135191\",\n * \"shippable\": true\n * },\n * \"couponScopes\": [\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"collection\",\n * \"entityId\": \"00000000-000000-000000-000000000001\"\n * }\n * },\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"product\",\n * \"entityId\": \"df19c1f7-07d8-a265-42f8-e8dfa824cc6e\"\n * }\n * }\n * ],\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\"\n * },\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000002\",\n * \"quantity\": 3,\n * \"catalogReference\": {\n * \"catalogItemId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"variantId\": \"132b84e8-aab8-47a1-a1f6-2c47557b64a4\"\n * }\n * },\n * \"productName\": {\n * \"original\": \"Watch\",\n * \"translated\": \"Watch\"\n * },\n * \"url\": \"https://example.wixsite.com\",\n * \"price\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"fullPrice\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Size\",\n * \"translated\": \"Size\"\n * },\n * \"plainText\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * },\n * \"lineType\": \"UNRECOGNISED\"\n * },\n * {\n * \"name\": {\n * \"original\": \"Color\",\n * \"translated\": \"Color\"\n * },\n * \"colorInfo\": {\n * \"original\": \"Grey\",\n * \"translated\": \"Grey\",\n * \"code\": \"rgb(128, 128, 128)\"\n * },\n * \"lineType\": \"UNRECOGNISED\"\n * }\n * ],\n * \"image\": \"wix:image://v1/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"availability\": {\n * \"status\": \"AVAILABLE\"\n * },\n * \"physicalProperties\": {\n * \"sku\": \"217537123517253\",\n * \"shippable\": true\n * },\n * \"couponScopes\": [\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"collection\",\n * \"entityId\": \"00000000-000000-000000-000000000001\"\n * }\n * },\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"product\",\n * \"entityId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\"\n * }\n * }\n * ],\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\"\n * }\n * ],\n * \"buyerInfo\": {\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"currency\": \"USD\",\n * \"conversionCurrency\": \"USD\",\n * \"buyerLanguage\": \"en\",\n * \"siteLanguage\": \"en\",\n * \"taxIncludedInPrices\": false,\n * \"weightUnit\": \"KG\",\n * \"subtotal\": {\n * \"amount\": \"260\",\n * \"convertedAmount\": \"260\",\n * \"formattedAmount\": \"$260.00\",\n * \"formattedConvertedAmount\": \"$260.00\"\n * },\n * \"appliedDiscounts\": [],\n * \"inSync\": false,\n * \"_createdDate\": \"2022-06-22T11:32:29.601Z\",\n * \"_updatedDate\": \"2022-07-03T13:19:26.450Z\"\n * },\n * \"metadata\": {\n * \"id\": \"cac6f823-0ec7-4dd0-9147-48738c76134c\",\n * \"entityId\": \"b79fd177-ec98-4245-b9f6-f09e7afa9d04\",\n * \"eventTime\": \"2022-07-03T13:19:26.458843Z\",\n * \"triggeredByAnonymizeRequest\": false\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CartUpdated","referenceFqn":"docs/ecom-v1-cart.CartUpdated"},"description":"Information about the cart that was updated and event metadata."}],"description":"An event that triggers when a cart is updated.\n\n\nThe `onCartUpdated()` event handler runs when a cart is updated. The received `CartUpdated` object contains information about the cart that was updated and event metadata.\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCartUpdated"},{"name":"onCheckoutCompleted","fqn":"wixEcom_onCheckoutCompleted","slug":"on-checkout-completed","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a checkout is completed ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onCheckoutCompleted(event) {\n const checkoutSubtotal = event.entity.subtotal.amount;\n const checkoutId = event.entity._id;\n const checkoutComplete = event.entity.completed;\n const eventId = event.metadata.id;\n console.log('Checkout completed', event)\n}\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"d94b500b-3906-434f-bd90-92c521e4f0e3\",\n * \"entityId\": \"81b73bc6-d403-4afe-8464-226f9505b1c2\",\n * \"eventTime\": \"2022-10-27T11:58:12.667470Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"data\": {\n * \"checkout\": {\n * \"_id\": \"81b73bc6-d403-4afe-8464-226f9505b1c2\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"quantity\": 3,\n * \"catalogReference\": {\n * \"catalogItemId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n * },\n * \"productName\": {\n * \"original\": \"Shirt\",\n * \"translated\": \"Shirt\"\n * },\n * \"url\": \"https://example.wixsite.com\",\n * \"price\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"lineItemPrice\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"fullPrice\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"taxRate\": \"0\",\n * \"totalTax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"rateBreakdown\": []\n * },\n * \"discount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"descriptionLines\": [],\n * \"media\": \"wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"availability\": {\n * \"status\": \"AVAILABLE\"\n * },\n * \"physicalProperties\": {\n * \"sku\": \"364115376135191\",\n * \"shippable\": true\n * },\n * \"couponScopes\": [\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"collection\",\n * \"entityId\": \"00000000-000000-000000-000000000001\"\n * }\n * },\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"product\",\n * \"entityId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\"\n * }\n * }\n * ],\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"rootCatalogItemId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\"\n * }\n * ],\n * \"shippingInfo\": {\n * \"carrierServiceOptions\": []\n * },\n * \"buyerInfo\": {\n * \"contactId\": \"f7dc17a6-825a-466e-a78e-c4abea0217db\",\n * \"memberId\": \"c43190d2-eea3-493e-b6e8-f146850c6873\"\n * },\n * \"conversionCurrency\": \"USD\",\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"total\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"calculationErrors\": {\n * \"orderValidationErrors\": []\n * },\n * \"appliedDiscounts\": [\n * {\n * \"discountType\": \"GLOBAL\",\n * \"lineItemIds\": [],\n * \"coupon\": {\n * \"_id\": \"fbb94b06-7447-4161-9c48-59bfcdc39e77\",\n * \"code\": \"SUMMERSALE10\",\n * \"amount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"name\": \"SUMMERSALE10\",\n * \"couponType\": \"MoneyOff\"\n * }\n * }\n * ],\n * \"customFields\": [],\n * \"weightUnit\": \"KG\",\n * \"currency\": \"USD\",\n * \"channelType\": \"WEB\",\n * \"siteLanguage\": \"en\",\n * \"buyerLanguage\": \"en\",\n * \"completed\": true,\n * \"taxIncludedInPrice\": false,\n * \"createdBy\": {\n * \"memberId\": \"c43190d2-eea3-493e-b6e8-f146850c6873\"\n * },\n * \"_createdDate\": \"2022-10-27T11:42:17.059Z\",\n * \"_updatedDate\": \"2022-10-27T11:58:12.657Z\",\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"total\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"payLater\": {\n * \"subtotal\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"total\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"membershipOptions\": {\n * \"eligibleMemberships\": [],\n * \"invalidMemberships\": [],\n * \"selectedMemberships\": {\n * \"memberships\": []\n * }\n * },\n * \"additionalFees\": []\n * }\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutCompleted","referenceFqn":"docs/ecom-v1-checkout.CheckoutCompleted"},"description":"Information about the checkout that was completed and event metadata."}],"description":"An event that triggers when a checkout is completed. This happens either when an order is created from a checkout, or after using [`markCheckoutAsCompleted()`](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/markcheckoutascompleted).\n\n\nThe `onCheckoutCompleted()` event handler runs when a checkout is completed. The received `CheckoutCompleted` object contains information about the checkout that was completed and event metadata.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutCompleted"},{"name":"onCheckoutCreated","fqn":"wixEcom_onCheckoutCreated","slug":"on-checkout-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a checkout is created ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onCheckoutCreated(event) {\n const checkoutSubtotal = event.entity.subtotal.amount;\n const checkoutId = event.entity._id;\n const eventId = event.metadata.id;\n console.log('Checkout created', event)\n}\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"10fca682-f0e5-4392-9f1e-ba26a28ec077\",\n * \"entityId\": \"0939cbe9-72eb-47ad-bcbc-7c1ff0e0c9da\",\n * \"eventTime\": \"2022-10-27T11:25:35.848718Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"0939cbe9-72eb-47ad-bcbc-7c1ff0e0c9da\",\n * \"_createdDate\": \"2022-10-27T11:25:35.840Z\",\n * \"_updatedDate\": \"2022-10-27T11:25:35.840Z\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"quantity\": 3,\n * \"catalogReference\": {\n * \"catalogItemId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n * },\n * \"productName\": {\n * \"original\": \"Shirt\",\n * \"translated\": \"Shirt\"\n * },\n * \"url\": \"https://example.wixsite.com\",\n * \"price\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"lineItemPrice\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"fullPrice\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"taxRate\": \"0\",\n * \"totalTax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"rateBreakdown\": []\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"descriptionLines\": [],\n * \"media\": \"wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"availability\": {\n * \"status\": \"AVAILABLE\"\n * },\n * \"physicalProperties\": {\n * \"sku\": \"364115376135191\",\n * \"shippable\": true\n * },\n * \"couponScopes\": [\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"collection\",\n * \"entityId\": \"00000000-000000-000000-000000000001\"\n * }\n * },\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"product\",\n * \"entityId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\"\n * }\n * }\n * ],\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"rootCatalogItemId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\"\n * }\n * ],\n * \"shippingInfo\": {\n * \"carrierServiceOptions\": []\n * },\n * \"buyerInfo\": {\n * \"memberId\": \"c43190d2-eea3-493e-b6e8-f146850c6873\"\n * },\n * \"conversionCurrency\": \"USD\",\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"total\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"calculationErrors\": {\n * \"orderValidationErrors\": []\n * },\n * \"appliedDiscounts\": [],\n * \"customFields\": [],\n * \"weightUnit\": \"KG\",\n * \"currency\": \"USD\",\n * \"channelType\": \"WEB\",\n * \"siteLanguage\": \"en\",\n * \"buyerLanguage\": \"en\",\n * \"completed\": false,\n * \"taxIncludedInPrice\": false,\n * \"createdBy\": {\n * \"memberId\": \"c43190d2-eea3-493e-b6e8-f146850c6873\"\n * },\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"total\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"payLater\": {\n * \"subtotal\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"total\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"membershipOptions\": {\n * \"eligibleMemberships\": [],\n * \"invalidMemberships\": [],\n * \"selectedMemberships\": {\n * \"memberships\": []\n * }\n * },\n * \"additionalFees\": []\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutCreated","referenceFqn":"docs/ecom-v1-checkout.CheckoutCreated"},"description":"Information about the checkout that was created and event metadata."}],"description":"An event that triggers when a new checkout is created. For example, when a [checkout is created from a cart](https://www.wix.com/velo/reference/wix-ecom-backend/cart/createcheckout) or after using [`createCheckout()`](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/createcheckout).\n\n\nThe `onCheckoutCreated()` event handler runs when a new checkout is created. The received `CheckoutCreated` object contains information about the checkout that was created and event metadata.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutCreated"},{"name":"onCheckoutUpdated","fqn":"wixEcom_onCheckoutUpdated","slug":"on-checkout-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when a checkout is updated ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onCheckoutUpdated(event) {\n const checkoutSubtotal = event.entity.subtotal.amount;\n const checkoutId = event.entity._id;\n const eventId = event.metadata.id;\n console.log('Checkout updated', event)\n}\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"e508b5f9-a7d2-4b37-94ce-2b7767cfa49c\",\n * \"entityId\": \"81b73bc6-d403-4afe-8464-226f9505b1c2\",\n * \"eventTime\": \"2022-10-27T11:42:17.211724Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"81b73bc6-d403-4afe-8464-226f9505b1c2\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"quantity\": 3,\n * \"catalogReference\": {\n * \"catalogItemId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\"\n * },\n * \"productName\": {\n * \"original\": \"Shirt\",\n * \"translated\": \"Shirt\"\n * },\n * \"url\": \"https://example.wixsite.com\",\n * \"price\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"lineItemPrice\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"fullPrice\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"taxRate\": \"0\",\n * \"totalTax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"rateBreakdown\": []\n * },\n * \"discount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"descriptionLines\": [],\n * \"media\": \"wix:image://v1/3c76e2_c5331f937348492a97df87b0a3b34ea4~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"availability\": {\n * \"status\": \"AVAILABLE\"\n * },\n * \"physicalProperties\": {\n * \"sku\": \"364115376135191\",\n * \"shippable\": true\n * },\n * \"couponScopes\": [\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"collection\",\n * \"entityId\": \"00000000-000000-000000-000000000001\"\n * }\n * },\n * {\n * \"namespace\": \"stores\",\n * \"group\": {\n * \"name\": \"product\",\n * \"entityId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\"\n * }\n * }\n * ],\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"rootCatalogItemId\": \"c8539b66-7a44-fe18-affc-afec4be8562a\"\n * }\n * ],\n * \"shippingInfo\": {\n * \"carrierServiceOptions\": []\n * },\n * \"buyerInfo\": {\n * \"contactId\": \"f7dc17a6-825a-466e-a78e-c4abea0217db\",\n * \"memberId\": \"c43190d2-eea3-493e-b6e8-f146850c6873\"\n * },\n * \"conversionCurrency\": \"USD\",\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"total\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"calculationErrors\": {\n * \"orderValidationErrors\": []\n * },\n * \"appliedDiscounts\": [\n * {\n * \"discountType\": \"GLOBAL\",\n * \"lineItemIds\": [],\n * \"coupon\": {\n * \"_id\": \"fbb94b06-7447-4161-9c48-59bfcdc39e77\",\n * \"code\": \"SUMMERSALE10\",\n * \"amount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"name\": \"SUMMERSALE10\",\n * \"couponType\": \"MoneyOff\"\n * }\n * }\n * ],\n * \"customFields\": [],\n * \"weightUnit\": \"KG\",\n * \"currency\": \"USD\",\n * \"channelType\": \"WEB\",\n * \"siteLanguage\": \"en\",\n * \"buyerLanguage\": \"en\",\n * \"completed\": false,\n * \"taxIncludedInPrice\": false,\n * \"createdBy\": {\n * \"memberId\": \"c43190d2-eea3-493e-b6e8-f146850c6873\"\n * },\n * \"_createdDate\": \"2022-10-27T11:42:17.059Z\",\n * \"_updatedDate\": \"2022-10-27T11:42:17.201Z\",\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"30\",\n * \"convertedAmount\": \"30\",\n * \"formattedAmount\": \"$30.00\",\n * \"formattedConvertedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"10\",\n * \"convertedAmount\": \"10\",\n * \"formattedAmount\": \"$10.00\",\n * \"formattedConvertedAmount\": \"$10.00\"\n * },\n * \"total\": {\n * \"amount\": \"20\",\n * \"convertedAmount\": \"20\",\n * \"formattedAmount\": \"$20.00\",\n * \"formattedConvertedAmount\": \"$20.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"payLater\": {\n * \"subtotal\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"total\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * },\n * \"additionalFees\": {\n * \"amount\": \"0\",\n * \"convertedAmount\": \"0\",\n * \"formattedAmount\": \"$0.00\",\n * \"formattedConvertedAmount\": \"$0.00\"\n * }\n * },\n * \"membershipOptions\": {\n * \"eligibleMemberships\": [],\n * \"invalidMemberships\": [],\n * \"selectedMemberships\": {\n * \"memberships\": []\n * }\n * },\n * \"additionalFees\": []\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutUpdated","referenceFqn":"docs/ecom-v1-checkout.CheckoutUpdated"},"description":"Information about the checkout that was updated and event metadata."}],"description":"An event that triggers when a checkout is updated. A checkout is updated when, for example, [items are added](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/addtocheckout?branch=autodocs-wix-ecom-backend) or a [coupon is removed](https://www.wix.com/velo/reference/wix-ecom-backend/checkout/removecoupon).\n\n\nThe `onCheckoutUpdated()` event handler runs when a new checkout is updated. The received `CheckoutUpdated` object contains information about the checkout that was updated and event metadata.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutUpdated"},{"name":"onCheckoutSettingsUpdated","fqn":"wixEcom_onCheckoutSettingsUpdated","slug":"on-checkout-settings-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onCheckoutSettingsUpdated example","content":"\n export function wixEcom_onCheckoutSettingsUpdated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutSettingsUpdated","referenceFqn":"docs/ecom-v1-checkout-settings.CheckoutSettingsUpdated"},"description":"Information about the checkout settings that were updated and event metadata."}],"description":"Triggered when checkout settings are updated.\n\n\nThe `onCheckoutSettingsUpdated()` event handler runs when checkout settings are updated. The received `CheckoutSettingsUpdated` object contains information about the checkout settings that were updated and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutSettingsUpdated"},{"name":"onCheckoutTemplateCreated","fqn":"wixEcom_onCheckoutTemplateCreated","slug":"on-checkout-template-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onCheckoutTemplateCreated example","content":"\n export function wixEcom_onCheckoutTemplateCreated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplateCreated","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplateCreated"},"description":"Information about the checkout template that was created and event metadata."}],"description":"Triggered when a checkout template is created.\n\n\nThe `onCheckoutTemplateCreated()` event handler runs when a checkout template is created. The received `CheckoutTemplateCreated` object contains information about the checkout template that was created and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutTemplateCreated"},{"name":"onCheckoutTemplateDeleted","fqn":"wixEcom_onCheckoutTemplateDeleted","slug":"on-checkout-template-deleted","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onCheckoutTemplateDeleted example","content":"\n export function wixEcom_onCheckoutTemplateDeleted(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplateDeleted","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplateDeleted"},"description":"Information about the checkout template that was deleted and event metadata."}],"description":"Triggered when a checkout template is deleted.\n\n\nThe `onCheckoutTemplateDeleted()` event handler runs when a checkout template is deleted. The received `CheckoutTemplateDeleted` object contains information about the checkout template that was deleted and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutTemplateDeleted"},{"name":"onCheckoutTemplateUpdated","fqn":"wixEcom_onCheckoutTemplateUpdated","slug":"on-checkout-template-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onCheckoutTemplateUpdated example","content":"\n export function wixEcom_onCheckoutTemplateUpdated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplateUpdated","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplateUpdated"},"description":"Information about the checkout template that was updated and event metadata."}],"description":"Triggered when a checkout template is updated.\n\n\nThe `onCheckoutTemplateUpdated()` event handler runs when a checkout template is updated. The received `CheckoutTemplateUpdated` object contains information about the checkout template that was updated and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutTemplateUpdated"},{"name":"onCheckoutTemplateUsed","fqn":"wixEcom_onCheckoutTemplateUsed","slug":"on-checkout-template-used","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onCheckoutTemplateUsed example","content":"\n export function wixEcom_onCheckoutTemplateUsed(event) {\n const eventId = event.metadata.id\n const entityId = event.data.checkoutTemplate._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CheckoutTemplateUsedEvent","referenceFqn":"docs/ecom-v1-checkout-template.CheckoutTemplateUsedEvent"},"description":"Information about the checkout template that was used to create a checkout and event metadata."}],"description":"Triggered when a checkout template is used to create a checkout.\n\n\nThe `onCheckoutTemplateUsed()` event handler runs when a checkout template is created. The received `CheckoutTemplateUsedEvent` object contains information about the checkout template that was used, the checkout that was created, and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onCheckoutTemplateUsed"},{"name":"onFulfillmentsUpdated","fqn":"wixEcom_onFulfillmentsUpdated","slug":"on-fulfillments-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when an order fulfillment is updated ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onFulfillmentsUpdated(event) {\n const orderId = event.entity.orderId;\n const fulfillmentId = event.entity.fulfillments[0]._id;\n const eventId = event.metadata.id;\n console.log('Fulfillment updated', event)\n}\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"aa6bf186-a19f-4085-8726-11fde6b629f7\",\n * \"entityId\": \"a6c3a817-579d-4cb5-8521-2fe53b2c4bf1\",\n * \"eventTime\": \"2023-03-08T11:04:15.512044Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"orderId\": \"a6c3a817-579d-4cb5-8521-2fe53b2c4bf1\",\n * \"fulfillments\": [\n * {\n * \"_id\": \"a838877d-3f13-49f3-ab29-1cde478e0949\",\n * \"_createdDate\": \"2023-03-07T14:30:21.535Z\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"quantity\": 1\n * }\n * ],\n * \"trackingInfo\": {\n * \"trackingNumber\": \"12345\",\n * \"shippingProvider\": \"usps\",\n * \"trackingLink\": \"https://tools.usps.com/go/TrackConfirmAction.action?tLabels=12345\"\n * }\n * }\n * ]\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentsUpdated","referenceFqn":"docs/ecom-v1-fulfillments.FulfillmentsUpdated"},"description":"Information about the fulfillments that were updated."}],"description":"An event that triggers when one or more of an order's fulfillments are created, updated, or deleted.\n\n\nThe `onFulfillmentsUpdated()` event handler runs when a fulfillment is updated. The received object contains information about the fulfillment that was updated and event metadata.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onFulfillmentsUpdated"},{"name":"onOrderApproved","fqn":"wixEcom_onOrderApproved","slug":"on-order-approved","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when an order is approved ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onOrderApproved(event) {\n const orderId = event.data.order._id;\n const orderTotalPrice = event.data.order.priceSummary.totalPrice.amount;\n const eventId = event.metadata.id;\n console.log('Order approved', event)\n}\n\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"8f0a09a4-1fd1-4ff2-976a-21f1b2e0fe2f\",\n * \"entityId\": \"67668940-527d-4465-94c6-5475d8c7a412\",\n * \"eventTime\": \"2022-07-31T13:42:20.141721Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"data\": {\n * \"order\": {\n * \"_id\": \"67668940-527d-4465-94c6-5475d8c7a412\",\n * \"number\": \"10124\",\n * \"_createdDate\": \"2022-07-31T13:42:13.136Z\",\n * \"_updatedDate\": \"2022-07-31T13:42:20.026Z\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"productName\": {\n * \"original\": \"Brazilian Arabica\",\n * \"translated\": \"Brazilian Arabica\"\n * },\n * \"catalogReference\": {\n * \"catalogItemId\": \"0614129c-8777-9f3b-4dfe-b80a54df10d5\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"options\": {\n * \"Weight\": \"500g\",\n * \"Ground for\": \"Stovetop\"\n * },\n * \"variantId\": \"00000000-0000-003f-0005-a316f7c67df7\",\n * \"customTextFields\": {\n * \"What would you like written on the custom label?\": \"Enjoy our finest coffee.\"\n * }\n * }\n * },\n * \"quantity\": 1,\n * \"totalDiscount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Weight\",\n * \"translated\": \"Weight\"\n * },\n * \"plainText\": {\n * \"original\": \"500g\",\n * \"translated\": \"500g\"\n * },\n * \"lineType\": \"PLAIN_TEXT\",\n * \"plainTextValue\": {\n * \"original\": \"500g\",\n * \"translated\": \"500g\"\n * }\n * },\n * {\n * \"name\": {\n * \"original\": \"Ground for\",\n * \"translated\": \"Ground for\"\n * },\n * \"plainText\": {\n * \"original\": \"Stovetop\",\n * \"translated\": \"Stovetop\"\n * },\n * \"lineType\": \"PLAIN_TEXT\",\n * \"plainTextValue\": {\n * \"original\": \"Stovetop\",\n * \"translated\": \"Stovetop\"\n * }\n * },\n * {\n * \"name\": {\n * \"original\": \"What would you like written on the custom label?\",\n * \"translated\": \"What would you like written on the custom label?\"\n * },\n * \"plainText\": {\n * \"original\": \"Enjoy our finest coffee.\",\n * \"translated\": \"Enjoy our finest coffee.\"\n * },\n * \"lineType\": \"PLAIN_TEXT\",\n * \"plainTextValue\": {\n * \"original\": \"Enjoy our finest coffee.\",\n * \"translated\": \"Enjoy our finest coffee.\"\n * }\n * }\n * ],\n * \"image\": \"wix:image://v1/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg#originWidth=4517&originHeight=2992\",\n * \"physicalProperties\": {\n * \"weight\": 0.5,\n * \"shippable\": true\n * },\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"fulfillerId\": \"85e29287-a5bf-4c25-b303-a2ddc9d975e2\",\n * \"refundQuantity\": 0,\n * \"price\": {\n * \"amount\": \"48.75\",\n * \"formattedAmount\": \"$48.75\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"48.75\",\n * \"formattedAmount\": \"$48.75\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"48.75\",\n * \"formattedAmount\": \"$48.75\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"50.70\",\n * \"formattedAmount\": \"$50.70\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"48.75\",\n * \"formattedAmount\": \"$48.75\"\n * },\n * \"taxRate\": \"0.04\",\n * \"totalTax\": {\n * \"amount\": \"1.95\",\n * \"formattedAmount\": \"$1.95\"\n * }\n * }\n * }\n * ],\n * \"buyerInfo\": {\n * \"contactId\": \"f61f30cd-7474-47b7-95a2-339c0fcacbd3\",\n * \"email\": \"janedoe@gmail.com\",\n * \"visitorId\": \"b52ec002-40dd-469c-9f9f-833988e8048d\"\n * },\n * \"paymentStatus\": \"PAID\",\n * \"fulfillmentStatus\": \"NOT_FULFILLED\",\n * \"buyerLanguage\": \"en\",\n * \"weightUnit\": \"LB\",\n * \"currency\": \"USD\",\n * \"taxIncludedInPrices\": false,\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"48.75\",\n * \"formattedAmount\": \"$48.75\"\n * },\n * \"shipping\": {\n * \"amount\": \"5.0\",\n * \"formattedAmount\": \"$5.00\"\n * },\n * \"tax\": {\n * \"amount\": \"1.95\",\n * \"formattedAmount\": \"$1.95\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"55.70\",\n * \"formattedAmount\": \"$55.70\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"55.70\",\n * \"formattedAmount\": \"$55.70\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"55.70\",\n * \"formattedAmount\": \"$55.70\"\n * }\n * },\n * \"billingInfo\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * },\n * \"shippingInfo\": {\n * \"carrierId\": \"c8a08776-c095-4dec-8553-8f9698d86adc\",\n * \"code\": \"a0fde0a4-6f4e-3716-64be-c0acbde1696a\",\n * \"title\": \"U.S Shipping\",\n * \"logistics\": {\n * \"deliveryTime\": \"3 - 5 business days\",\n * \"shippingDestination\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * }\n * },\n * \"cost\": {\n * \"price\": {\n * \"amount\": \"5\",\n * \"formattedAmount\": \"$5.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"5\",\n * \"formattedAmount\": \"$5.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"5.0\",\n * \"formattedAmount\": \"$5.00\"\n * },\n * \"taxDetails\": {\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"region\": {\n * \"name\": \"Region 3\"\n * }\n * },\n * \"buyerNote\": \"This is a buyerNote\",\n * \"status\": \"APPROVED\",\n * \"archived\": false,\n * \"taxSummary\": {\n * \"totalTax\": {\n * \"amount\": \"1.95\",\n * \"formattedAmount\": \"$1.95\"\n * },\n * \"manualTaxRate\": \"0.04\"\n * },\n * \"appliedDiscounts\": [],\n * \"activities\": [\n * {\n * \"_createdDate\": \"2022-07-31T13:42:13.136Z\",\n * \"type\": \"ORDER_PLACED\"\n * }\n * ],\n * \"attributionSource\": \"UNSPECIFIED\",\n * \"createdBy\": {\n * \"visitorId\": \"b52ec002-40dd-469c-9f9f-833988e8048d\"\n * },\n * \"channelInfo\": {\n * \"type\": \"WEB\"\n * },\n * \"seenByAHuman\": false,\n * \"checkoutId\": \"62d01935-e0d3-4063-9e78-da099462e90c\",\n * \"customFields\": [],\n * \"cartId\": \"52fec024-4379-4a96-9237-9660030be6fe\",\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"48.75\",\n * \"formattedAmount\": \"$48.75\"\n * },\n * \"shipping\": {\n * \"amount\": \"5.0\",\n * \"formattedAmount\": \"$5.00\"\n * },\n * \"tax\": {\n * \"amount\": \"1.95\",\n * \"formattedAmount\": \"$1.95\"\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"55.70\",\n * \"formattedAmount\": \"$55.70\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"55.70\",\n * \"formattedAmount\": \"$55.70\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"55.70\",\n * \"formattedAmount\": \"$55.70\"\n * }\n * },\n * \"balanceSummary\": {\n * \"balance\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * }\n * }\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderApprovedEvent","referenceFqn":"docs/ecom-v1-order.OrderApprovedEvent"},"description":"Information about the order that was approved and metadata for the event."}],"description":"An event that triggers when an order is approved.\n\n\nThe `onOrderApproved()` event handler runs when an order is created and its status is updated to `\"APPROVED\"`. The received `OrderApprovedEvent` object contains information about the order that was approved and event metadata.\n\n> **Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrderApproved"},{"name":"onOrderCanceled","fqn":"wixEcom_onOrderCanceled","slug":"on-order-canceled","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when an order is canceled ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onOrderCanceled(event) {\n const orderId = event.data.order._id;\n const orderStatus = event.data.order.status;\n const restockAllItems = event.data.restockAllItems;\n const eventId = event.metadata.id;\n console.log('Order canceled', event)\n}\n\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"a9a15029-aee6-4a74-9744-6a0ee5cc7258\",\n * \"entityId\": \"7a8b195e-ab73-4138-b9da-cdf5e864a451\",\n * \"eventTime\": \"2023-01-16T14:44:37.686245Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"data\": {\n * \"order\": {\n * \"_id\": \"7a8b195e-ab73-4138-b9da-cdf5e864a451\",\n * \"number\": \"10003\",\n * \"_createdDate\": \"2023-01-16T13:53:10.776Z\",\n * \"_updatedDate\": \"2023-01-16T14:44:37.554Z\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"productName\": {\n * \"original\": \"Watch\",\n * \"translated\": \"Watch\"\n * },\n * \"catalogReference\": {\n * \"catalogItemId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"options\": {\n * \"Size\": \"Medium\",\n * \"Color\": \"Black\"\n * },\n * \"variantId\": \"e309b2f2-2166-4927-a137-0e5dfb870627\"\n * }\n * },\n * \"quantity\": 1,\n * \"totalDiscount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Size\",\n * \"translated\": \"Size\"\n * },\n * \"plainText\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * },\n * \"lineType\": \"PLAIN_TEXT\",\n * \"plainTextValue\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * }\n * },\n * {\n * \"name\": {\n * \"original\": \"Color\",\n * \"translated\": \"Color\"\n * },\n * \"colorInfo\": {\n * \"original\": \"Black\",\n * \"translated\": \"Black\"\n * },\n * \"lineType\": \"COLOR\",\n * \"color\": \"Black\"\n * }\n * ],\n * \"image\": \"wix:image://v1/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"physicalProperties\": {\n * \"sku\": \"217537123517253\",\n * \"shippable\": true\n * },\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"refundQuantity\": 0,\n * \"restockQuantity\": 1,\n * \"price\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * }\n * }\n * ],\n * \"buyerInfo\": {\n * \"contactId\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n * \"email\": \"janedoe8@gmail.com\",\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"paymentStatus\": \"FULLY_REFUNDED\",\n * \"fulfillmentStatus\": \"NOT_FULFILLED\",\n * \"buyerLanguage\": \"en\",\n * \"weightUnit\": \"KG\",\n * \"currency\": \"USD\",\n * \"taxIncludedInPrices\": false,\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"total\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalAdditionalFees\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"billingInfo\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * },\n * \"shippingInfo\": {\n * \"carrierId\": \"c8a08776-c095-4dec-8553-8f9698d86adc\",\n * \"code\": \"ed5bbce2-9533-dff4-7db0-13702fd139c5\",\n * \"title\": \"Standard US Shipping\",\n * \"logistics\": {\n * \"deliveryTime\": \"\",\n * \"shippingDestination\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * }\n * },\n * \"cost\": {\n * \"price\": {\n * \"amount\": \"10\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"10\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"taxDetails\": {\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"region\": {\n * \"name\": \"USA shipping\"\n * }\n * },\n * \"status\": \"CANCELED\",\n * \"archived\": false,\n * \"taxSummary\": {\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"appliedDiscounts\": [],\n * \"activities\": [\n * {\n * \"_createdDate\": \"2023-01-16T13:53:10.776Z\",\n * \"type\": \"ORDER_PLACED\"\n * },\n * {\n * \"_createdDate\": \"2023-01-16T14:38:48.249Z\",\n * \"type\": \"EMAIL_EDITED\"\n * },\n * {\n * \"_createdDate\": \"2023-01-16T14:40:02.184Z\",\n * \"type\": \"ORDER_PAID\"\n * },\n * {\n * \"_createdDate\": \"2023-01-16T14:44:36.766Z\",\n * \"orderRefunded\": {\n * \"manual\": true,\n * \"amount\": {\n * \"amount\": \"40\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"reason\": \"\"\n * },\n * \"type\": \"ORDER_REFUNDED\"\n * },\n * {\n * \"_createdDate\": \"2023-01-16T14:44:37.554Z\",\n * \"type\": \"ORDER_CANCELED\"\n * }\n * ],\n * \"attributionSource\": \"UNSPECIFIED\",\n * \"createdBy\": {\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"channelInfo\": {\n * \"type\": \"WEB\"\n * },\n * \"seenByAHuman\": true,\n * \"checkoutId\": \"9f24eba1-5b05-4c9e-90c5-1789a8239912\",\n * \"customFields\": [],\n * \"cartId\": \"eb8086a0-9389-4e92-91cb-5ce7bd9b3db8\",\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"total\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * }\n * },\n * \"balanceSummary\": {\n * \"balance\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * }\n * },\n * \"additionalFees\": []\n * },\n * \"restockAllItems\": true,\n * \"sendOrderCanceledEmail\": false\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderCanceled","referenceFqn":"docs/ecom-v1-order.OrderCanceled"},"description":"Information about the order that was canceled."}],"description":"Triggered when an order is canceled.\n\n\nThe `onOrderCanceled()` event handler runs when an order is canceled. The received `OrderCanceled` object contains information about the order that was canceled, details related to the cancelation, and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrderCanceled"},{"name":"onOrderCreated","fqn":"wixEcom_onOrderCreated","slug":"on-order-created","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onOrderCreated example","content":"\n export function wixEcom_onOrderCreated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderCreated","referenceFqn":"docs/ecom-v1-order.OrderCreated"},"description":"Information about the order that was created."}],"description":"Triggered when an order is created.\n\n\nThe `onOrderCreated()` event handler runs when an order is created. The received `OrderCreated` object contains information about the order that was created and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrderCreated"},{"name":"onOrderPaymentStatusUpdated","fqn":"wixEcom_onOrderPaymentStatusUpdated","slug":"on-order-payment-status-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when an order's payment status is updated ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onOrderPaymentStatusUpdated(event) {\n const orderId = event.data.order._id;\n const currentPaymentStatus = event.data.order.paymentStatus;\n const previousPaymentStatus = event.data.previousPaymentStatus;\n const orderTotalPrice = event.data.order.priceSummary.totalPrice.amount;\n const eventId = event.metadata.id;\n console.log('Order payment status updated', event)\n}\n\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"5a521f73-0824-40b8-af4c-86da30219db8\",\n * \"entityId\": \"7a8b195e-ab73-4138-b9da-cdf5e864a451\",\n * \"eventTime\": \"2023-01-16T14:40:02.119716Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"data\": {\n * \"order\": {\n * \"_id\": \"7a8b195e-ab73-4138-b9da-cdf5e864a451\",\n * \"number\": \"10003\",\n * \"_createdDate\": \"2023-01-16T13:53:10.776Z\",\n * \"_updatedDate\": \"2023-01-16T14:40:01.997Z\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"productName\": {\n * \"original\": \"Watch\",\n * \"translated\": \"Watch\"\n * },\n * \"catalogReference\": {\n * \"catalogItemId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"options\": {\n * \"Size\": \"Medium\",\n * \"Color\": \"Black\"\n * },\n * \"variantId\": \"e309b2f2-2166-4927-a137-0e5dfb870627\"\n * }\n * },\n * \"quantity\": 1,\n * \"totalDiscount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Size\",\n * \"translated\": \"Size\"\n * },\n * \"plainText\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * },\n * \"lineType\": \"PLAIN_TEXT\",\n * \"plainTextValue\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * }\n * },\n * {\n * \"name\": {\n * \"original\": \"Color\",\n * \"translated\": \"Color\"\n * },\n * \"colorInfo\": {\n * \"original\": \"Black\",\n * \"translated\": \"Black\"\n * },\n * \"lineType\": \"COLOR\",\n * \"color\": \"Black\"\n * }\n * ],\n * \"image\": \"wix:image://v1/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"physicalProperties\": {\n * \"sku\": \"217537123517253\",\n * \"shippable\": true\n * },\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"refundQuantity\": 0,\n * \"price\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * }\n * }\n * ],\n * \"buyerInfo\": {\n * \"contactId\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n * \"email\": \"janedoe8@gmail.com\",\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"paymentStatus\": \"PAID\",\n * \"fulfillmentStatus\": \"NOT_FULFILLED\",\n * \"buyerLanguage\": \"en\",\n * \"weightUnit\": \"KG\",\n * \"currency\": \"USD\",\n * \"taxIncludedInPrices\": false,\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"total\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalAdditionalFees\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"billingInfo\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * },\n * \"shippingInfo\": {\n * \"carrierId\": \"c8a08776-c095-4dec-8553-8f9698d86adc\",\n * \"code\": \"ed5bbce2-9533-dff4-7db0-13702fd139c5\",\n * \"title\": \"Standard US Shipping\",\n * \"logistics\": {\n * \"deliveryTime\": \"\",\n * \"shippingDestination\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * }\n * },\n * \"cost\": {\n * \"price\": {\n * \"amount\": \"10\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"10\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"taxDetails\": {\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"region\": {\n * \"name\": \"USA shipping\"\n * }\n * },\n * \"status\": \"APPROVED\",\n * \"archived\": false,\n * \"taxSummary\": {\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"appliedDiscounts\": [],\n * \"activities\": [\n * {\n * \"_createdDate\": \"2023-01-16T13:53:10.776Z\",\n * \"type\": \"ORDER_PLACED\"\n * },\n * {\n * \"_createdDate\": \"2023-01-16T14:38:48.249Z\",\n * \"type\": \"EMAIL_EDITED\"\n * }\n * ],\n * \"attributionSource\": \"UNSPECIFIED\",\n * \"createdBy\": {\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"channelInfo\": {\n * \"type\": \"WEB\"\n * },\n * \"seenByAHuman\": true,\n * \"checkoutId\": \"9f24eba1-5b05-4c9e-90c5-1789a8239912\",\n * \"customFields\": [],\n * \"cartId\": \"eb8086a0-9389-4e92-91cb-5ce7bd9b3db8\",\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"total\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * }\n * },\n * \"balanceSummary\": {\n * \"balance\": {\n * \"amount\": \"0.00\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"additionalFees\": []\n * },\n * \"previousPaymentStatus\": \"NOT_PAID\"\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderPaymentStatusUpdated","referenceFqn":"docs/ecom-v1-order.OrderPaymentStatusUpdated"},"description":"Information about the updated order."}],"description":"Triggered when an order's payment status is updated.\n\n\nThe `onOrderPaymentStatusUpdated()` event handler runs when an order's payment status is updated. The received `OrderPaymentStatusUpdated ` object contains information about the order, the previous payment status, and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrderPaymentStatusUpdated"},{"name":"onOrderUpdated","fqn":"wixEcom_onOrderUpdated","slug":"on-order-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"An event fired when an order is updated ","description":"","content":"// Place this code in the events.js file\n// of your site's Backend section.\n// Add the file if it doesn't exist.\n\nexport function wixEcom_onOrderUpdated(event) {\n const orderId = event.data.order._id;\n const orderTotalPrice = event.data.order.priceSummary.totalPrice.amount;\n const eventId = event.metadata.id;\n console.log('Order updated', event)\n}\n\n\n/* Full event object:\n *\n * {\n * \"metadata\": {\n * \"id\": \"69020d87-07b4-4e0b-9a7e-c0b607152e28\",\n * \"entityId\": \"7a8b195e-ab73-4138-b9da-cdf5e864a451\",\n * \"eventTime\": \"2023-01-16T13:53:13.143235Z\",\n * \"triggeredByAnonymizeRequest\": false\n * },\n * \"entity\": {\n * \"_id\": \"7a8b195e-ab73-4138-b9da-cdf5e864a451\",\n * \"number\": \"10003\",\n * \"_createdDate\": \"2023-01-16T13:53:10.776Z\",\n * \"_updatedDate\": \"2023-01-16T13:53:13.099Z\",\n * \"lineItems\": [\n * {\n * \"_id\": \"00000000-0000-0000-0000-000000000001\",\n * \"productName\": {\n * \"original\": \"Watch\",\n * \"translated\": \"Watch\"\n * },\n * \"catalogReference\": {\n * \"catalogItemId\": \"1a2d7e83-4bef-31d5-09e1-3326ee271c09\",\n * \"appId\": \"215238eb-22a5-4c36-9e7b-e7c08025e04e\",\n * \"options\": {\n * \"options\": {\n * \"Size\": \"Medium\",\n * \"Color\": \"Black\"\n * },\n * \"variantId\": \"e309b2f2-2166-4927-a137-0e5dfb870627\"\n * }\n * },\n * \"quantity\": 1,\n * \"totalDiscount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"descriptionLines\": [\n * {\n * \"name\": {\n * \"original\": \"Size\",\n * \"translated\": \"Size\"\n * },\n * \"plainText\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * },\n * \"lineType\": \"PLAIN_TEXT\",\n * \"plainTextValue\": {\n * \"original\": \"Medium\",\n * \"translated\": \"Medium\"\n * }\n * },\n * {\n * \"name\": {\n * \"original\": \"Color\",\n * \"translated\": \"Color\"\n * },\n * \"colorInfo\": {\n * \"original\": \"Black\",\n * \"translated\": \"Black\"\n * },\n * \"lineType\": \"COLOR\",\n * \"color\": \"Black\"\n * }\n * ],\n * \"image\": \"wix:image://v1/3c76e2_8891bbe3372a428aac976ac59aa0ac74~mv2.jpg#originWidth=1000&originHeight=1000\",\n * \"physicalProperties\": {\n * \"sku\": \"217537123517253\",\n * \"shippable\": true\n * },\n * \"itemType\": {\n * \"preset\": \"PHYSICAL\"\n * },\n * \"refundQuantity\": 0,\n * \"price\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"priceBeforeDiscounts\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"paymentOption\": \"FULL_PAYMENT_ONLINE\",\n * \"taxDetails\": {\n * \"taxableAmount\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * }\n * }\n * ],\n * \"buyerInfo\": {\n * \"contactId\": \"24de6f0b-60ce-4faa-9138-2e39f1415615\",\n * \"email\": \"janedoe@gmail.com\",\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"paymentStatus\": \"NOT_PAID\",\n * \"fulfillmentStatus\": \"NOT_FULFILLED\",\n * \"buyerLanguage\": \"en\",\n * \"weightUnit\": \"KG\",\n * \"currency\": \"USD\",\n * \"taxIncludedInPrices\": false,\n * \"priceSummary\": {\n * \"subtotal\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"total\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalAdditionalFees\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"billingInfo\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * },\n * \"shippingInfo\": {\n * \"carrierId\": \"c8a08776-c095-4dec-8553-8f9698d86adc\",\n * \"code\": \"ed5bbce2-9533-dff4-7db0-13702fd139c5\",\n * \"title\": \"Standard US Shipping\",\n * \"logistics\": {\n * \"deliveryTime\": \"\",\n * \"shippingDestination\": {\n * \"address\": {\n * \"addressLine1\": \"525 5th Avenue\",\n * \"city\": \"New York\",\n * \"subdivision\": \"US-NY\",\n * \"country\": \"US\",\n * \"postalCode\": \"10173\"\n * },\n * \"contactDetails\": {\n * \"firstName\": \"Jane\",\n * \"lastName\": \"Doe\",\n * \"phone\": \"0555555555\"\n * }\n * }\n * },\n * \"cost\": {\n * \"price\": {\n * \"amount\": \"10\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"totalPriceBeforeTax\": {\n * \"amount\": \"10\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"totalPriceAfterTax\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"taxDetails\": {\n * \"taxRate\": \"0.0\",\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"discount\": {\n * \"amount\": \"0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"region\": {\n * \"name\": \"USA shipping\"\n * }\n * },\n * \"status\": \"APPROVED\",\n * \"archived\": false,\n * \"taxSummary\": {\n * \"totalTax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * }\n * },\n * \"appliedDiscounts\": [],\n * \"activities\": [\n * {\n * \"_createdDate\": \"2023-01-16T13:53:10.776Z\",\n * \"type\": \"ORDER_PLACED\"\n * }\n * ],\n * \"attributionSource\": \"UNSPECIFIED\",\n * \"createdBy\": {\n * \"visitorId\": \"4c7ce95c-9fb3-417d-9f02-b41e82b841f7\"\n * },\n * \"channelInfo\": {\n * \"type\": \"WEB\"\n * },\n * \"seenByAHuman\": false,\n * \"checkoutId\": \"9f24eba1-5b05-4c9e-90c5-1789a8239912\",\n * \"customFields\": [],\n * \"cartId\": \"eb8086a0-9389-4e92-91cb-5ce7bd9b3db8\",\n * \"payNow\": {\n * \"subtotal\": {\n * \"amount\": \"30.00\",\n * \"formattedAmount\": \"$30.00\"\n * },\n * \"shipping\": {\n * \"amount\": \"10.0\",\n * \"formattedAmount\": \"$10.00\"\n * },\n * \"tax\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"discount\": {\n * \"amount\": \"0.0\",\n * \"formattedAmount\": \"$0.00\"\n * },\n * \"totalPrice\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"total\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * },\n * \"totalWithoutGiftCard\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * }\n * },\n * \"balanceSummary\": {\n * \"balance\": {\n * \"amount\": \"40.00\",\n * \"formattedAmount\": \"$40.00\"\n * }\n * },\n * \"additionalFees\": []\n * }\n * }\n *\n */"}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderUpdated","referenceFqn":"docs/ecom-v1-order.OrderUpdated"},"description":"Information about the order that was updated."}],"description":"Triggered when an order is updated.\n\n\nThe `onOrderUpdated()` event handler runs when an order is updated. The received `OrderUpdated` object contains information about the order that was updated and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrderUpdated"},{"name":"onOrderTransactionsUpdated","fqn":"wixEcom_onOrderTransactionsUpdated","slug":"on-order-transactions-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onOrderTransactionsUpdated example","content":"\n export function wixEcom_onOrderTransactionsUpdated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderTransactionsUpdated","referenceFqn":"docs/ecom-v1-order-transactions.OrderTransactionsUpdated"},"description":"Information about the transaction that was updated and event metadata."}],"description":"Triggered when a payment or refund is added to an order, or when an existing payment is updated.\n\n\nThe `onOrderTransactionsUpdated()` event handler runs when a new a payment or refund is added to an order, or when an existing payment is updated. The received `OrderTransactionsUpdated` object contains information about the updated order transactions, and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrderTransactionsUpdated"},{"name":"onOrdersSettingsUpdated","fqn":"wixEcom_onOrdersSettingsUpdated","slug":"on-orders-settings-updated","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"void"},"examples":[{"title":"onOrdersSettingsUpdated example","content":"\n export function wixEcom_onOrdersSettingsUpdated(event) {\n const eventId = event.metadata.id\n const entityId = event.entity._id;\n }\n\n "}],"actionParams":[{"name":"event","slug":"event","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrdersSettingsUpdated","referenceFqn":"docs/ecom-v1-orders-settings.OrdersSettingsUpdated"},"description":"Information about the orders settings that were updated and event metadata."}],"description":"Triggered when order settings are updated.\n\n\nThe `onOrdersSettingsUpdated()` event handler runs when order settings are updated. The received `OrdersSettingsUpdated` object contains information about the order settings that were updated and event metadata.\n\n>**Note:** Backend events don't work when previewing your site.","originalName":"wixEcom_onOrdersSettingsUpdated"}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n# Introduction\n\nWix eCommerce events are fired on your site's backend when certain events occur related to eCommerce carts, current carts, checkouts, orders, and more. You can write event handlers that react to these events. Event handler functions receive data that corresponds to the event that fired. Use event handlers to create custom responses to eCommerce events.\n\n> **Note:** Backend events don't work when previewing your site.\n\nTo add an eCommerce (ecom) event handler, add an **events.js** file to the **Backend** section of your site if one does not already exist. All event handler functions for your site are defined in this file.\n\nEvent handler functions are defined using the following pattern:\n```javascript\nexport function _(event) { }\n```\n\nFor example, an event handler that handles the creation of a cart looks\nlike this:\n```javascript\nexport function wixEcom_onCartCreated(event) { }\n```\n\n","displayName":"Introduction","slugifyName":"introduction"}],"namespaces":[],"builderTypes":[],"properties":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.417"}}

onDiscountRuleCreated( )