# SpaceCodes

Space Code objects

## Get space code

> This operation returns a single space code by its identifier.\
> \
> \*\*Note:\*\* This operation needs \[Authentication]\(../guidelines/authentication.md) and supports the following JSON:API features:\
> \
> \- \[Relationships]\(../guidelines/relationships.md) - \`experienceConfiguration\`, \`experienceConfiguration.experienceConfigurationMenus\`, \`experienceConfiguration.experienceConfigurationMenus.menu\` using \`include\` query parameter.\
> \- \[Sparse fieldsets]\(../guidelines/sparse-fieldsets.md) - supports all fields of \`spaceCode\` with \`fields\` query parameter.<br>

```json
{"openapi":"3.1.0","info":{"title":"POS API","version":"1.0.0"},"tags":[{"name":"SpaceCodes","description":"Space Code objects"}],"servers":[{"url":"https://api.mews.com/pos","description":"Production"},{"url":"https://api.mews-demo.com/pos","description":"Staging"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"auth-scheme","description":"Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>"}},"parameters":{"fields_space_codes":{"in":"query","name":"fields[spaceCodes]","schema":{"type":"array","maxItems":8,"items":{"type":"string","enum":["url","designation","description","direction","spaceType","classification","capacity","experienceConfiguration"]}},"description":"Fields query parameter to allow the client to customize which fields should be returned.","explode":false,"required":false}},"headers":{"x_rate_limit_limit":{"description":"The number of allowed requests in the current period.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":1000}},"x_rate_limit_remaining":{"description":"The number of remaining requests in the current period.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":1000}},"x_rate_limit_reset":{"description":"The time at which the rate limit resets, in UTC epoch seconds.","schema":{"type":"integer","format":"int64","minimum":1633036800,"maximum":2147483647}},"access_control_allow_origin":{"description":"Specifies which origins are allowed to access the resource.","schema":{"type":"string","minLength":1,"maxLength":1024,"pattern":"^[A-Za-z /*]+$"}},"retry_after":{"description":"The time the client should wait before making a new request.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":3600}}},"schemas":{"space_codes":{"space_code_response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/space_codes/space_code"},"included":{"type":"array","description":"Included related resources as per JSON:API.","maxItems":1000,"items":{"oneOf":[{"$ref":"#/components/schemas/images/image"},{"$ref":"#/components/schemas/experience_configurations/experience_configuration"},{"$ref":"#/components/schemas/experience_configuration_menus/experience_configuration_menu"},{"$ref":"#/components/schemas/menus/menu"},{"$ref":"#/components/schemas/menu_sections/menu_section"},{"$ref":"#/components/schemas/menu_items/menu_item"},{"$ref":"#/components/schemas/products/product"},{"$ref":"#/components/schemas/product_variants/product_variant"},{"$ref":"#/components/schemas/product_bundles/product_bundle"}]}},"links":{"$ref":"#/components/schemas/links"}},"required":["data"]},"space_code":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the space code.","minLength":36,"maxLength":36},"type":{"type":"string","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"spaceCodes"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"url":{"type":["string","null"],"description":"URL associated with the space code.","format":"uri","maxLength":2048},"designation":{"type":["string","null"],"description":"Designation of the space code.","maxLength":255,"pattern":"^[^<>&]*$"},"description":{"type":["string","null"],"description":"Description of the space code.","maxLength":10000,"pattern":"^[^<>&]*$"},"direction":{"type":["string","null"],"description":"Direction information for the space code.","maxLength":255,"pattern":"^[^<>&]*$"},"spaceType":{"type":["string","null"],"description":"Type of the space code.","maxLength":255,"pattern":"^[^<>&]*$"},"classification":{"type":["string","null"],"description":"Classification of the space code.","maxLength":255,"pattern":"^[^<>&]*$"},"capacity":{"type":["string","null"],"description":"Capacity of the space.","maxLength":255,"pattern":"^[^<>&]*$"}}},"links":{"type":"object","description":"A [links object](https://jsonapi.org/format/#document-resource-object-links) containing links related to the resource.","properties":{"self":{"type":"string","format":"uri","description":"A link to the resource itself.","minLength":1,"maxLength":255}},"required":["self"]},"relationships":{"type":"object","description":"A [relationships object](https://jsonapi.org/format/#document-resource-object-relationships) describing relationships between the resource and other JSON:API resources.","properties":{"experienceConfiguration":{"type":"object","description":"Details of the experience configuration associated with the space code.","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"experienceConfigurations","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."}},"required":["id","type"]}},"required":["data"]}},"required":["experienceConfiguration"]}},"required":["id","type","attributes","links","relationships"]}},"images":{"image":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"images"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"width":{"type":"integer","description":"Image width in pixels.","format":"int32","minimum":1,"maximum":100000},"height":{"type":"integer","description":"Image height in pixels.","format":"int32","minimum":1,"maximum":100000},"mimeType":{"type":"string","description":"MIME type of the image.","maxLength":255,"pattern":"^[a-zA-Z0-9.+-]+/[a-zA-Z0-9.+-]+$"},"url":{"type":"string","description":"Fully qualified URL of the image asset.","format":"uri","maxLength":2048},"name":{"type":["string","null"],"description":"Original filename for display purposes (e.g. on editing pages).","minLength":1,"maxLength":255,"pattern":".*"}}}},"required":["id","type"]}},"experience_configurations":{"experience_configuration":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"experienceConfigurations"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"name":{"type":["string","null"],"description":"Name of the experience configuration.","maxLength":255,"pattern":"^[^<>&]*$"},"description":{"type":["string","null"],"description":"Description of the experience configuration.","maxLength":10000,"pattern":"^[^<>&]*$"},"serviceType":{"type":"string","description":"Type of service for the experience configuration.","enum":["order_and_pay","menu_browsing","pay_only"]},"minimumOrderValue":{"type":["string","null"],"description":"Minimum order value required.","minLength":0,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"serviceFee":{"type":["string","null"],"description":"Service fee amount.","minLength":0,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"serviceFeeType":{"type":["string","null"],"description":"Whether the service fee is a percentage or an absolute value.","enum":["percentage","absolute"]},"requiresStaffApproval":{"type":"boolean","description":"Whether staff approval is required."},"roomChargeEnabled":{"type":"boolean","description":"Whether room charge is enabled."},"tippingEnabled":{"type":"boolean","description":"Whether tipping is enabled."}}},"relationships":{"type":"object","description":"A [relationships object](https://jsonapi.org/format/#document-resource-object-relationships) describing relationships between the resource and other JSON:API resources.","properties":{"experienceConfigurationMenus":{"type":"object","description":"Details of the experience configuration menus associated with the experience configuration.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"experienceConfigurationMenus","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."}},"required":["id","type"]}}},"required":["data"]},"logo":{"type":"object","description":"Details of the logo image associated with the experience configuration.","properties":{"data":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"images","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."}},"required":["id","type"]}},"required":["data"]},"backgroundImage":{"type":"object","description":"Details of the background image associated with the experience configuration.","properties":{"data":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"images","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."}},"required":["id","type"]}},"required":["data"]}},"required":["experienceConfigurationMenus"]}},"required":["id","type","attributes","relationships"]}},"experience_configuration_menus":{"experience_configuration_menu":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the experience configuration menu.","minLength":36,"maxLength":36},"type":{"type":"string","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"experienceConfigurationMenus"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"availability":{"type":"array","description":"Array of availability periods, each containing days, start_time, and end_time.","maxItems":1000,"items":{"type":"object","properties":{"days":{"type":"array","description":"List of weekdays for this availability period.","maxItems":7,"items":{"type":"string","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]}},"startTime":{"type":["string","null"],"description":"Start time for this availability period (HH:MM format).","maxLength":5,"pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$"},"endTime":{"type":["string","null"],"description":"End time for this availability period (HH:MM format).","maxLength":5,"pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$"}},"required":["days"]}}}},"relationships":{"type":"object","description":"A [relationships object](https://jsonapi.org/format/#document-resource-object-relationships) describing relationships between the resource and other JSON:API resources.","properties":{"experienceConfiguration":{"type":"object","description":"Details of the experience configuration associated with this menu override.","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"experienceConfigurations","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."}},"required":["id","type"]}},"required":["data"]},"menu":{"type":"object","description":"Details of the menu associated with the experience configuration menu.","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"menus","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."}},"required":["id","type"]}},"required":["data"]}},"required":["experienceConfiguration","menu"]}},"required":["id","type","attributes","relationships"]}},"menus":{"menu":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"menus"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"name":{"type":"string","description":"Name of the menu.","minLength":1,"maxLength":255,"pattern":"^[^<>&]+$"},"status":{"type":"string","description":"Status of the menu.","enum":["active","inactive"]},"description":{"type":["string","null"],"description":"Description of the menu.","maxLength":10000,"pattern":"^[^<>&]*$"},"deleted":{"type":"boolean","description":"Indicates whether the Menu is deleted or not."},"createdAt":{"type":"string","description":"Menu created at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"updatedAt":{"type":"string","description":"Menu updated at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"availabilityDays":{"type":"array","description":"List of weekdays when the menu is available.","maxItems":7,"items":{"type":"string","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]}},"availabilityStartTime":{"type":["string","null"],"description":"Start time when the menu is available (HH:MM format).","maxLength":5,"pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$"},"availabilityEndTime":{"type":["string","null"],"description":"End time when the menu is available (HH:MM format).","maxLength":5,"pattern":"^([0-1][0-9]|2[0-3]):[0-5][0-9]$"}},"required":["name","status","createdAt","updatedAt"]},"relationships":{"type":"object","description":"A [relationships object](https://jsonapi.org/format/#document-resource-object-relationships) describing relationships between the resource and other JSON:API resources.","properties":{"menuSections":{"type":"object","description":"Details of the menu sections associated with the menu.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"menuSections"}},"required":["id","type"]}}},"required":["data"]},"outlets":{"type":"object","description":"Details of the outlets associated with the menu.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"outlets"}},"required":["id","type"]}}},"required":["data"]}}},"links":{"type":"object","description":"A [links object](https://jsonapi.org/format/#document-resource-object-links) containing links related to the resource.","properties":{"self":{"type":"string","format":"uri","description":"A link to the resource itself.","minLength":1,"maxLength":255}},"required":["self"]}},"required":["id","type","attributes","links"]}},"menu_sections":{"menu_section":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"menuSections","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"name":{"type":"string","description":"The name of the menu section.","minLength":1,"maxLength":255,"pattern":"^[^<>&]+$"},"position":{"type":"integer","description":"The position of the menu section.","format":"int32","minimum":1,"maximum":100},"createdAt":{"type":"string","description":"Menu section created at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"updatedAt":{"type":"string","description":"Menu section updated at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"}},"required":["name","position","createdAt","updatedAt"]}},"required":["id","type","attributes"]}},"menu_items":{"menu_item":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","const":"menuItems","title":"Resource type name","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships."},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"name":{"type":["string","null"],"description":"The name of the menu item.","minLength":1,"maxLength":255,"pattern":"^[^<>&]+$"},"itemType":{"type":"string","description":"Type of the menu item.","enum":["Product","ProductVariant","ProductBundle"]},"tileLabel":{"type":["string","null"],"description":"Short name of the menu item to be shown if image is not available.","minLength":1,"maxLength":255,"pattern":"^[^<>&]+$"},"tileColor":{"type":["string","null"],"description":"Color of menu item tile to be shown if image is not available.","minLength":1,"maxLength":255,"pattern":"^[^<>&]+$"},"imageUrl":{"type":["string","null"],"description":"URL of the menu item image.","minLength":1,"maxLength":255,"pattern":"^[^<>&]+$"},"position":{"type":"integer","description":"The position of the menu item.","format":"int32","minimum":1,"maximum":1000},"retailPriceInclTax":{"type":["string","null"],"description":"Retail price including tax.","minLength":0,"maxLength":10,"pattern":"^[0-9]+\\.[0-9]{1,2}$"},"retailPriceExclTax":{"type":["string","null"],"description":"Retail price excluding tax.","minLength":0,"maxLength":10,"pattern":"^[0-9]+\\.[0-9]{1,2}$"},"price":{"type":["string","null"],"maxLength":255,"description":"Customer set price of the menu item [deprecated].","pattern":"^(\\d+(\\.\\d+)?)(-\\d+(\\.\\d+)?)?$"},"priceRange":{"type":["object","null"],"description":"Price range of the menu item if it is not a fixed price","properties":{"min":{"type":"string","description":"Minimum retail price including tax.","minLength":0,"maxLength":6,"pattern":"^[0-9]+\\.[0-9]{1,2}$"},"max":{"type":"string","description":"Maximum retail price including tax.","minLength":0,"maxLength":6,"pattern":"^[0-9]+\\.[0-9]{1,2}$"}}},"hasVariants":{"type":["boolean","null"],"description":"Indicates if the menu item is a product with variants."},"createdAt":{"type":"string","description":"Menu section created at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"updatedAt":{"type":"string","description":"Menu section updated at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"}},"required":["itemType","retailPriceInclTax","position","createdAt","updatedAt"]},"relationships":{"type":"object","properties":{"item":{"type":"object","description":"The polymorphic item associated with this menu item. Can be a product, product variant, or product bundle.","properties":{"data":{"oneOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"products"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productVariants"}},"required":["id","type"]},{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productBundles"}},"required":["id","type"]},{"type":"null"}],"description":"Resource identifier object for the item (product, product variant, or product bundle)."}}},"taxes":{"type":"object","description":"Taxes that apply to this menu item.","properties":{"data":{"type":"array","maxItems":100,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID7) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"taxes"}},"required":["id","type"]},"description":"Array of tax resource identifier objects."}}}},"required":["taxes"]}},"required":["id","type","attributes"]}},"products":{"product":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"products"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"name":{"type":"string","description":"Name of the product.","minLength":0,"maxLength":255,"pattern":"^[A-Za-z0-9,-_. ]+$"},"description":{"type":["string","null"],"description":"Description of the product.","minLength":0,"maxLength":10000,"pattern":"^[A-Za-z0-9,-_. ]+$"},"sku":{"type":["string","null"],"description":"SKU of the product.","minLength":0,"maxLength":255,"pattern":"^[A-Za-z0-9,-_. ]+$"},"isAvailable":{"type":"boolean","description":"Whether the product is available.","default":true},"barcode":{"type":["string","null"],"description":"Barcode of the product.","minLength":0,"maxLength":255,"pattern":"^[A-Za-z0-9,-_. ]+$"},"status":{"type":"string","description":"Status of the product. Possible values are \"active\" and \"inactive\".","enum":["active","inactive"]},"tax":{"type":["string","null"],"description":"Tax of the product.","minLength":0,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"retailPriceExclTax":{"type":["string","null"],"description":"Product price excluding tax.","minLength":0,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"retailPriceInclTax":{"type":["string","null"],"description":"Product price including applicable taxes.","minLength":0,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"createdAt":{"type":"string","description":"Created at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"updatedAt":{"type":"string","description":"Updated at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"}},"required":["name","status","createdAt","updatedAt"]},"relationships":{"type":"object","description":"A [relationships object](https://jsonapi.org/format/#document-resource-object-relationships) describing relationships between the resource and other JSON:API resources.","properties":{"productType":{"type":"object","description":"Details of the product type associated with the product.","properties":{"data":{"type":["object","null"],"properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productTypes"}},"required":["id","type"]}}},"modifierSets":{"type":"object","description":"Details of the modifier sets associated with the product.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"modifierSets"}},"required":["id","type"]}}},"required":["data"]},"modifiers":{"type":"object","description":"Details of the modifiers associated with the product.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"modifiers"}},"required":["id","type"]}}},"required":["data"]},"productVariants":{"type":"object","description":"Details of the product variants associated with the product.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productVariants"}},"required":["id","type"]}}}},"taxes":{"type":"object","description":"Details of the taxes associated with the product.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"taxes"}},"required":["id","type"]}}},"required":["data"]},"dietaryRestrictions":{"type":"object","description":"Details of the dietary restrictions associated with the product.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"dietaryRestrictions"}},"required":["id","type"]}}},"required":["data"]},"allergens":{"type":"object","description":"Details of the allergens associated with the product.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"allergens"}},"required":["id","type"]}}},"required":["data"]}}}},"required":["id","type","attributes"]}},"product_variants":{"product_variant":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productVariants","maxLength":255},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"retailPriceExclTax":{"type":"string","description":"Product price excluding tax.","minLength":1,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"retailPriceInclTax":{"type":"string","description":"Product price including applicable taxes.","minLength":1,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"sku":{"type":"string","description":"SKU of the variant.","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9,-_. ]+$"},"selector":{"type":"object","description":"Arbitrary key/value JSON object for product variant selector.","additionalProperties":true},"barcode":{"type":"string","description":"Barcode of the variant.","minLength":1,"maxLength":255,"pattern":"^[A-Za-z0-9,-_. ]+$"},"createdAt":{"type":"string","description":"Created at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"updatedAt":{"type":"string","description":"Updated at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"}},"required":["retailPriceExclTax","retailPriceInclTax","sku","barcode","createdAt","updatedAt"]}},"required":["id","type","attributes"]}},"product_bundles":{"product_bundle":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productBundles"},"attributes":{"type":"object","description":"An [attributes object](https://jsonapi.org/format/#document-resource-object-attributes) representing some of the resource's data.","properties":{"name":{"type":"string","description":"Name of the product bundle.","minLength":0,"maxLength":255,"pattern":"^[A-Za-z0-9,-_. ]+$"},"description":{"type":["string","null"],"description":"Description of the product bundle.","minLength":0,"maxLength":10000,"pattern":"^[A-Za-z0-9,-_. ]+$"},"imageUrl":{"type":["string","null"],"description":"URL of the product bundle image.","minLength":0,"maxLength":1024,"format":"uri"},"priceRange":{"type":["object","null"],"description":"Price range of the bundle when not using fixed pricing. Contains minimum and maximum prices.","properties":{"min":{"type":"string","description":"Minimum price in the range.","maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"max":{"type":"string","description":"Maximum price in the range.","maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"}},"required":["min","max"]},"retailPriceInclTax":{"type":["string","null"],"description":"Retail price including tax of the bundle when using fixed pricing.","minLength":0,"maxLength":255,"pattern":"^[0-9]+\\.[0-9]{2}$"},"createdAt":{"type":"string","description":"Created at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"},"updatedAt":{"type":"string","description":"Updated at timestamp in RFC 3339 format.","maxLength":25,"format":"date-time"}},"required":["name","description","createdAt","updatedAt"]},"relationships":{"type":"object","description":"A [relationships object](https://jsonapi.org/format/#document-resource-object-relationships) describing relationships between the resource and other JSON:API resources.","properties":{"productBundleItems":{"type":"object","description":"Details of the product bundle items associated with the bundle.","properties":{"data":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","title":"Resource identifier","description":"Universally unique ID (UUID) that identifies the related object.","minLength":36,"maxLength":36},"type":{"type":"string","description":"The [type](https://jsonapi.org/format/#document-resource-object-identification) member is used to describe resource objects that share common attributes and relationships.","const":"productBundleItems"}},"required":["id","type"]}}},"required":["data"]}}}},"required":["id","type","attributes"]}},"links":{"type":"object","description":"A [links object](https://jsonapi.org/profiles/ethanresnick/cursor-pagination/#auto-id-links) describing cursor pagination links.","properties":{"prev":{"type":["string","null"],"format":"uri","maxLength":1024,"description":"The link to the previous page of results."},"next":{"type":["string","null"],"format":"uri","maxLength":1024,"description":"The link to the next page of results."}},"required":["next","prev"]},"error":{"type":"object","description":"A JSON:API error object.\n\nAdditional properties specific to the problem type may be present.    \n","properties":{"errors":{"type":"array","description":"An array of error details to accompany a problem details response.","maxItems":1000,"items":{"type":"object","description":"An object to provide explicit details on a problem towards an API consumer.","properties":{"id":{"type":"string","maxLength":16,"description":"A unique identifier for this particular occurrence of the problem.","pattern":"^[A-Za-z0-9_-]+$"},"status":{"type":"string","maxLength":3,"description":"The HTTP status code applicable to this problem, expressed as a string value.","pattern":"^[1-5][0-9]{2}$"},"code":{"type":"string","maxLength":50,"description":"An application-specific error code, expressed as a string value.","pattern":"^[A-Za-z0-9_-]+$"},"title":{"type":"string","description":"A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.","maxLength":256,"pattern":"^.{1,255}$"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem. Like title, this field's value can be localized.","maxLength":1024,"pattern":"^.{1,1023}$"},"source":{"type":"object","properties":{"pointer":{"type":"string","description":"A JSON Pointer to a specific request body property that is the source of error.","maxLength":1024,"pattern":"^$|^/([A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+$"},"parameter":{"type":"string","description":"A string indicating which URI query parameter caused the error.","maxLength":1024,"pattern":"^[A-Za-z0-9_]+$"},"header":{"type":"string","description":"The name of the header that is the source of error.","maxLength":1024,"pattern":"^[A-Za-z-]+$"}}},"meta":{"type":"object","description":"Additional information about the error.","additionalProperties":true}},"required":["title"]}}},"required":["errors"]}},"responses":{"bad_request":{"description":"Bad request.","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/x_rate_limit_limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/x_rate_limit_remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/x_rate_limit_reset"},"Access-Control-Allow-Origin":{"$ref":"#/components/headers/access_control_allow_origin"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","$ref":"#/components/schemas/error"}}}},"unauthorized":{"description":"Unauthorized.","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/x_rate_limit_limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/x_rate_limit_remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/x_rate_limit_reset"},"Access-Control-Allow-Origin":{"$ref":"#/components/headers/access_control_allow_origin"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","$ref":"#/components/schemas/error"}}}},"too_many_requests":{"description":"Too many requests.","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/x_rate_limit_limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/x_rate_limit_remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/x_rate_limit_reset"},"Retry-After":{"$ref":"#/components/headers/retry_after"},"Access-Control-Allow-Origin":{"$ref":"#/components/headers/access_control_allow_origin"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","$ref":"#/components/schemas/error"}}}},"internal_server_error":{"description":"Internal Server Error.","content":{"application/vnd.api+json":{"schema":{"type":"object","$ref":"#/components/schemas/error"}}}},"service_unavailable":{"description":"Service is unavailable.","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/x_rate_limit_limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/x_rate_limit_remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/x_rate_limit_reset"},"Access-Control-Allow-Origin":{"$ref":"#/components/headers/access_control_allow_origin"}},"content":{"application/vnd.api+json":{"schema":{"type":"object","$ref":"#/components/schemas/error"}}}}}},"paths":{"/v1/space-codes/{id}":{"get":{"operationId":"getSpaceCode","summary":"Get space code","description":"This operation returns a single space code by its identifier.\n\n**Note:** This operation needs [Authentication](../guidelines/authentication.md) and supports the following JSON:API features:\n\n- [Relationships](../guidelines/relationships.md) - `experienceConfiguration`, `experienceConfiguration.experienceConfigurationMenus`, `experienceConfiguration.experienceConfigurationMenus.menu` using `include` query parameter.\n- [Sparse fieldsets](../guidelines/sparse-fieldsets.md) - supports all fields of `spaceCode` with `fields` query parameter.\n","parameters":[{"$ref":"#/components/parameters/fields_space_codes"},{"in":"query","name":"include","schema":{"type":"array","maxItems":8,"items":{"type":"string","enum":["experienceConfiguration","experienceConfiguration.experienceConfigurationMenus","experienceConfiguration.experienceConfigurationMenus.menu","experienceConfiguration.logo","experienceConfiguration.backgroundImage","experienceConfiguration.experienceConfigurationMenus.menu.menuSections","experienceConfiguration.experienceConfigurationMenus.menu.menuSections.menuItems","experienceConfiguration.experienceConfigurationMenus.menu.menuSections.menuItems.item"]}},"description":"include query parameter to allow the client to customize which related resource should be returned. Supports nested includes using dot notation.","required":false},{"in":"path","name":"id","description":"The space code identifier.","required":true,"schema":{"type":"string","format":"uuid","title":"Space code identifier","description":"Universally unique ID (UUID) that identifies the space code.","minLength":36,"maxLength":36}}],"tags":["SpaceCodes"],"responses":{"200":{"description":"Successful response with space code data in JSON:API format.","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/x_rate_limit_limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/x_rate_limit_remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/x_rate_limit_reset"},"Access-Control-Allow-Origin":{"$ref":"#/components/headers/access_control_allow_origin"}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/space_codes/space_code_response"}}}},"400":{"$ref":"#/components/responses/bad_request"},"401":{"$ref":"#/components/responses/unauthorized"},"404":{"description":"Space code not found.","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/x_rate_limit_limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/x_rate_limit_remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/x_rate_limit_reset"},"Access-Control-Allow-Origin":{"$ref":"#/components/headers/access_control_allow_origin"}},"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/error"}}}},"429":{"$ref":"#/components/responses/too_many_requests"},"500":{"$ref":"#/components/responses/internal_server_error"},"503":{"$ref":"#/components/responses/service_unavailable"}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.mews.com/pos-api/operations/spacecodes.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
