{"id":"5fd5c639-636b-4b93-bfb4-621fb2244e77","createdDate":"2024-08-29T10:31:35.321Z","updatedDate":"2024-08-29T10:31:35.321Z","resourceId":"8c0b4d4c-fb64-49a4-9b99-ecae09b736f3","sdk":{"schema":{"name":"velo-deps_wix-restaurants.v2_operations","fqn":"","slug":"velo-deps-wix-restaurants-v2-operations","typesMap":{"Operation":{"name":"Operation","fqn":"Operation","slug":"operation","actions":[],"oneofProperties":{"onlineOrderingStatusOptions":[{"name":"pausedUntilOptions","slug":"paused-until-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineOrderingPausedUntilOptions","referenceFqn":"OnlineOrderingPausedUntilOptions"},"description":"Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`."}]},"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the operation was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Operation ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the operation was updated."},{"name":"default","slug":"default","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the operation is the default operation.
\nDefault: `false`."},{"name":"defaultFulfillmentType","slug":"default-fulfillment-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentType","referenceFqn":"FulfillmentType"},"description":"Default fulfillment type of the operation."},{"name":"fulfillmentIds","slug":"fulfillment-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the [fulfillment methods](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/fulfillment-methods/introduction) associated with the operation."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Operation name."},{"name":"onlineOrderingStatus","slug":"online-ordering-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineOrderingStatusType","referenceFqn":"OnlineOrderingStatusType"},"description":"Online ordering status of the operation.
\n- `ENABLED`: Operation currently accepts online orders.
\n- `DISABLED`: Operation currently does not accept online orders.
\n- `PAUSED_UNTIL`: Operation currently does not accept online orders, but will accept online orders from a specifed time and date. When applied, `pausedUntilOptions` is a required field.
\n- `UNDEFINED_ONLINE_ORDERING_STATUS`: Online ordering status is not defined."},{"name":"orderScheduling","slug":"order-scheduling","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderScheduling","referenceFqn":"OrderScheduling"},"description":"Information about when an order can be placed for."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number. Increments by 1 each time the operation is updated.\nTo prevent conflicting changes,\nthe existing `revision` must be passed when updating an operation."},{"name":"serviceFeeRuleIds","slug":"service-fee-rule-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the [service fee](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/introduction) rules associated with the operation."}]},"FulfillmentType":{"name":"FulfillmentType","fqn":"FulfillmentType","slug":"fulfillment-type","actions":[],"enumValues":["DELIVERY","PICKUP","UNDEFINED_FULFILLMENT_TYPE"],"properties":[]},"OnlineOrderingStatusType":{"name":"OnlineOrderingStatusType","fqn":"OnlineOrderingStatusType","slug":"online-ordering-status-type","actions":[],"enumValues":["DISABLED","ENABLED","PAUSED_UNTIL","UNDEFINED_ONLINE_ORDERING_STATUS"],"properties":[]},"OrderScheduling":{"name":"OrderScheduling","fqn":"OrderScheduling","slug":"order-scheduling","actions":[],"oneofProperties":{"orderSchedulingOptions":[{"name":"asapOptions","slug":"asap-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AsapOrderScheduling","referenceFqn":"AsapOrderScheduling"},"description":"Options for scheduling. Required if `type` is `ASAP`."},{"name":"preorderOptions","slug":"preorder-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PreorderScheduling","referenceFqn":"PreorderScheduling"},"description":"Options for scheduling. Required if `type` is `PREORDER`."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SchedulingType","referenceFqn":"SchedulingType"},"description":"Scheduling type.
\n- When `ASAP`, `asapOptions` is a required field.\n- When `PREORDER`, `preorderOptions` is a required field."}]},"AsapOrderScheduling":{"name":"AsapOrderScheduling","fqn":"AsapOrderScheduling","slug":"asap-order-scheduling","actions":[],"oneofProperties":{"asapFutureHandlingOptions":[{"name":"businessDaysAheadHandlingOptions","slug":"business-days-ahead-handling-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BusinessDaysAheadHandling","referenceFqn":"BusinessDaysAheadHandling"},"description":"Options for future handling. Required when `asapFutureHandlingType` is `BUSINESS_DAYS_AHEAD_HANDLING`."}]},"properties":[{"name":"asapFutureHandlingType","slug":"asap-future-handling-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AsapFutureHandlingType","referenceFqn":"AsapFutureHandlingType"},"description":"Defines if and how non-immediate orders should be handled.
\nWhen `BUSINESS_DAYS_AHEAD_HANDLING`, `businessDaysAheadHandlingOptions` is a required field."},{"name":"preparationTime","slug":"preparation-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PreparationTime","referenceFqn":"PreparationTime"},"description":"Amount of time needed to prepare the order.
\n- When `MAX_TIME`, `maxTimeOptions` is a required field.\n- When `MAX_RANGE`, `timeRangeOptions` is a required field."}]},"AsapFutureHandlingType":{"name":"AsapFutureHandlingType","fqn":"AsapFutureHandlingType","slug":"asap-future-handling-type","actions":[],"enumValues":["BUSINESS_DAYS_AHEAD_HANDLING","NO_FUTURE_HANDLING","UNKNOWN_ASAP_FUTURE_HANDLING"],"properties":[]},"BusinessDaysAheadHandling":{"name":"BusinessDaysAheadHandling","fqn":"BusinessDaysAheadHandling","slug":"business-days-ahead-handling","actions":[],"properties":[{"name":"daysCount","slug":"days-count","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of business days ahead for which orders can be scheduled.
\nSetting the `daysCount` to 0 means that orders can be scheduled until the end of the current business day."}]},"PreparationTime":{"name":"PreparationTime","fqn":"PreparationTime","slug":"preparation-time","actions":[],"oneofProperties":{"timeSpecification":[{"name":"maxTimeOptions","slug":"max-time-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDuration","referenceFqn":"TimeDuration"},"description":"Options for preparation time. Required when `type` is `MAX_TIME`."},{"name":"timeRangeOptions","slug":"time-range-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDurationRange","referenceFqn":"TimeDurationRange"},"description":"Options for preparation time. Required when `type` is `TIME_RANGE`."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PreparationTimePreparationTimeType","referenceFqn":"PreparationTimePreparationTimeType"},"description":"Preparation time type."}]},"TimeDuration":{"name":"TimeDuration","fqn":"TimeDuration","slug":"time-duration","actions":[],"properties":[{"name":"duration","slug":"duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Duration value. Unit of time specified in `timeUnit`."},{"name":"timeUnit","slug":"time-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeUnit","referenceFqn":"TimeUnit"},"description":"Unit of time for the duration."}]},"TimeUnit":{"name":"TimeUnit","fqn":"TimeUnit","slug":"time-unit","actions":[],"enumValues":["DAYS","HOURS","MINUTES","UNKNOWN_TIME_UNIT"],"properties":[]},"TimeDurationRange":{"name":"TimeDurationRange","fqn":"TimeDurationRange","slug":"time-duration-range","actions":[],"properties":[{"name":"maxDuration","slug":"max-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum duration value. Unit of time specified in `timeUnit`."},{"name":"minDuration","slug":"min-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum duration value. Unit of time specified in `timeUnit`."},{"name":"timeUnit","slug":"time-unit","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeUnit","referenceFqn":"TimeUnit"},"description":"Time unit for the time range."}]},"PreparationTimePreparationTimeType":{"name":"PreparationTimePreparationTimeType","fqn":"PreparationTimePreparationTimeType","slug":"preparation-time-preparation-time-type","actions":[],"enumValues":["MAX_TIME","TIME_RANGE","UNKNOWN_PREPARATION_TIME"],"properties":[]},"PreorderScheduling":{"name":"PreorderScheduling","fqn":"PreorderScheduling","slug":"preorder-scheduling","actions":[],"properties":[{"name":"fulfillmentTimesDisplay","slug":"fulfillment-times-display","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentTimesDisplayConfig","referenceFqn":"FulfillmentTimesDisplayConfig"},"description":"Configuration of the fulfillment times.
\nCurrenly, only `TIME_WINDOWS` is supported."},{"name":"method","slug":"method","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PreorderMethod","referenceFqn":"PreorderMethod"}}]},"FulfillmentTimesDisplayConfig":{"name":"FulfillmentTimesDisplayConfig","fqn":"FulfillmentTimesDisplayConfig","slug":"fulfillment-times-display-config","actions":[],"oneofProperties":{"fulfillmentTimesDisplayOptions":[{"name":"timeWindowsOptions","slug":"time-windows-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDuration","referenceFqn":"TimeDuration"},"description":"Options for fulfillment time. Required when `fulfillmentTimesType` is `TIME_WINDOWS`."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentTimesType","referenceFqn":"FulfillmentTimesType"},"description":"Type of the fulfillment times.
\nWhen `TIME_WINDOWS`, `timeWindowsOptions` is a required field."}]},"FulfillmentTimesType":{"name":"FulfillmentTimesType","fqn":"FulfillmentTimesType","slug":"fulfillment-times-type","actions":[],"enumValues":["TIME_WINDOWS","UNKNOWN_TYPE"],"properties":[]},"PreorderMethod":{"name":"PreorderMethod","fqn":"PreorderMethod","slug":"preorder-method","actions":[],"oneofProperties":{"methodOptions":[{"name":"timeBoundedOptions","slug":"time-bounded-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeBounded","referenceFqn":"TimeBounded"},"description":"Options for method. Required when `type` is `TIME_BOUNDED`."},{"name":"weeklyScheduleOptions","slug":"weekly-schedule-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"WeeklySchedule","referenceFqn":"WeeklySchedule"},"description":"Options for method. Required when `type` is `WEEKLY_SCHEDULE`."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"MethodType","referenceFqn":"MethodType"},"description":"Type of time frame for how long in advance preorders can be made.
\n- When `TIME_BOUNDED`, `timeBoundedOptions` is a required field.\n- When `WEEKLY_SCHEDULE`, `weeklyScheduleOptions` is a required field."}]},"TimeBounded":{"name":"TimeBounded","fqn":"TimeBounded","slug":"time-bounded","actions":[],"properties":[{"name":"maxTimeInAdvance","slug":"max-time-in-advance","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDuration","referenceFqn":"TimeDuration"},"description":"Maximum time allowed to schedule the order."},{"name":"minTimeInAdvance","slug":"min-time-in-advance","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDuration","referenceFqn":"TimeDuration"},"description":"Minimum time required to schedule the order."}]},"MethodType":{"name":"MethodType","fqn":"MethodType","slug":"method-type","actions":[],"enumValues":["TIME_BOUNDED","UNKNOWN_TYPE","WEEKLY_SCHEDULE"],"properties":[]},"WeeklySchedule":{"name":"WeeklySchedule","fqn":"WeeklySchedule","slug":"weekly-schedule","actions":[],"properties":[{"name":"cutOffTime","slug":"cut-off-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DayAndTime","referenceFqn":"DayAndTime"},"description":"The weekly schedule cutoff time.
\nOrders placed before the cutoff time are scheduled for the current week.
\nOrders placed after the cutoff time are scheduled for the next week."}]},"DayAndTime":{"name":"DayAndTime","fqn":"DayAndTime","slug":"day-and-time","actions":[],"properties":[{"name":"dayOfWeek","slug":"day-of-week","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EntitiesDayOfWeek","referenceFqn":"EntitiesDayOfWeek"},"description":"Day of the week."},{"name":"timeOfDay","slug":"time-of-day","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeOfDay","referenceFqn":"TimeOfDay"},"description":"Time of the day."}]},"EntitiesDayOfWeek":{"name":"EntitiesDayOfWeek","fqn":"EntitiesDayOfWeek","slug":"entities-day-of-week","actions":[],"enumValues":["FRI","MON","SAT","SUN","THU","TUE","WED"],"properties":[]},"TimeOfDay":{"name":"TimeOfDay","fqn":"TimeOfDay","slug":"time-of-day","actions":[],"properties":[{"name":"hours","slug":"hours","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Hours.
\nMin: `0`.
\nMax: `23`."},{"name":"minutes","slug":"minutes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minutes.
\nMin: `0`.
\nMax: `23`."}]},"SchedulingType":{"name":"SchedulingType","fqn":"SchedulingType","slug":"scheduling-type","actions":[],"enumValues":["ASAP","PREORDER","UNKNOWN_SCHEDULING"],"properties":[]},"OnlineOrderingPausedUntilOptions":{"name":"OnlineOrderingPausedUntilOptions","fqn":"OnlineOrderingPausedUntilOptions","slug":"online-ordering-paused-until-options","actions":[],"properties":[{"name":"time","slug":"time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time until which online ordering is paused.
\n\nBefore the specified time, behavior is the same as when `onlineOrderingStatus` is `DISABLED`.
\n\nAfter the specified time, behavior is the same as when `onlineOrderingStatus` is `ENABLED`.
\n\nPassing the time does not trigger any changes to value of any properties."}]},"Scheduling":{"name":"Scheduling","fqn":"Scheduling","slug":"scheduling","actions":[],"oneofProperties":{"schedulingOptions":[{"name":"asapOptions","slug":"asap-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AsapScheduling","referenceFqn":"AsapScheduling"},"description":"Options for scheduling. Required when `type` is `ASAP`."},{"name":"preorderOptions","slug":"preorder-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PreorderScheduling","referenceFqn":"PreorderScheduling"},"description":"Options for scheduling. Required when `type` is `REQUIRED`."}]},"properties":[{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"SchedulingType","referenceFqn":"SchedulingType"},"description":"Scheduling type.
\n- When `ASAP`, `asapOptions` is a required field.\n- When `PREORDER`, `preorderOptions` is a required field."}]},"AsapScheduling":{"name":"AsapScheduling","fqn":"AsapScheduling","slug":"asap-scheduling","actions":[],"oneofProperties":{"preparationTime":[{"name":"maxOptions","slug":"max-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDuration","referenceFqn":"TimeDuration"},"description":"Options for preparation time. Required when `type` is `MAX_TIME`."},{"name":"rangeOptions","slug":"range-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeDurationRange","referenceFqn":"TimeDurationRange"},"description":"Options for preparation time. Required when `type` is `TIME_RANGE`."}],"asapPreorder":[{"name":"businessDaysPreorderOptions","slug":"business-days-preorder-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"BusinessDaysPreorder","referenceFqn":"BusinessDaysPreorder"},"description":"Information for when orders must be made a set number of business days in advance."}]},"properties":[{"name":"allowSameDayPreorder","slug":"allow-same-day-preorder","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Indication of whether it is possible to place an order for a later time on the same day.","replacedBy":"asap_preorder_type","targetRemovalDate":"2023-12-28"},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Indication of whether it is possible to place an order for a later time on the same day."},{"name":"asapPreorderType","slug":"asap-preorder-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"AsapPreorderType","referenceFqn":"AsapPreorderType"},"description":"The type of preorder allowed for the ASAP scheduling."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PreparationTimeType","referenceFqn":"PreparationTimeType"},"description":"How to define the time needed to prepare an order."}]},"AsapPreorderType":{"name":"AsapPreorderType","fqn":"AsapPreorderType","slug":"asap-preorder-type","actions":[],"enumValues":["BUSINESS_DAYS_PREORDER","NO_PREORDER","UNKNOWN_ASAP_PREORDER"],"properties":[]},"BusinessDaysPreorder":{"name":"BusinessDaysPreorder","fqn":"BusinessDaysPreorder","slug":"business-days-preorder","actions":[],"properties":[{"name":"businessDays","slug":"business-days","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum number of business days an order can be scheduled in advance.\n\nWhen `0`, an order can be scheduled only until the end of the current business day.\nFor any other value, the order can be scheduled for the end of the business day in that many days.\nFor example, `5` means the order can be scheduled for any time before the end of the 5th business day from today (where today is \"day 0\")."}]},"PreparationTimeType":{"name":"PreparationTimeType","fqn":"PreparationTimeType","slug":"preparation-time-type","actions":[],"enumValues":["MAX","RANGE","UNKNOWN_PREPARATION_TIME"],"properties":[]},"GetExpectedFulfillmentSelectionOptions":{"name":"GetExpectedFulfillmentSelectionOptions","fqn":"GetExpectedFulfillmentSelectionOptions","slug":"get-expected-fulfillment-selection-options","actions":[],"properties":[{"name":"canSubmitOrderForNow","slug":"can-submit-order-for-now","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether it is possible to submit an order to be prepared asap."},{"name":"deliveryAddress","slug":"delivery-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Delivery address. Optional.\n\nIf provided, the returned delivery fulfillment options will be able to deliver to this address."},{"name":"fulfilmentType","slug":"fulfilment-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentType","referenceFqn":"FulfillmentType"},"description":"Type of fulfillment."},{"name":"timeslotEndTime","slug":"timeslot-end-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"End time and date of the time slot."},{"name":"timeslotStartTime","slug":"timeslot-start-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Start time and date of the time slot."}]},"CommonAddress":{"name":"CommonAddress","fqn":"CommonAddress","slug":"common-address","actions":[],"oneofProperties":{"street":[{"name":"addressLine","slug":"address-line","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line, usually street and number as free text."},{"name":"streetAddress","slug":"street-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"StreetAddress","referenceFqn":"StreetAddress"},"description":"Street name and number."}]},"properties":[{"name":"addressLine1","slug":"address-line1","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Main address line, usually street and number as free text."},{"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, and 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":"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)."}]},"AddressLocation":{"name":"AddressLocation","fqn":"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."}]},"StreetAddress":{"name":"StreetAddress","fqn":"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."}]},"GetExpectedFulfillmentSelectionResponse":{"name":"GetExpectedFulfillmentSelectionResponse","fqn":"GetExpectedFulfillmentSelectionResponse","slug":"get-expected-fulfillment-selection-response","actions":[],"properties":[{"name":"expectedFulfillmentSelections","slug":"expected-fulfillment-selections","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentOption","referenceFqn":"FulfillmentOption"}},"description":"Expected fulfillment option."}]},"FulfillmentOption":{"name":"FulfillmentOption","fqn":"FulfillmentOption","slug":"fulfillment-option","actions":[],"oneofProperties":{"fulfillmentTimeOptions":[{"name":"durationRangeOptions","slug":"duration-range-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DurationRange","referenceFqn":"DurationRange"},"description":"Fulfillment time is limitted by a range."},{"name":"maxTimeOptions","slug":"max-time-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Fulfillment time has a maximum time."}],"fulfillmentTimesDisplayOptions":[{"name":"timeWindowsOptions","slug":"time-windows-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeWindowDisplayConfig","referenceFqn":"TimeWindowDisplayConfig"},"description":"Options for fulfillment time. Required when `type` is `TIME_WINDOWS`."}],"fulfillmentTypeOptions":[{"name":"deliveryOptions","slug":"delivery-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DeliveryDetails","referenceFqn":"DeliveryDetails"},"description":"Information about delivery fulfillment types."},{"name":"pickupOptions","slug":"pickup-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"PickupDetails","referenceFqn":"PickupDetails"},"description":"Information about pickup fulfillment types."}]},"properties":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fulfillment method ID."},{"name":"availability","slug":"availability","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentOptionAvailability","referenceFqn":"FulfillmentOptionAvailability"},"description":"Availability of the fulfillment option."},{"name":"fee","slug":"fee","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fee for using the fulfillment option."},{"name":"freeFulfillmentPriceThreshold","slug":"free-fulfillment-price-threshold","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum order price for free fulfillment.\nIf order price exceeds this amount, the given `fee` is waived."},{"name":"fulfillmentTimeType","slug":"fulfillment-time-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentTimeType","referenceFqn":"FulfillmentTimeType"},"description":"Fulfillment time type.\nRelevant only to ASAP operations."},{"name":"fulfillmentTimesDisplayType","slug":"fulfillment-times-display-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentTimesDisplayType","referenceFqn":"FulfillmentTimesDisplayType"},"description":"Fulfillment times display type. Relevant to preorder operations."},{"name":"instructions","slug":"instructions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Instructions for the fulfillment."},{"name":"minOrderPrice","slug":"min-order-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum order price to qualify for the fulfillment option."},{"name":"type","slug":"type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentType","referenceFqn":"FulfillmentType"},"description":"Fulfillment option type."}]},"FulfillmentOptionAvailability":{"name":"FulfillmentOptionAvailability","fqn":"FulfillmentOptionAvailability","slug":"fulfillment-option-availability","actions":[],"properties":[{"name":"asapHandlingAvailable","slug":"asap-handling-available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether it is possible to submit an order for as soon as possible handling."},{"name":"availableTimes","slug":"available-times","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"DayOfWeekAvailability","referenceFqn":"DayOfWeekAvailability"}},"description":"List of availabile times for the days of the week.\nAll the given times must be within the range between `startTime` and `endTime`."},{"name":"canSubmitOrderForNow","slug":"can-submit-order-for-now","isDeprecated":true,"isInternal":false,"maturity":"GA","deprecation":{"message":"Whether it is possible to submit an order for as soon as possible handling.","replacedBy":"asap_handling_available","targetRemovalDate":"2023-11-11"},"type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether it is possible to submit an order for as soon as possible handling."},{"name":"endTime","slug":"end-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time at which the fulfillment option's availability ends."},{"name":"exceptions","slug":"exceptions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"AvailabilityException","referenceFqn":"AvailabilityException"}},"description":"List of availability exceptions that override the availability defined in `availableTimes`."},{"name":"futureHandlingAvailable","slug":"future-handling-available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether it is possible to submit an order for future handling."},{"name":"startTime","slug":"start-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time at which the fulfillment option's availability starts."},{"name":"timeZone","slug":"time-zone","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Timezone for which the available times are given."}]},"DayOfWeekAvailability":{"name":"DayOfWeekAvailability","fqn":"DayOfWeekAvailability","slug":"day-of-week-availability","actions":[],"properties":[{"name":"dayOfWeek","slug":"day-of-week","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"EntitiesDayOfWeek","referenceFqn":"EntitiesDayOfWeek"},"description":"The day of week this availability relates to."},{"name":"timeRanges","slug":"time-ranges","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"TimeOfDayRange","referenceFqn":"TimeOfDayRange"}},"description":"A list of time ranges during which the fulfillment should be available."}]},"TimeOfDayRange":{"name":"TimeOfDayRange","fqn":"TimeOfDayRange","slug":"time-of-day-range","actions":[],"properties":[{"name":"endTime","slug":"end-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeOfDay","referenceFqn":"TimeOfDay"},"description":"The end time in time of day representation."},{"name":"startTime","slug":"start-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"TimeOfDay","referenceFqn":"TimeOfDay"},"description":"The start time in time of day representation."}]},"AvailabilityException":{"name":"AvailabilityException","fqn":"AvailabilityException","slug":"availability-exception","actions":[],"properties":[{"name":"available","slug":"available","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"An indication whether the exception makes the [`start_time`, `end_time`] range available."},{"name":"endTime","slug":"end-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The end time of the availability exception."},{"name":"reason","slug":"reason","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"The reason for the exception."},{"name":"startTime","slug":"start-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"The start time of the availability exception."}]},"DeliveryDetails":{"name":"DeliveryDetails","fqn":"DeliveryDetails","slug":"delivery-details","actions":[],"properties":[{"name":"deliveryProviderAppId","slug":"delivery-provider-app-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Delivery provider app id."}]},"DurationRange":{"name":"DurationRange","fqn":"DurationRange","slug":"duration-range","actions":[],"properties":[{"name":"maxDuration","slug":"max-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Maximum duration in minutes."},{"name":"minDuration","slug":"min-duration","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Minimum duration in minutes."}]},"FulfillmentTimeType":{"name":"FulfillmentTimeType","fqn":"FulfillmentTimeType","slug":"fulfillment-time-type","actions":[],"enumValues":["DURATION_RANGE","MAX_TIME","UNDEFINED_FULFILLMENT_TIME"],"properties":[]},"FulfillmentTimesDisplayType":{"name":"FulfillmentTimesDisplayType","fqn":"FulfillmentTimesDisplayType","slug":"fulfillment-times-display-type","actions":[],"enumValues":["TIME_WINDOWS","UNDEFINED_FULFILLMENT_TIMES_DISPLAY"],"properties":[]},"PickupDetails":{"name":"PickupDetails","fqn":"PickupDetails","slug":"pickup-details","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Pickup address. This is the restaurant's address."}]},"TimeWindowDisplayConfig":{"name":"TimeWindowDisplayConfig","fqn":"TimeWindowDisplayConfig","slug":"time-window-display-config","actions":[],"properties":[{"name":"durationInMinutes","slug":"duration-in-minutes","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Time window duration in minutes."}]},"ListAvailableDatesInRangeOptions":{"name":"ListAvailableDatesInRangeOptions","fqn":"ListAvailableDatesInRangeOptions","slug":"list-available-dates-in-range-options","actions":[],"properties":[{"name":"deliveryAddress","slug":"delivery-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Delivery address. Optional.\n\nIf provided, the returned delivery fulfillment options will be able to deliver to this address."},{"name":"from","slug":"from","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"_Date","referenceFqn":"_Date"},"description":"Start date and time of the range."},{"name":"until","slug":"until","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"_Date","referenceFqn":"_Date"},"description":"End date and time of the range."}]},"_Date":{"name":"_Date","fqn":"_Date","slug":"date","actions":[],"properties":[{"name":"day","slug":"day","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The day of the month."},{"name":"month","slug":"month","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The month of the year."},{"name":"year","slug":"year","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"The year of the date."}]},"ListAvailableDatesInRangeResponse":{"name":"ListAvailableDatesInRangeResponse","fqn":"ListAvailableDatesInRangeResponse","slug":"list-available-dates-in-range-response","actions":[],"properties":[{"name":"availableDates","slug":"available-dates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentTypeAvailableDates","referenceFqn":"FulfillmentTypeAvailableDates"}},"description":"List of the available dates in descending order for each fulfillment type."}]},"FulfillmentTypeAvailableDates":{"name":"FulfillmentTypeAvailableDates","fqn":"FulfillmentTypeAvailableDates","slug":"fulfillment-type-available-dates","actions":[],"properties":[{"name":"dates","slug":"dates","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"_Date","referenceFqn":"_Date"}},"description":"List of the available dates in descending order."},{"name":"fulfilmentType","slug":"fulfilment-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentType","referenceFqn":"FulfillmentType"},"description":"Type of the fulfillment."}]},"ListAvailableFulfillmentOptions":{"name":"ListAvailableFulfillmentOptions","fqn":"ListAvailableFulfillmentOptions","slug":"list-available-fulfillment-options","actions":[],"properties":[{"name":"deliveryAddress","slug":"delivery-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Delivery address. Optional.\n\nIf provided, the returned delivery fulfillment options will be able to deliver to this address."}]},"ListAvailableFulfillmentOptionsResponse":{"name":"ListAvailableFulfillmentOptionsResponse","fqn":"ListAvailableFulfillmentOptionsResponse","slug":"list-available-fulfillment-options-response","actions":[],"properties":[{"name":"blockedByAvailabilityExceptions","slug":"blocked-by-availability-exceptions","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether availability exceptions block the fulfillment options."},{"name":"deliveryConfigured","slug":"delivery-configured","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether delivery fulfillment method is configured for the requested operation."},{"name":"fulfillmentOptions","slug":"fulfillment-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentOption","referenceFqn":"FulfillmentOption"}},"description":"List of the available fulfillment options."},{"name":"pickupConfigured","slug":"pickup-configured","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether pickup fulfillment method is configured for the requested operation."}]},"ListAvailableTimeSlotsForDateOptions":{"name":"ListAvailableTimeSlotsForDateOptions","fqn":"ListAvailableTimeSlotsForDateOptions","slug":"list-available-time-slots-for-date-options","actions":[],"properties":[{"name":"date","slug":"date","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"_Date","referenceFqn":"_Date"},"description":"Date and time to get the available time slots for."},{"name":"deliveryAddress","slug":"delivery-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Delivery address. Optional.\n\nIf provided, the returned delivery fulfillment options will be able to deliver to this address."}]},"ListAvailableTimeSlotsForDateResponse":{"name":"ListAvailableTimeSlotsForDateResponse","fqn":"ListAvailableTimeSlotsForDateResponse","slug":"list-available-time-slots-for-date-response","actions":[],"properties":[{"name":"timeSlots","slug":"time-slots","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentTimeSlot","referenceFqn":"FulfillmentTimeSlot"}},"description":"Lst of the available time slots in the requested date."}]},"FulfillmentTimeSlot":{"name":"FulfillmentTimeSlot","fqn":"FulfillmentTimeSlot","slug":"fulfillment-time-slot","actions":[],"properties":[{"name":"endTime","slug":"end-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"End time and date of the time slot."},{"name":"fulfillmentAddress","slug":"fulfillment-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentAddress","referenceFqn":"FulfillmentAddress"},"description":"Address of the fulfillment."},{"name":"fulfillmentDetails","slug":"fulfillment-details","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentDetails","referenceFqn":"FulfillmentDetails"}},"description":"Details for each fulfillment option of the time slot."},{"name":"fulfilmentType","slug":"fulfilment-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentType","referenceFqn":"FulfillmentType"},"description":"Type of the fulfillment."},{"name":"startTime","slug":"start-time","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Start time and date of the time slot."},{"name":"startsNow","slug":"starts-now","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the time slot starts now."}]},"FulfillmentAddress":{"name":"FulfillmentAddress","fqn":"FulfillmentAddress","slug":"fulfillment-address","actions":[],"properties":[{"name":"address","slug":"address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Pickup address. This is the address of the restaurant."}]},"FulfillmentDetails":{"name":"FulfillmentDetails","fqn":"FulfillmentDetails","slug":"fulfillment-details","actions":[],"oneofProperties":{"fulfillmentTimeOptions":[{"name":"durationRangeOptions","slug":"duration-range-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"DurationRange","referenceFqn":"DurationRange"},"description":"Fulfillment time has a minimum and a maximum."},{"name":"maxTimeOptions","slug":"max-time-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"number"},"description":"Fulfillment time has a maximum."}]},"properties":[{"name":"fee","slug":"fee","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Fee for using this fulfillment."},{"name":"freeFulfillmentPriceThreshold","slug":"free-fulfillment-price-threshold","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum order price for free fulfillment.\nIf order price exceeds this amount, the given `fee` is waived."},{"name":"fulfillmentTimeType","slug":"fulfillment-time-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentTimeType","referenceFqn":"FulfillmentTimeType"},"description":"Fulfillment time type. Only be relevant to ASAP operations."},{"name":"minOrderPrice","slug":"min-order-price","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Minimum order price to qualify for using this fulfillment."}]},"ListFirstAvailableTimeSlotForFulfillmentTypesOptions":{"name":"ListFirstAvailableTimeSlotForFulfillmentTypesOptions","fqn":"ListFirstAvailableTimeSlotForFulfillmentTypesOptions","slug":"list-first-available-time-slot-for-fulfillment-types-options","actions":[],"properties":[{"name":"deliveryAddress","slug":"delivery-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Delivery address. Optional.\n\nIf provided, the returned delivery fulfillment options will be able to deliver to this address."}]},"ListFirstAvailableTimeSlotForFulfillmentTypesResponse":{"name":"ListFirstAvailableTimeSlotForFulfillmentTypesResponse","fqn":"ListFirstAvailableTimeSlotForFulfillmentTypesResponse","slug":"list-first-available-time-slot-for-fulfillment-types-response","actions":[],"properties":[{"name":"timeSlots","slug":"time-slots","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentTimeSlot","referenceFqn":"FulfillmentTimeSlot"}},"description":"List of available time slots for each fulfillment type.\n\nEach time slot will be the first available time slot for the given fulfillment type.\nA delivery fulfillment type will only be returned if the delivery address is provided."}]},"ListFirstAvailableTimeSlotsForMenusOptions":{"name":"ListFirstAvailableTimeSlotsForMenusOptions","fqn":"ListFirstAvailableTimeSlotsForMenusOptions","slug":"list-first-available-time-slots-for-menus-options","actions":[],"properties":[{"name":"deliveryAddress","slug":"delivery-address","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"CommonAddress","referenceFqn":"CommonAddress"},"description":"Delivery address. Optional.\n\nIf provided, the returned delivery fulfillment options will be able to deliver to this address."},{"name":"menuIds","slug":"menu-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Menu IDs to get the first available time slots for."}]},"ListFirstAvailableTimeSlotsForMenusResponse":{"name":"ListFirstAvailableTimeSlotsForMenusResponse","fqn":"ListFirstAvailableTimeSlotsForMenusResponse","slug":"list-first-available-time-slots-for-menus-response","actions":[],"properties":[{"name":"timeSlotsPerMenu","slug":"time-slots-per-menu","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FirstFulfillmentTimeSlotsPerMenu","referenceFqn":"FirstFulfillmentTimeSlotsPerMenu"}},"description":"List of available time slots for each menu.\nFor each menu will be returned the first available time slot for each fulfillment type."}]},"FirstFulfillmentTimeSlotsPerMenu":{"name":"FirstFulfillmentTimeSlotsPerMenu","fqn":"FirstFulfillmentTimeSlotsPerMenu","slug":"first-fulfillment-time-slots-per-menu","actions":[],"properties":[{"name":"menuId","slug":"menu-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Menu ID."},{"name":"timeslotsPerFulfillmentType","slug":"timeslots-per-fulfillment-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"FulfillmentTimeSlot","referenceFqn":"FulfillmentTimeSlot"}},"description":"List of available time slots for each fulfillment type."}]},"ListOperationIdsResponse":{"name":"ListOperationIdsResponse","fqn":"ListOperationIdsResponse","slug":"list-operation-ids-response","actions":[],"properties":[{"name":"operationIds","slug":"operation-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"List of operation ids"}]},"ListOperationsResponse":{"name":"ListOperationsResponse","fqn":"ListOperationsResponse","slug":"list-operations-response","actions":[],"properties":[{"name":"operations","slug":"operations","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Operation","referenceFqn":"Operation"}},"description":"Retrieved operations."}]},"OperationsQueryBuilder":{"name":"OperationsQueryBuilder","fqn":"OperationsQueryBuilder","slug":"operations-query-builder","actions":[{"name":"ascending","fqn":"OperationsQueryBuilder.ascending","slug":"ascending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `ascending` sort to a query","content":"const query = operations.queryOperation.ascending('_id');\n"},{"title":"Create a query, add an `ascending` sort, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().ascending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in ascending order.\n\nThe `ascending()` function refines a `OperationsQueryBuilder` to sort by the value of `propertyName` in ascending order.\nYou can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. `ascending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"descending","fqn":"OperationsQueryBuilder.descending","slug":"descending","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `descending` sort to a query","content":"const query = operations.queryOperation.descending('_id');\n"},{"title":"Create a query, add a `descending` sort, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().descending('_id').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyNames","slug":"property-names","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"Properties used in the sort. To sort by multiple properties, pass properties as additional arguments."}],"description":"Adds a sort to a query, sorting by the specified properties in descending order.\n\nThe `descending()` function refines a `OperationsQueryBuilder` to sort by the value of `propertyName` in descending order.\nYou can specify multiple properties for sorting in descending order by passing each property name as an additional argument. `descending()` sorts the results in the order the properties are passed.\nYou can sort the following types:\n- Number: Sorts numerically.\n- Date: Sorts by date and time.\n- String: Sorts lexicographically, so `'abc'` comes after `'XYZ'`.\nIf a property contains a number stored as a string (for example, `'0'`), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest."},{"name":"eq","fqn":"OperationsQueryBuilder.eq","slug":"eq","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `eq` filter to a query","content":"const query = operations.queryOperation.eq('_id', 'some-id');\n"},{"title":"Create a query, add an `eq` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .eq('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property equals the specified value.\n\nThe `eq()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` equals the specified `value`.\n`eq()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `eq()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"exists","fqn":"OperationsQueryBuilder.exists","slug":"exists","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `exists` filter to a query","content":"const query = operations.queryOperation.exists(\n 'description',\n 'some-description'\n);\n"},{"title":"Create a query, add an `exists` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .exists('description', 'some-description')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"}}],"description":"Refines a query to match items where the specified property contains a value.\n\nThe `exists()` function refines a `OperationsQueryBuilder` to only match items where the value of the specified `propertyName` doesn't equal null or undefined.\n `exists()` checks for either existence or non-existence based on the boolen parameter. Note that `exists()` does match items where the value of the specified `propertyName` is an empty string or an invalid value. `exists()` is only useful for properties which don't contain default values and therefore their values may be unassigned."},{"name":"find","fqn":"OperationsQueryBuilder.find","slug":"find","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"OperationsQueryResult","referenceFqn":"OperationsQueryResult"}},"examples":[{"title":"Run a query with no filters","content":"const query = operations.queryOperation.find();\n"},{"title":"Perform a `find` on a query","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"description":"Returns the query results.\n\nThe `find()` function returns a Promise that resolves to the query results and metadata.\nThe Promise is rejected if `find()` is called with insufficient permissions or if any of the previous functions used to refine the query are invalid."},{"name":"ge","fqn":"OperationsQueryBuilder.ge","slug":"ge","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `ge` filter to a query","content":"const query = operations.queryOperation.ge('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `ge` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .ge('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than or equal to the specified value.\n\nThe `ge()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than or equal to the specified `value`.\n`ge()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"gt","fqn":"OperationsQueryBuilder.gt","slug":"gt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `gt` filter to a query","content":"const query = operations.queryOperation.gt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add a `gt` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .gt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is greater than the specified value.\n\nThe `gt()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` is greater than the specified `value`.\n`gt()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'abc'` is greater than `'ABC'`."},{"name":"hasAll","fqn":"OperationsQueryBuilder.hasAll","slug":"has-all","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `hasAll` filter to a query","content":"const query = operations.queryOperation.hasAll('labelIds', [\n 'red',\n 'blue',\n 'purple',\n]);\n"},{"title":"Create a query, add a `hasAll` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .hasAll('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains all of the specified values.\n\nThe `hasAll()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` equals all of the specified `values`.\nMatching strings with `hasAll()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasAll()` matches if that array's elements match all of the specified values."},{"name":"hasSome","fqn":"OperationsQueryBuilder.hasSome","slug":"has-some","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `hasSome` filter to a query","content":"const query = operations.queryOperation.hasSome('labelIds', [\n 'red',\n 'blue',\n 'purple',\n]);\n"},{"title":"Create a query, add a `hasSome` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .hasSome('labelIds', ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `values`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"any"}}}],"description":"Refines a query to match items whose specified property contains any of the specified values.\n\nThe `hasSome()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` equals any of the specified `values`.\nMatching strings with `hasSome()` is case-sensitive, so `'text'` isn't equal to `'Text'`.\nIf the specified property is an array, `hasSome()` matches if any of that array's elements equal any of the specified values."},{"name":"in","fqn":"OperationsQueryBuilder.in","slug":"in","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `in` filter to a query","content":"const query = operations.queryOperation.in(\n ['labelIds', 'colors'],\n ['red', 'blue', 'purple']\n);\n"},{"title":"Create a query, add an `in` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .in(['labelIds', 'colors'], ['red', 'blue', 'purple'])\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"}}],"description":"Refines a query to only match items where the specified property conatins any of the values in the provided array of values.\n\nThe `in()` function refines a `OperationsQueryBuilder` to match only items where the specified `propertyName` is equal to any of the values in the provided array.\nMatching strings with `in()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"le","fqn":"OperationsQueryBuilder.le","slug":"le","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `le` filter to a query","content":"const query = operations.queryOperation.le('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `le` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .le('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than or equal to the specified value.\n\nThe `le()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` is less than or equal to the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"limit","fqn":"OperationsQueryBuilder.limit","slug":"limit","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `limit` to a query","content":"const query = operations.queryOperation.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"limit","slug":"limit","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Add a `limit` to a query","content":"const query = operations.queryOperation.limit(10);\n"},{"title":"Create a query, add a `limit`, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().limit(10).find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Number of items to return, which is also the `pageSize` of the results object."}],"description":"Limits the number of items the query returns.\n\nThe `limit()` function defines the number of results a query returns in each page. Only one page of results is retrieved at a time.\nYou can use the `next()` and `prev()` functions to navigate the pages of a query result."},{"name":"lt","fqn":"OperationsQueryBuilder.lt","slug":"lt","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `lt` filter to a query","content":"const query = operations.queryOperation.lt('_createdDate', '2021-03-01');\n"},{"title":"Create a query, add an `lt` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .lt('_createdDate', '2021-03-01')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property is less than the specified value.\n\nThe `le()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` is less than the specified `value`.\n`le()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nIf a property contains a number stored as a string (for example, `'0'`), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.\nThe following types of properties can be compared:\n- Number: Compares numerically.\n- Date: Compares JavaScript Date objects. \n- String: Compares lexicographically, so `'ABC'` is less than `'abc'`."},{"name":"ne","fqn":"OperationsQueryBuilder.ne","slug":"ne","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add an `ne` filter to a query","content":"const query = operations.queryOperation.ne(\n '_id',\n 'bb19b637-74ce-55d3-ae32-430b588051da'\n);\n"},{"title":"Create a query, add an `ne` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations\n .queryOperation()\n .ne('_id', 'bb19b637-74ce-55d3-ae32-430b588051da')\n .find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `value`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"any"},"description":"Value to compare against."}],"description":"Refines a query to match items where the specified property doesn't equal the specified value.\n\nThe `ne()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` doesn't equal the specified `value`.\n`ne()` matches only values of the same type. For example, `0` stored as a number doesn't match `'0'` stored as a string.\nMatching strings with `ne()` is case-sensitive, so `'text'` isn't equal to `'Text'`."},{"name":"skipTo","fqn":"OperationsQueryBuilder.skipTo","slug":"skip-to","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Perform a query and skip to the next cursor","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n const nextCursor = results.cursors.next;\n return operations.queryOperation().skipTo(nextCursor).find();\n}\n"},{"title":"Perform a query and skip to the previous cursor","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n const prevCursor = results.cursors.prev;\n return operations.queryOperation().skipTo(prevCursor).find();\n}\n"}],"actionParams":[{"name":"cursor","slug":"cursor","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"A pointer to specific record"}],"description":"Refines a query that skips to a specific record.\n\nThe `skipTo()` function refines a `OperationsQueryBuilder` to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the `cursors` object in previous call's response. Then you can skip to `cursors.prev` to return items before the cursor, or `cursors.next` to return items after the cursor.\n \nWhen using `skipTo()`, the filters and the sorting order of the original query can't be changed. Only the `limit()` property of the query can be changed."},{"name":"startsWith","fqn":"OperationsQueryBuilder.startsWith","slug":"starts-with","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"Add a `startsWith` filter to a query","content":"const query = operations.queryOperation.startsWith('_id', 'L');\n"},{"title":"Create a query, add a `startsWith` filter, and run it","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation();\n startsWith('_id', 'L').find();\n\n if (results.items.length > 0) {\n const items = results.items;\n const firstItem = items[0];\n const pageSize = results.pageSize;\n const hasNext = results.hasNext();\n const hasPrev = results.hasPrev();\n const length = results.length;\n const query = results.query;\n\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"actionParams":[{"name":"propertyName","slug":"property-name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Property whose value is compared with `string`."},{"name":"value","slug":"value","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"}}],"description":"Refines a query to match items where the specified property starts with the specified value.\n\nThe `startsWith()` function refines a `OperationsQueryBuilder` to match only items where the value of the specified `propertyName` starts with the specified `string`.\nMatching with `startsWith()` is case-sensitive, so `'TEXT'` doesn't start with `'text'`.\nYou can only use `startsWith()` with a property whose value is a string."}],"properties":[]},"OperationsQueryResult":{"name":"OperationsQueryResult","fqn":"OperationsQueryResult","slug":"operations-query-result","actions":[{"name":"hasNext","fqn":"OperationsQueryResult.hasNext","slug":"has-next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has more results","content":"const hasNext = results.hasNext();\n"},{"title":"Perform a query and get `hasNext` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.hasNext();\n}\n"}],"description":"Indicates whether the query has more results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `operations` to navigate the pages of a query result."},{"name":"hasPrev","fqn":"OperationsQueryResult.hasPrev","slug":"has-prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PRIMITIVE","name":"boolean"},"examples":[{"title":"Get whether the query has previous results","content":"const hasPrev = results.hasPrev();\n"},{"title":"Perform a query and get `hasPrev` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.hasPrev();\n}\n"}],"description":"Indicates whether the query has previous results.\n\nYou can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `operations` to navigate the pages of a query result."},{"name":"next","fqn":"OperationsQueryResult.next","slug":"next","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"OperationsQueryResult","referenceFqn":"OperationsQueryResult"}},"examples":[{"title":"Get `next` from a query result","content":"const nextPage = results.next();\n"},{"title":"Perform a query and get `next` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.next();\n}\n"},{"title":"Iterate through all pages of query results","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n let allItems = [];\n\n const results = await operations.queryOperation().limit(1000).find();\n allItems.push(results.items);\n\n while (results.hasNext()) {\n results = await results.next();\n allItems.push(results.items);\n }\n\n return allItems;\n}\n"}],"description":"Retrieves the next page of query results.\n\nThe `next()` function retrieves the next page of query results.\nThe page size is defined by the [`limit()`](/operations/operations-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `operations` to navigate the pages of a query result.\nIf items are added or removed between calls to `next()`, the values returned by `OperationsQueryBuilder` may change."},{"name":"prev","fqn":"OperationsQueryResult.prev","slug":"prev","isDeprecated":false,"isInternal":false,"actionErrors":[],"maturity":"GA","adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"OperationsQueryResult","referenceFqn":"OperationsQueryResult"}},"examples":[{"title":"Get `prev` from a query result","content":"const previousPage = results.prev();\n"},{"title":"Perform a query and get `prev` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.prev();\n}\n"}],"description":"Retrieves the previous page of query results.\n\nThe `prev()` function retrieves the previous page of query results.\nThe page size is defined by the [`limit()`](/operations/operations-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `operations` to navigate the pages of a query result.\nIf items are added or removed between calls to `prev()`, the values returned may change."}],"properties":[{"name":"cursors","slug":"cursors","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's cursors","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n const cursors = results.cursors;\n}\n"}],"type":{"kind":"REFERENCE","name":"Cursors","referenceFqn":"Cursors"},"description":"Returns the query cursors.\n\n`cursors` returns the query's `next` and `prev` cursors."},{"name":"items","slug":"items","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `items` from a query result","content":"const returnedItems = results.items;\n"},{"title":"Perform a query and get `items` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n const returnedItems = results.items;\n\n if (returnedItems.length > 0) {\n return items;\n } else {\n // Handle if no matching items found\n }\n}\n"}],"type":{"kind":"ARRAY","elementType":{"kind":"REFERENCE","name":"Operation","referenceFqn":"Operation"}},"description":"Returns an array of `operations` items that match the query.\n\n`items` contains the current page of results retrieved by the query.\nIf no results match the query, `items` is an empty array.\nThe page size is defined by the [`limit()`](/operations/operations-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `operations` to navigate the pages of a query result."},{"name":"length","slug":"length","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `length` from a query result","content":"const resultLength = results.length;\n"},{"title":"Perform a query and get `length` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.length;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the number of items in the current page of results.\n\n`length` returns just the number of items in the current page, not the total number of items that match the query. For the total number of items that match the query, see [`totalCount`](#totalcount).\nThe page size is defined by the [`limit()`](/operations/operations-query-builder/limit) function and can be retrieved using the [`pageSize`](#pagesize) property. You can use the [`next()`](#next) and [`prev()`](#prev) functions returned by `operations` to navigate the pages of a query result."},{"name":"pageSize","slug":"page-size","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get the query's page size","content":"const requestedPageSize = results.pageSize;\n"},{"title":"Perform a query and get `pageSize` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.pageSize;\n}\n"}],"type":{"kind":"PRIMITIVE","name":"number"},"description":"Returns the requested page size.\n\n`pageSize` returns the page size set in [`limit()`](/operations/operations-query-builder/limit) in `OperationsQueryBuilder`."},{"name":"query","slug":"query","isDeprecated":false,"isInternal":false,"maturity":"GA","examples":[{"title":"Get `query` that produced the current result","content":"const originalQuery = results.query;\n"},{"title":"Perform a query and get `query` from the result","content":"import { operations } from 'wix-restaurants.v2';\n\nexport async function myQueryFunction() {\n const results = await operations.queryOperation().find();\n\n return results.query;\n}\n"}],"type":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"description":"Returns the `OperationsQueryBuilder` object used to get the current results.\n\nUse `query` to create and run a new query by chaining additional `OperationsQueryBuilder` functions to it. You can filter only on properties that haven't already been used in the previous `OperationsQueryBuilder`."}]},"Cursors":{"name":"Cursors","fqn":"Cursors","slug":"cursors","actions":[],"properties":[{"name":"next","slug":"next","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor string pointing to the next page in the list of results."},{"name":"prev","slug":"prev","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Cursor pointing to the previous page in the list of results."}]},"UpdateOperation":{"name":"UpdateOperation","fqn":"UpdateOperation","slug":"update-operation","actions":[],"properties":[{"name":"_createdDate","slug":"created-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the operation was created."},{"name":"_id","slug":"id","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Operation ID."},{"name":"_updatedDate","slug":"updated-date","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"DATE"},"description":"Date and time the operation was updated."},{"name":"default","slug":"default","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"boolean"},"description":"Whether the operation is the default operation.
\nDefault: `false`."},{"name":"defaultFulfillmentType","slug":"default-fulfillment-type","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"FulfillmentType","referenceFqn":"FulfillmentType"},"description":"Default fulfillment type of the operation."},{"name":"fulfillmentIds","slug":"fulfillment-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the [fulfillment methods](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/fulfillment-methods/introduction) associated with the operation."},{"name":"name","slug":"name","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Operation name."},{"name":"onlineOrderingStatus","slug":"online-ordering-status","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineOrderingStatusType","referenceFqn":"OnlineOrderingStatusType"},"description":"Online ordering status of the operation.
\n- `ENABLED`: Operation currently accepts online orders.
\n- `DISABLED`: Operation currently does not accept online orders.
\n- `PAUSED_UNTIL`: Operation currently does not accept online orders, but will accept online orders from a specifed time and date. When applied, `pausedUntilOptions` is a required field.
\n- `UNDEFINED_ONLINE_ORDERING_STATUS`: Online ordering status is not defined."},{"name":"orderScheduling","slug":"order-scheduling","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OrderScheduling","referenceFqn":"OrderScheduling"},"description":"Information about when an order can be placed for."},{"name":"pausedUntilOptions","slug":"paused-until-options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"OnlineOrderingPausedUntilOptions","referenceFqn":"OnlineOrderingPausedUntilOptions"},"description":"Options for online ordering status. Required when `onlineOrderingStatus` is `PAUSED_UNTIL`."},{"name":"revision","slug":"revision","isReadOnly":true,"isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Revision number. Increments by 1 each time the operation is updated.\nTo prevent conflicting changes,\nthe existing `revision` must be passed when updating an operation."},{"name":"serviceFeeRuleIds","slug":"service-fee-rule-ids","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"ARRAY","elementType":{"kind":"PRIMITIVE","name":"string"}},"description":"IDs of the [service fee](https://dev.wix.com/docs/rest/api-reference/wix-restaurants/service-fees/introduction) rules associated with the operation."}]},"UpdateOperationOptions":{"name":"UpdateOperationOptions","fqn":"UpdateOperationOptions","slug":"update-operation-options","actions":[],"properties":[]}},"standaloneTypes":[],"metadata":{"fqdn":"wix.restaurants.operations.v1.operation"},"actions":[{"name":"createOperation","fqn":"createOperation","slug":"create-operation","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["operation"],"permissions":["Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Operation","referenceFqn":"Operation"},"description":"Created operation."},"examples":[{"title":"createOperation example for dashboard page code","content":"import { operations } from 'wix-restaurants.v2';\n\nasync function createOperation(operation) {\n try {\n const result = await operations.createOperation(operation);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"createOperation example for exporting from backend code","content":"import { operations } from 'wix-restaurants.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedCreateOperation = elevate(operations.createOperation);\n\nexport const createOperation = webMethod(\n Permissions.Anyone,\n async (operation) => {\n try {\n const result = await elevatedCreateOperation(operation);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"operation","slug":"operation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"Operation","referenceFqn":"Operation"},"description":"Operation to create."}],"description":"Creates a new operation."},{"name":"deleteOperation","fqn":"deleteOperation","slug":"delete-operation","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["operationId"],"permissions":["Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"PRIMITIVE","name":"void"}},"examples":[{"title":"deleteOperation example for dashboard page code","content":"import { operations } from 'wix-restaurants.v2';\n\nasync function deleteOperation(operationId) {\n try {\n const result = await operations.deleteOperation(operationId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"deleteOperation example for exporting from backend code","content":"import { operations } from 'wix-restaurants.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedDeleteOperation = elevate(operations.deleteOperation);\n\nexport const deleteOperation = webMethod(\n Permissions.Anyone,\n async (operationId) => {\n try {\n const result = await elevatedDeleteOperation(operationId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"operationId","slug":"operation-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the operation to delete."}],"description":"Deletes an operation."},{"name":"getOperation","fqn":"getOperation","slug":"get-operation","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["operationId"],"permissions":["Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Operation","referenceFqn":"Operation"},"description":"Retrieved operation."},"examples":[{"title":"getOperation example","content":"import { operations } from 'wix-restaurants.v2';\n\nasync function getOperation(operationId) {\n try {\n const result = await operations.getOperation(operationId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"getOperation example for exporting from backend code","content":"import { operations } from 'wix-restaurants.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nexport const getOperation = webMethod(\n Permissions.Anyone,\n async (operationId) => {\n try {\n const result = await operations.getOperation(operationId);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"operationId","slug":"operation-id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"ID of the operation to retrieve."}],"description":"Retrieves an operation."},{"name":"listOperations","fqn":"listOperations","slug":"list-operations","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissions":["Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"ListOperationsResponse","referenceFqn":"ListOperationsResponse"}},"examples":[{"title":"listOperations example","content":"import { operations } from 'wix-restaurants.v2';\n\nasync function listOperations() {\n try {\n const result = await operations.listOperations();\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"listOperations example for exporting from backend code","content":"import { operations } from 'wix-restaurants.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nexport const listOperations = webMethod(\n Permissions.Anyone,\n async () => {\n try {\n const result = await operations.listOperations();\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"description":"Retrieves a list of operations.\nThe result will be sorted by created date in ascending order."},{"name":"queryOperation","fqn":"queryOperation","slug":"query-operation","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","permissionIds":["RESTAURANTS.OPERATION_READ"],"permissions":["Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP","VISITOR"],"adminMethod":false,"returnType":{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},"examples":[{"title":"queryOperation example","content":"import { operations } from 'wix-restaurants.v2';\n\nasync function queryOperation() {\n const { items } = operations.queryOperation().find();\n}\n"},{"title":"queryOperation example for exporting from backend code","content":"import { operations } from 'wix-restaurants.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\n\nexport const queryOperation = webMethod(\n Permissions.Anyone,\n async (query) => {\n try {\n const result = await operations.queryOperation(query);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"description":"Creates a query to retrieve a list of operations.\n\nThe `queryOperations()` function builds a query to retrieve a list of operations and returns an `OperationsQueryBuilder` object.\n\nThe returned object contains the query definition, which is used to run the query using the [`find()`](/operations/operations-query-builder/find) function.\n\nYou can refine the query by chaining `OperationsQueryBuilder` functions onto the query. `OperationsQueryBuilder` functions enable you to filter, sort, and control the results that `queryOperations()` returns.\n\n`queryOperations()` runs with the following `OperationsQueryBuilder` defaults, which you can override:\n\n* [`limit(50)`](/operations/operations-query-builder/limit)\n* [`ascending('entityId')`](/operations/operations-methods-query-builder/ascending)\n\nThe following `OperationsQueryBuilder` functions are supported for `queryOperations()`. For a full description of the operations object, see the object returned for the [`items`](/operations/operations-query-result/items) property in `OperationsQueryResult`.\n\n\n|PROPERTY\t|SUPPORTED FILTERS & SORTING\t\n|:---:|:---:|\n|`_id`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`startsWith()`](/operations/operations-query-builder/starts-with),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`_createdDate`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`lt()`](/operations/operations-query-builder/lt),[`le()`](/operations/operations-query-builder/le),[`gt()`](/operations/operations-query-builder/gt),[`ge()`](/operations/operations-query-builder/ge),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`_updatedDate`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`lt()`](/operations/operations-query-builder/lt),[`le()`](/operations/operations-query-builder/le),[`gt()`](/operations/operations-query-builder/gt),[`ge()`](/operations/operations-query-builder/ge),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`name`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`startsWith()`](/operations/operations-query-builder/starts-with),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`default`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`fulfillmentIds`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`hasAll()`](/operations/operations-query-builder/has-all),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`onlineOrderingStatus`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`serviceFeeRuleIds`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`hasAll()`](/operations/operations-query-builder/has-all),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|\n|`defaultFulfillmentType`|[`eq()`](/operations/operations-query-builder/eq),[`ne()`](/operations/operations-query-builder/ne),[`exists()`](/operations/operations-query-builder/exists),[`in()`](/operations/operations-query-builder/in),[`hasSome()`](/operations/operations-query-builder/has-some),[`ascending()`](/operations/operations-query-builder/ascending),[`descending()`](/operations/operations-query-builder/descending)|","permissionScopes":[{"name":"Manage Restaurants - all permissions","scopeId":"SCOPE.RESTAURANTS.MEGA-SCOPES"}],"isAdminMethod":false},{"name":"updateOperation","fqn":"updateOperation","slug":"update-operation","isDeprecated":false,"isInternal":false,"actionErrors":[],"isDeveloperPreview":true,"maturity":"GA","requiredProperties":["_id","operation","operation.revision"],"permissions":["Manage Restaurants - all permissions"],"permissionsScopesIds":["SCOPE.RESTAURANTS.MEGA-SCOPES"],"applicableIdentities":["APP"],"adminMethod":true,"returnType":{"kind":"PROMISE","argumentType":{"kind":"REFERENCE","name":"Operation","referenceFqn":"Operation"},"description":"Updated operation."},"examples":[{"title":"updateOperation example for dashboard page code","content":"import { operations } from 'wix-restaurants.v2';\n\nasync function updateOperation(id, operation, options) {\n try {\n const result = await operations.updateOperation(id, operation, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n}\n"},{"title":"updateOperation example for exporting from backend code","content":"import { operations } from 'wix-restaurants.v2';\nimport { webMethod, Permissions } from 'wix-web-module';\nimport { elevate } from 'wix-auth';\n\nconst elevatedUpdateOperation = elevate(operations.updateOperation);\n\nexport const updateOperation = webMethod(\n Permissions.Anyone,\n async (id, operation, options) => {\n try {\n const result = await elevatedUpdateOperation(id, operation, options);\n return result;\n } catch (error) {\n console.error(error);\n // Handle the error\n }\n }\n);\n"}],"actionParams":[{"name":"_id","slug":"id","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"PRIMITIVE","name":"string"},"description":"Operation ID."},{"name":"operation","slug":"operation","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateOperation","referenceFqn":"UpdateOperation"}},{"name":"options","slug":"options","isDeprecated":false,"isInternal":false,"maturity":"GA","type":{"kind":"REFERENCE","name":"UpdateOperationOptions","referenceFqn":"UpdateOperationOptions"}}],"description":"Updates an operation.\n\nIf you update part of the `orderScheduling` property, the whole object is overwritten,\nso you must include the entire object unless you are not updating `orderScheduling` at all.
\n\nEach time the operation is updated,\n`revision` increments by 1.\nThe current `revision` must be passed when updating the operation.\nThis ensures you're working with the latest operation\nand prevents unintended overwrites."}],"webhooks":[],"articles":[{"content":"---\ntitle: Introduction\n---\n\n# Introduction\n\nThe Operations API allows you to create and manage operations at restaurants.\nAn operation refers to different services a restaurant may offer.\nFor example, a restaurant may offer a takeaway operation and a catering operation, where each one would work with different time frames, availabilities, and fees.\n\nWith the Operations API, you can:\n\n* Create operations.\n* Retrieve and query existing operations.\n* Update existing operations.\n\n## Before you begin\n\nIt’s important to note the following points before starting to code:\n\n* You must install the Wix Restaurants Orders (New) app.\n\nTo use the Operations API, import `{ operations }` from wix-restaurants.v2:\n\n```js\nimport { operations } from 'wix-restaurants.v2';\n```\n\n## Terminology\n\n* **Operation**: Restaurant service that includes various aspects of its online ordering.\n* **Scheduling**: Time-related aspects of order placement.\n* **Fulfillment methods**: Ways in which a restaurant can provide orders to its customers. See [Fulfillment Methods](https://dev.wix.com/docs/velo/api-reference/wix-restaurants-v2/fulfillment-methods/introduction).\n* **Service fees**: A rule defines the fee that is applied when specific conditions (also defined by the rule) are met. You can use a rule to apply a service fee to a restaurant order. See [Service Fees](https://dev.wix.com/docs/velo/api-reference/wix-restaurants-v2/service-fees/introduction).\n","displayName":"Introduction","slugifyName":"introduction"}],"builderTypes":[{"kind":"REFERENCE","name":"OperationsQueryBuilder","referenceFqn":"OperationsQueryBuilder"},{"kind":"REFERENCE","name":"OperationsQueryResult","referenceFqn":"OperationsQueryResult"}],"properties":[],"namespaces":[]}},"reviewStatus":"UNKNOWN","isLocked":false,"metadata":{"packageVersion":"1.0.111"}}

getOperation( )