{"docs":{"name":"Bird Pickup \u0026 Delivery","info":"\n\u003cp\u003eAnother API description\u003c/p\u003e\n","copyright":null,"doc_url":"/api-docs/latest","api_url":"/","resources":{"4_settings":{"doc_url":"/api-docs/latest/4_settings","id":"4_settings","api_url":"/","name":"Settings","short_description":null,"full_description":"","version":"latest","formats":null,"metadata":null,"methods":[{"doc_url":"/api-docs/latest/4_settings/index","name":"index","apis":[{"api_url":"/api/v3/settings","http_method":"GET","short_description":"Get settings for a shop","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShopify domain of the store. Example: test-store.myshopify.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Settings information","is_array":false,"returns_object":[{"name":"pickup","full_name":"pickup","description":"\n\u003cp\u003ePickup configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"enabled","full_name":"pickup[enabled]","description":"\n\u003cp\u003eWhether pickup is enabled. Values: true or false only\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"delivery","full_name":"delivery","description":"\n\u003cp\u003eDelivery configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"enabled","full_name":"delivery[enabled]","description":"\n\u003cp\u003eWhether delivery is enabled. Values: true or false only\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"shipping","full_name":"shipping","description":"\n\u003cp\u003eShipping configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"enabled","full_name":"shipping[enabled]","description":"\n\u003cp\u003eWhether shipping is enabled. Values: true or false only\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"managed","full_name":"shipping[managed]","description":"\n\u003cp\u003eWhether shipping calendar is managed by app. Values: true or false only\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"slot_type","full_name":"shipping[slot_type]","description":"\n\u003cp\u003eSlot type for shipping calendar\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"rates","full_name":"rates","description":"\n\u003cp\u003eRates configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"enabled","full_name":"rates[enabled]","description":"\n\u003cp\u003eWhether rates are enabled. Values: true or false only\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pickup_pricing_policy","full_name":"rates[pickup_pricing_policy]","description":"\n\u003cp\u003eHow merchant configured pickup rates\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eGLOBAL\u003c/code\u003e, \u003ccode\u003eLOCATION_BASED\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delivery_pricing_policy","full_name":"rates[delivery_pricing_policy]","description":"\n\u003cp\u003eHow merchant configured delivery rates\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eGLOBAL\u003c/code\u003e, \u003ccode\u003eLOCATION_BASED\u003c/code\u003e, \u003ccode\u003eSHOPIFY\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shipping_pricing_policy","full_name":"rates[shipping_pricing_policy]","description":"\n\u003cp\u003eHow merchant configured shipping rates\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eGLOBAL\u003c/code\u003e, \u003ccode\u003eLOCATION_BASED\u003c/code\u003e, \u003ccode\u003eSHOPIFY\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShop configuration\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false,"params":[{"name":"timezone","full_name":"shop[timezone]","description":"\n\u003cp\u003eShop timezone\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locales","full_name":"shop[locales]","description":"\n\u003cp\u003eList of locales with their date and time formats\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"locale","full_name":"shop[locales][locale]","description":"\n\u003cp\u003eLocale code\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"date_format","full_name":"shop[locales][date_format]","description":"\n\u003cp\u003eDate format for this locale\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"time_format","full_name":"shop[locales][time_format]","description":"\n\u003cp\u003eTime format for this locale\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}]}],"additional_properties":false,"headers":[]},{"code":404,"description":"Shop not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"2_delivery":{"doc_url":"/api-docs/latest/2_delivery","id":"2_delivery","api_url":"/","name":"Delivery","short_description":null,"full_description":"","version":"latest","formats":null,"metadata":null,"methods":[{"doc_url":"/api-docs/latest/2_delivery/show","name":"show","apis":[{"api_url":"/api/v3/delivery/calendar","http_method":"POST","short_description":"Get delivery calendar availability","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShopify domain of the store. Example: test-store.myshopify.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date in YYYY-MM-DD format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date in YYYY-MM-DD format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopping_cart","full_name":"shopping_cart","description":"\n\u003cp\u003eArray of shopping cart items\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variant_id","full_name":"shopping_cart[variant_id]","description":"\n\u003cp\u003eVariant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"shopping_cart[quantity]","description":"\n\u003cp\u003eQuantity of the product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"shopping_cart[sku]","description":"\n\u003cp\u003eSKU (required if product overrides configured based on SKUs)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"shopping_cart[tags]","description":"\n\u003cp\u003eProduct tags (required if product overrides configured based on tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"shopping_cart[product_id]","description":"\n\u003cp\u003eProduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"zip_code","full_name":"zip_code","description":"\n\u003cp\u003ePostal/ZIP code. Provide either zip_code, address, or coordinates (only one required)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address","full_name":"address","description":"\n\u003cp\u003eFull address. Provide either zip_code, address, or coordinates (only one required)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"coordinates","full_name":"coordinates","description":"\n\u003cp\u003eCoordinates object. Provide either zip_code, address, or coordinates (only one required)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"latitude","full_name":"coordinates[latitude]","description":"\n\u003cp\u003eLatitude coordinate\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"longitude","full_name":"coordinates[longitude]","description":"\n\u003cp\u003eLongitude coordinate\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Float","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eBird Location ID. If provided, takes precedence over geographic params (zip_code, address, coordinates)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Delivery calendar availability","is_array":false,"returns_object":[{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eBird Location ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"deprecated":false},{"name":"calendar","full_name":"calendar","description":"\n\u003cp\u003eArray of available date and time slots\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false},{"name":"current_ts","full_name":"current_ts","description":"\n\u003cp\u003eCurrent timestamp in shop timezone (if cart_checkout_validation is enabled)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Shop or config not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Invalid parameters - must provide exactly one of: zip_code, address, or coordinates","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api-docs/latest/2_delivery/index","name":"index","apis":[{"api_url":"/api/v3/delivery/locations","http_method":"POST","short_description":"Get all delivery locations for a shop","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShopify domain of the store. Example: test-store.myshopify.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number for pagination (default: 1)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eItems per page (default: 50, max: 100)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopping_cart","full_name":"shopping_cart","description":"\n\u003cp\u003eArray of shopping cart items\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variant_id","full_name":"shopping_cart[variant_id]","description":"\n\u003cp\u003eVariant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"shopping_cart[quantity]","description":"\n\u003cp\u003eQuantity of the product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"shopping_cart[sku]","description":"\n\u003cp\u003eSKU (required if product overrides configured based on SKUs)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"shopping_cart[tags]","description":"\n\u003cp\u003eProduct tags (required if product overrides configured based on tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"shopping_cart[product_id]","description":"\n\u003cp\u003eProduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[{"code":200,"description":"Delivery locations information","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eArray of location objects\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eLocation ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"data[name]","description":"\n\u003cp\u003eLocation name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address1","full_name":"data[address1]","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address2","full_name":"data[address2]","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"city","full_name":"data[city]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zip","full_name":"data[zip]","description":"\n\u003cp\u003eZIP/Postal code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"province","full_name":"data[province]","description":"\n\u003cp\u003eProvince/State\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"data[country]","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"data[country_code]","description":"\n\u003cp\u003eCountry code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"province_code","full_name":"data[province_code]","description":"\n\u003cp\u003eProvince/State code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"delivery_enabled","full_name":"data[delivery_enabled]","description":"\n\u003cp\u003eWhether delivery is enabled for this location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"pagy","full_name":"pagy","description":"\n\u003cp\u003ePagination metadata\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Shop not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Invalid parameters","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"1_pickup":{"doc_url":"/api-docs/latest/1_pickup","id":"1_pickup","api_url":"/","name":"Pickup","short_description":null,"full_description":"","version":"latest","formats":null,"metadata":null,"methods":[{"doc_url":"/api-docs/latest/1_pickup/show","name":"show","apis":[{"api_url":"/api/v3/pickup/calendar","http_method":"POST","short_description":"Get pickup calendar availability for a location","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShopify domain of the store. Example: test-store.myshopify.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"location_id","full_name":"location_id","description":"\n\u003cp\u003eBird Location ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date in YYYY-MM-DD format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date in YYYY-MM-DD format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopping_cart","full_name":"shopping_cart","description":"\n\u003cp\u003eArray of shopping cart items\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variant_id","full_name":"shopping_cart[variant_id]","description":"\n\u003cp\u003eVariant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"shopping_cart[quantity]","description":"\n\u003cp\u003eQuantity of the product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"shopping_cart[sku]","description":"\n\u003cp\u003eSKU (required if product overrides configured based on SKUs)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"shopping_cart[tags]","description":"\n\u003cp\u003eProduct tags (required if product overrides configured based on tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"shopping_cart[product_id]","description":"\n\u003cp\u003eProduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[{"code":200,"description":"Pickup calendar availability","is_array":false,"returns_object":[{"name":"calendar","full_name":"calendar","description":"\n\u003cp\u003eArray of available date and time slots\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false},{"name":"current_ts","full_name":"current_ts","description":"\n\u003cp\u003eCurrent timestamp in shop timezone (if cart_checkout_validation is enabled)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Shop, location, or config not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Invalid parameters","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api-docs/latest/1_pickup/index","name":"index","apis":[{"api_url":"/api/v3/pickup/locations","http_method":"POST","short_description":"Get all pickup locations for a shop","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShopify domain of the store. Example: test-store.myshopify.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage number for pagination (default: 1)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"per_page","full_name":"per_page","description":"\n\u003cp\u003eItems per page (default: 50, max: 100)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopping_cart","full_name":"shopping_cart","description":"\n\u003cp\u003eArray of shopping cart items\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variant_id","full_name":"shopping_cart[variant_id]","description":"\n\u003cp\u003eVariant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"shopping_cart[quantity]","description":"\n\u003cp\u003eQuantity of the product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"shopping_cart[sku]","description":"\n\u003cp\u003eSKU (required if product overrides configured based on SKUs)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"shopping_cart[tags]","description":"\n\u003cp\u003eProduct tags (required if product overrides configured based on tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"shopping_cart[product_id]","description":"\n\u003cp\u003eProduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[{"code":200,"description":"Pickup locations information","is_array":false,"returns_object":[{"name":"data","full_name":"data","description":"\n\u003cp\u003eArray of location objects\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"deprecated":false,"params":[{"name":"id","full_name":"data[id]","description":"\n\u003cp\u003eLocation ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"name","full_name":"data[name]","description":"\n\u003cp\u003eLocation name\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address1","full_name":"data[address1]","description":"\n\u003cp\u003eAddress line 1\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"address2","full_name":"data[address2]","description":"\n\u003cp\u003eAddress line 2\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"city","full_name":"data[city]","description":"\n\u003cp\u003eCity\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"zip","full_name":"data[zip]","description":"\n\u003cp\u003eZIP/Postal code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"province","full_name":"data[province]","description":"\n\u003cp\u003eProvince/State\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country","full_name":"data[country]","description":"\n\u003cp\u003eCountry\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"country_code","full_name":"data[country_code]","description":"\n\u003cp\u003eCountry code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"province_code","full_name":"data[province_code]","description":"\n\u003cp\u003eProvince/State code\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"pickup_enabled","full_name":"data[pickup_enabled]","description":"\n\u003cp\u003eWhether pickup is enabled for this location\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e0\u003c/code\u003e.","expected_type":"boolean","metadata":null,"show":true,"validations":[],"deprecated":false}]},{"name":"pagy","full_name":"pagy","description":"\n\u003cp\u003ePagination metadata\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Shop not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Invalid parameters","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"3_shipping":{"doc_url":"/api-docs/latest/3_shipping","id":"3_shipping","api_url":"/","name":"Shipping","short_description":null,"full_description":"","version":"latest","formats":null,"metadata":null,"methods":[{"doc_url":"/api-docs/latest/3_shipping/show","name":"show","apis":[{"api_url":"/api/v3/shipping/calendar","http_method":"POST","short_description":"Get shipping calendar availability","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"shop","full_name":"shop","description":"\n\u003cp\u003eShopify domain of the store. Example: test-store.myshopify.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"start_date","full_name":"start_date","description":"\n\u003cp\u003eStart date in YYYY-MM-DD format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"end_date","full_name":"end_date","description":"\n\u003cp\u003eEnd date in YYYY-MM-DD format\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"shopping_cart","full_name":"shopping_cart","description":"\n\u003cp\u003eArray of shopping cart items\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"variant_id","full_name":"shopping_cart[variant_id]","description":"\n\u003cp\u003eVariant ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"quantity","full_name":"shopping_cart[quantity]","description":"\n\u003cp\u003eQuantity of the product\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"sku","full_name":"shopping_cart[sku]","description":"\n\u003cp\u003eSKU (required if product overrides configured based on SKUs)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"tags","full_name":"shopping_cart[tags]","description":"\n\u003cp\u003eProduct tags (required if product overrides configured based on tags)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"product_id","full_name":"shopping_cart[product_id]","description":"\n\u003cp\u003eProduct ID\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"returns":[{"code":200,"description":"Shipping calendar availability","is_array":false,"returns_object":[{"name":"calendar","full_name":"calendar","description":"\n\u003cp\u003eArray of available date and time slots\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"deprecated":false},{"name":"current_ts","full_name":"current_ts","description":"\n\u003cp\u003eCurrent timestamp in shop timezone (if cart_checkout_validation is enabled)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"deprecated":false}],"additional_properties":false,"headers":[]},{"code":404,"description":"Shop or config not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Invalid parameters","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}