{"openapi":"3.1.0","info":{"description":"Bagisto Shop API - Customer-facing operations for products, cart, orders, and checkout.","contact":[],"license":[],"version":"1.0.0"},"servers":[{"url":"/api/shop","description":"Shop API - Customer-facing endpoints"}],"paths":{"/add-product-in-cart":{"post":{"tags":["AddProductInCart"],"summary":"Add product to cart","description":"Add a product to the shopping cart with quantity and optional product options.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Product to add to cart","content":{"application/json":{"schema":{"type":"object","properties":{"productId":{"type":"integer","example":1,"description":"Product ID"},"quantity":{"type":"integer","example":1,"description":"Quantity"},"options":{"type":"object","example":{"size":"M","color":"blue"},"description":"Product options (optional)"},"bundleOptions":{"type":"string","example":"{\"1\":[1],\"2\":[2],\"3\":[3],\"4\":[4]}","description":"Bundle options JSON (optional)"},"bundleOptionQty":{"type":"string","example":"{\"1\":1,\"2\":2,\"3\":1,\"4\":2}","description":"Bundle option quantities JSON (optional)"},"groupedQty":{"type":"string","example":"{\"101\":2,\"102\":1}","description":"Grouped product associated quantities JSON (optional, required for grouped products)"},"booking":{"type":"string","example":"{\"type\":\"appointment\",\"date\":\"2026-03-12\",\"slot\":\"10:00 AM - 11:00 AM\"}","description":"Booking options JSON string (optional, required for booking products)"},"specialNote":{"type":"string","example":"This is a special note","description":"Special request / note (optional; merged into booking.note)"}}},"examples":{"simple_product":{"summary":"Add Simple Product","description":"Add a simple product to cart","value":{"productId":1,"quantity":1}},"product_with_options":{"summary":"Add Product with Options","description":"Add a product with size and color options","value":{"productId":2,"quantity":2,"options":{"size":"M","color":"blue"}}},"bundle_product":{"summary":"Add Bundle Product","description":"Add a bundle product with selected bundle options","value":{"productId":6,"quantity":1,"bundleOptions":"{\"1\":[1],\"2\":[2],\"3\":[3],\"4\":[4]}","bundleOptionQty":"{\"1\":1,\"2\":2,\"3\":1,\"4\":2}"}},"grouped_product":{"summary":"Add Grouped Product","description":"Add a grouped product by specifying quantities for associated simple products","value":{"productId":5,"quantity":1,"groupedQty":"{\"101\":2,\"102\":1}"}},"booking_product":{"summary":"Add Booking Product","description":"Add a booking product (appointment/default/table/rental/event) to cart by passing booking options as JSON string","value":{"productId":2555,"quantity":1,"booking":"{\"type\":\"appointment\",\"date\":\"2026-03-12\",\"slot\":\"10:00 AM - 11:00 AM\"}"}},"event_booking_product":{"summary":"Add Event Booking","description":"Add an event booking product by selecting one or more ticket quantities (at least one ticket qty > 0 required)","value":{"productId":2564,"quantity":1,"booking":"{\"type\":\"event\",\"qty\":{\"501\":1,\"502\":2}}"}},"table_booking_product_with_note":{"summary":"Add Table Booking (with note)","description":"Add a table booking product and send special request/note separately","value":{"productId":2563,"quantity":1,"booking":"{\"type\":\"table\",\"date\":\"2026-03-25\",\"slot\":\"12:00 PM - 12:45 PM\"}","specialNote":"This is a special note"}}}}},"required":true},"responses":{"201":{"description":"AddProductInCart resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"addProduct"}},"/apply-coupon":{"post":{"tags":["ApplyCoupon"],"summary":"Apply coupon to cart","description":"Apply a discount coupon code to the shopping cart.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Coupon code to apply","content":{"application/json":{"schema":{"type":"object","properties":{"couponCode":{"type":"string","example":"DISCOUNT10","description":"Coupon code"}}},"examples":{"apply_coupon":{"summary":"Apply Coupon","description":"Apply a discount coupon code","value":{"couponCode":"DISCOUNT10"}}}}},"required":true},"responses":{"201":{"description":"ApplyCoupon resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"apply"}},"/attributes":{"get":{"tags":["Attribute"],"summary":"Retrieves the collection of Attribute resources.","description":"Retrieves the collection of Attribute resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Attribute collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopattributes_get_collection"}},"/attributes/{id}":{"get":{"tags":["Attribute"],"summary":"Retrieves a Attribute resource.","description":"Retrieves a Attribute resource.","parameters":[{"name":"id","in":"path","description":"Attribute identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Attribute resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopattributes_id_get"}},"/attribute_translations/{id}":{"get":{"tags":["AttributeTranslation"],"summary":"Retrieves a AttributeTranslation resource.","description":"Retrieves a AttributeTranslation resource.","parameters":[{"name":"id","in":"path","description":"AttributeTranslation identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"AttributeTranslation resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apiattribute_translations_id_get"},"patch":{"tags":["AttributeTranslation"],"summary":"Updates the AttributeTranslation resource.","description":"Updates the AttributeTranslation resource.","parameters":[{"name":"id","in":"path","description":"AttributeTranslation identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The updated AttributeTranslation resource","content":{"application/merge-patch+json":{"schema":[]}},"required":true},"responses":{"200":{"description":"AttributeTranslation resource updated","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"},"404":{"description":"Not found"}},"operationId":"api_apiattribute_translations_id_patch"},"delete":{"tags":["AttributeTranslation"],"summary":"Removes the AttributeTranslation resource.","description":"Removes the AttributeTranslation resource.","parameters":[{"name":"id","in":"path","description":"AttributeTranslation identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"204":{"description":"AttributeTranslation resource deleted"},"404":{"description":"Not found"}},"operationId":"api_apiattribute_translations_id_delete"}},"/attribute_translations":{"get":{"tags":["AttributeTranslation"],"summary":"Retrieves the collection of AttributeTranslation resources.","description":"Retrieves the collection of AttributeTranslation resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"AttributeTranslation collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apiattribute_translations_get_collection"},"post":{"tags":["AttributeTranslation"],"summary":"Creates a AttributeTranslation resource.","description":"Creates a AttributeTranslation resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new AttributeTranslation resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"AttributeTranslation resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apiattribute_translations_post"}},"/cancel-order":{"post":{"tags":["CancelOrder"],"summary":"Creates a CancelOrder resource.","description":"Creates a CancelOrder resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new CancelOrder resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"CancelOrder resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopcancel-order_post"}},"/cart-tokens":{"get":{"tags":["CartToken"],"summary":"Retrieves the collection of CartToken resources.","description":"Retrieves the collection of CartToken resources.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CartToken collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcart-tokens_get_collection"}},"/cart-tokens/{id}":{"get":{"tags":["CartToken"],"summary":"Retrieves a CartToken resource.","description":"Retrieves a CartToken resource.","parameters":[{"name":"id","in":"path","description":"CartToken identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CartToken resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcart-tokens_id_get"}},"/categories/{id}":{"get":{"tags":["Category"],"summary":"Retrieves a Category resource.","description":"Retrieves a Category resource.","parameters":[{"name":"id","in":"path","description":"Category identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Category resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcategories_id_get"}},"/categories":{"get":{"tags":["Category"],"summary":"Retrieves the collection of Category resources.","description":"Retrieves the collection of Category resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Category collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcategories_get_collection"}},"/category-trees":{"get":{"tags":["CategoryTree"],"summary":"Retrieves the collection of CategoryTree resources.","description":"Retrieves the collection of CategoryTree resources.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CategoryTree collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcategory-trees_get_collection"}},"/channels/{id}":{"get":{"tags":["Channel"],"summary":"Retrieves a Channel resource.","description":"Retrieves a Channel resource.","parameters":[{"name":"id","in":"path","description":"Channel identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Channel resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopchannels_id_get"}},"/channels":{"get":{"tags":["Channel"],"summary":"Retrieves the collection of Channel resources.","description":"Retrieves the collection of Channel resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Channel collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopchannels_get_collection"}},"/checkout-addresses/{id}":{"get":{"tags":["CheckoutAddress"],"summary":"Retrieves a CheckoutAddress resource.","description":"Retrieves a CheckoutAddress resource.","parameters":[{"name":"id","in":"path","description":"CheckoutAddress identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CheckoutAddress resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcheckout-addresses_id_get"}},"/checkout-addresses":{"get":{"tags":["CheckoutAddress"],"summary":"Retrieves the collection of CheckoutAddress resources.","description":"Retrieves the collection of CheckoutAddress resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CheckoutAddress collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcheckout-addresses_get_collection"}},"/checkout-orders/{id}":{"get":{"tags":["CheckoutOrder"],"summary":"Retrieves a CheckoutOrder resource.","description":"Retrieves a CheckoutOrder resource.","parameters":[{"name":"id","in":"path","description":"CheckoutOrder identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CheckoutOrder resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcheckout-orders_id_get"}},"/checkout-orders":{"get":{"tags":["CheckoutOrder"],"summary":"Retrieves the collection of CheckoutOrder resources.","description":"Retrieves the collection of CheckoutOrder resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CheckoutOrder collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcheckout-orders_get_collection"}},"/checkout-shipping-methods/{id}":{"get":{"tags":["CheckoutShippingMethod"],"summary":"Retrieves a CheckoutShippingMethod resource.","description":"Retrieves a CheckoutShippingMethod resource.","parameters":[{"name":"id","in":"path","description":"CheckoutShippingMethod identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CheckoutShippingMethod resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcheckout-shipping-methods_id_get"}},"/checkout-shipping-methods":{"get":{"tags":["CheckoutShippingMethod"],"summary":"Retrieves the collection of CheckoutShippingMethod resources.","description":"Retrieves the collection of CheckoutShippingMethod resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CheckoutShippingMethod collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcheckout-shipping-methods_get_collection"}},"/compare_items/{id}":{"get":{"tags":["CompareItem"],"summary":"Retrieves a CompareItem resource.","description":"Retrieves a CompareItem resource.","parameters":[{"name":"id","in":"path","description":"CompareItem identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CompareItem resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcompare_items_id_get"},"delete":{"tags":["CompareItem"],"summary":"Removes the CompareItem resource.","description":"Removes the CompareItem resource.","parameters":[{"name":"id","in":"path","description":"CompareItem identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"204":{"description":"CompareItem resource deleted"},"404":{"description":"Not found"}},"operationId":"api_apishopcompare_items_id_delete"}},"/compare_items":{"get":{"tags":["CompareItem"],"summary":"Retrieves the collection of CompareItem resources.","description":"Retrieves the collection of CompareItem resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CompareItem collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcompare_items_get_collection"},"post":{"tags":["CompareItem"],"summary":"Creates a CompareItem resource.","description":"Creates a CompareItem resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new CompareItem resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"CompareItem resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopcompare_items_post"}},"/contact-us":{"post":{"tags":["ContactUs"],"summary":"Creates a ContactUs resource.","description":"Creates a ContactUs resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new ContactUs resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"ContactUs resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"submitContactUs"}},"/countries":{"get":{"tags":["Country"],"summary":"Retrieves the collection of Country resources.","description":"Retrieves the collection of Country resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Country collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcountries_get_collection"}},"/countries/{id}":{"get":{"tags":["Country"],"summary":"Retrieves a Country resource.","description":"Retrieves a Country resource.","parameters":[{"name":"id","in":"path","description":"Country identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Country resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcountries_id_get"}},"/countries/{country_id}/states":{"get":{"tags":["CountryState"],"summary":"Retrieves the collection of CountryState resources.","description":"Retrieves the collection of CountryState resources.","parameters":[{"name":"country_id","in":"path","description":"CountryState identifier","required":true,"schema":{"type":"string"}},{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CountryState collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcountries_country_idstates_get_collection"}},"/countries/{country_id}/states/{id}":{"get":{"tags":["CountryState"],"summary":"Retrieves a CountryState resource.","description":"Retrieves a CountryState resource.","parameters":[{"name":"country_id","in":"path","description":"CountryState identifier","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"CountryState identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CountryState resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcountries_country_idstates_id_get"}},"/country-states":{"get":{"tags":["CountryState"],"summary":"Retrieves the collection of CountryState resources.","description":"Retrieves the collection of CountryState resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CountryState collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcountry-states_get_collection"}},"/country-states/{id}":{"get":{"tags":["CountryState"],"summary":"Retrieves a CountryState resource.","description":"Retrieves a CountryState resource.","parameters":[{"name":"id","in":"path","description":"CountryState identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CountryState resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcountry-states_id_get"}},"/currencies/{id}":{"get":{"tags":["Currency"],"summary":"Retrieves a Currency resource.","description":"Retrieves a Currency resource.","parameters":[{"name":"id","in":"path","description":"Currency identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Currency resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcurrencies_id_get"}},"/currencies":{"get":{"tags":["Currency"],"summary":"Retrieves the collection of Currency resources.","description":"Retrieves the collection of Currency resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Currency collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcurrencies_get_collection"}},"/customers":{"get":{"tags":["Customer"],"summary":"Retrieves the collection of Customer resources.","description":"Retrieves the collection of Customer resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Customer collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomers_get_collection"},"post":{"tags":["Customer"],"summary":"Create a new customer","description":"Register a new customer account","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Customer registration data","content":{"application/json":{"schema":{"type":"object","required":["firstName","lastName","email","password","confirmPassword"],"properties":{"firstName":{"type":"string","example":"John"},"lastName":{"type":"string","example":"Doe"},"email":{"type":"string","format":"email","example":"john@example.com"},"password":{"type":"string","format":"password","example":"Password123!"},"confirmPassword":{"type":"string","format":"password","example":"Password123!"},"phone":{"type":"string","example":"1234567890"},"gender":{"type":"string","enum":["Male","Female","Other"]},"dateOfBirth":{"type":"string","format":"date","example":"1990-01-15"},"subscribedToNewsLetter":{"type":"boolean","example":true},"deviceToken":{"type":"string","example":"your-fcm-device-token"}}}}}},"responses":{"201":{"description":"Customer resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopcustomers_post"}},"/customers/{id}":{"get":{"tags":["Customer"],"summary":"Retrieves a Customer resource.","description":"Retrieves a Customer resource.","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Customer resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomers_id_get"},"put":{"tags":["Customer"],"summary":"Replaces the Customer resource.","description":"Replaces the Customer resource.","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The updated Customer resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"200":{"description":"Customer resource updated","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"},"404":{"description":"Not found"}},"operationId":"api_apishopcustomers_id_put"},"delete":{"tags":["Customer"],"summary":"Removes the Customer resource.","description":"Removes the Customer resource.","parameters":[{"name":"id","in":"path","description":"Customer identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"204":{"description":"Customer resource deleted"},"404":{"description":"Not found"}},"operationId":"api_apishopcustomers_id_delete"}},"/customer-addresses/{id}":{"get":{"tags":["CustomerAddress"],"summary":"Retrieves a CustomerAddress resource.","description":"Retrieves a CustomerAddress resource.","parameters":[{"name":"id","in":"path","description":"CustomerAddress identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerAddress resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-addresses_id_get"}},"/customer-addresses":{"get":{"tags":["GetCustomerAddresses"],"summary":"Retrieves the collection of GetCustomerAddresses resources.","description":"Retrieves the collection of GetCustomerAddresses resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"GetCustomerAddresses collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-addresses_get_collection"}},"/customer-address-add-updates/{id}":{"get":{"tags":["AddUpdateCustomerAddress"],"summary":"Retrieves a AddUpdateCustomerAddress resource.","description":"Retrieves a AddUpdateCustomerAddress resource.","parameters":[{"name":"id","in":"path","description":"AddUpdateCustomerAddress identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"AddUpdateCustomerAddress resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-address-add-updates_id_get"}},"/customer-address-add-updates":{"get":{"tags":["AddUpdateCustomerAddress"],"summary":"Retrieves the collection of AddUpdateCustomerAddress resources.","description":"Retrieves the collection of AddUpdateCustomerAddress resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"AddUpdateCustomerAddress collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-address-add-updates_get_collection"}},"/customer-address-deletes/{id}":{"delete":{"tags":["DeleteCustomerAddress"],"summary":"Removes the DeleteCustomerAddress resource.","description":"Removes the DeleteCustomerAddress resource.","parameters":[{"name":"id","in":"path","description":"DeleteCustomerAddress identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"204":{"description":"DeleteCustomerAddress resource deleted"},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-address-deletes_id_delete"}},"/customer-address-gets/{id}":{"get":{"tags":["GetCustomerAddress"],"summary":"Retrieves a GetCustomerAddress resource.","description":"Retrieves a GetCustomerAddress resource.","parameters":[{"name":"id","in":"path","description":"GetCustomerAddress identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"GetCustomerAddress resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-address-gets_id_get"}},"/customer-address-gets":{"get":{"tags":["GetCustomerAddress"],"summary":"Retrieves the collection of GetCustomerAddress resources.","description":"Retrieves the collection of GetCustomerAddress resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"GetCustomerAddress collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-address-gets_get_collection"}},"/customer-address-tokens/{id}":{"get":{"tags":["CustomerAddressToken"],"summary":"Retrieves a CustomerAddressToken resource.","description":"Retrieves a CustomerAddressToken resource.","parameters":[{"name":"id","in":"path","description":"CustomerAddressToken identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerAddressToken resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-address-tokens_id_get"}},"/customer-address-tokens":{"get":{"tags":["CustomerAddressToken"],"summary":"Retrieves the collection of CustomerAddressToken resources.","description":"Retrieves the collection of CustomerAddressToken resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerAddressToken collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-address-tokens_get_collection"}},"/customer-downloadable-products":{"get":{"tags":["CustomerDownloadableProduct"],"summary":"Retrieves the collection of CustomerDownloadableProduct resources.","description":"Retrieves the collection of CustomerDownloadableProduct resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerDownloadableProduct collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-downloadable-products_get_collection"}},"/customer-downloadable-products/{id}":{"get":{"tags":["CustomerDownloadableProduct"],"summary":"Retrieves a CustomerDownloadableProduct resource.","description":"Retrieves a CustomerDownloadableProduct resource.","parameters":[{"name":"id","in":"path","description":"CustomerDownloadableProduct identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerDownloadableProduct resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-downloadable-products_id_get"}},"/customer-invoices":{"get":{"tags":["CustomerInvoice"],"summary":"Retrieves the collection of CustomerInvoice resources.","description":"Retrieves the collection of CustomerInvoice resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerInvoice collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-invoices_get_collection"}},"/customer-invoices/{id}":{"get":{"tags":["CustomerInvoice"],"summary":"Retrieves a CustomerInvoice resource.","description":"Retrieves a CustomerInvoice resource.","parameters":[{"name":"id","in":"path","description":"CustomerInvoice identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerInvoice resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-invoices_id_get"}},"/customer/login":{"post":{"tags":["CustomerLogin"],"summary":"Creates a CustomerLogin resource.","description":"Creates a CustomerLogin resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new CustomerLogin resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"CustomerLogin resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopcustomerlogin_post"}},"/customer-orders":{"get":{"tags":["CustomerOrder"],"summary":"Retrieves the collection of CustomerOrder resources.","description":"Retrieves the collection of CustomerOrder resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerOrder collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-orders_get_collection"}},"/customer-orders/{id}":{"get":{"tags":["CustomerOrder"],"summary":"Retrieves a CustomerOrder resource.","description":"Retrieves a CustomerOrder resource.","parameters":[{"name":"id","in":"path","description":"CustomerOrder identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerOrder resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-orders_id_get"}},"/customer-order-shipments":{"get":{"tags":["CustomerOrderShipment"],"summary":"Retrieves the collection of CustomerOrderShipment resources.","description":"Retrieves the collection of CustomerOrderShipment resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerOrderShipment collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-order-shipments_get_collection"}},"/customer-order-shipments/{id}":{"get":{"tags":["CustomerOrderShipment"],"summary":"Retrieves a CustomerOrderShipment resource.","description":"Retrieves a CustomerOrderShipment resource.","parameters":[{"name":"id","in":"path","description":"CustomerOrderShipment identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerOrderShipment resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-order-shipments_id_get"}},"/customer_order_shipment_items/{id}":{"get":{"tags":["CustomerOrderShipmentItem"],"summary":"Retrieves a CustomerOrderShipmentItem resource.","description":"Retrieves a CustomerOrderShipmentItem resource.","parameters":[{"name":"id","in":"path","description":"CustomerOrderShipmentItem identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerOrderShipmentItem resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apicustomer_order_shipment_items_id_get"}},"/customer_order_shipment_items":{"get":{"tags":["CustomerOrderShipmentItem"],"summary":"Retrieves the collection of CustomerOrderShipmentItem resources.","description":"Retrieves the collection of CustomerOrderShipmentItem resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerOrderShipmentItem collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apicustomer_order_shipment_items_get_collection"}},"/customer-profiles/{id}":{"get":{"tags":["CustomerProfile"],"summary":"Retrieves a CustomerProfile resource.","description":"Retrieves a CustomerProfile resource.","parameters":[{"name":"id","in":"path","description":"CustomerProfile identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerProfile resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-profiles_id_get"}},"/customer-profiles":{"get":{"tags":["CustomerProfile"],"summary":"Retrieves the collection of CustomerProfile resources.","description":"Retrieves the collection of CustomerProfile resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerProfile collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-profiles_get_collection"}},"/customer-profile-deletes/{id}":{"post":{"tags":["CustomerProfileDelete"],"summary":"Creates a CustomerProfileDelete resource.","description":"Creates a CustomerProfileDelete resource.","parameters":[{"name":"id","in":"path","description":"CustomerProfileDelete identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new CustomerProfileDelete resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"CustomerProfileDelete resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopcustomer-profile-deletes_id_post"}},"/customer-profile-updates/{id}":{"put":{"tags":["CustomerProfileUpdate"],"summary":"Replaces the CustomerProfileUpdate resource.","description":"Replaces the CustomerProfileUpdate resource.","parameters":[{"name":"id","in":"path","description":"CustomerProfileUpdate identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The updated CustomerProfileUpdate resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"200":{"description":"CustomerProfileUpdate resource updated","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-profile-updates_id_put"}},"/customer-reviews":{"get":{"tags":["CustomerReview"],"summary":"Retrieves the collection of CustomerReview resources.","description":"Retrieves the collection of CustomerReview resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerReview collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopcustomer-reviews_get_collection"}},"/customer-reviews/{id}":{"get":{"tags":["CustomerReview"],"summary":"Retrieves a CustomerReview resource.","description":"Retrieves a CustomerReview resource.","parameters":[{"name":"id","in":"path","description":"CustomerReview identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CustomerReview resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopcustomer-reviews_id_get"}},"/delete-all-compare-items":{"post":{"tags":["DeleteAllCompareItems"],"summary":"Creates a DeleteAllCompareItems resource.","description":"Creates a DeleteAllCompareItems resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new DeleteAllCompareItems resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"DeleteAllCompareItems resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopdelete-all-compare-items_post"}},"/delete-all-wishlists":{"post":{"tags":["DeleteAllWishlists"],"summary":"Creates a DeleteAllWishlists resource.","description":"Creates a DeleteAllWishlists resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new DeleteAllWishlists resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"DeleteAllWishlists resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopdelete-all-wishlists_post"}},"/downloadable-product-download-links/{id}":{"get":{"tags":["DownloadableProductDownloadLink"],"summary":"Retrieves a DownloadableProductDownloadLink resource.","description":"Retrieves a DownloadableProductDownloadLink resource.","parameters":[{"name":"id","in":"path","description":"DownloadableProductDownloadLink identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"DownloadableProductDownloadLink resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopdownloadable-product-download-links_id_get"}},"/downloadable-product-download-links":{"get":{"tags":["DownloadableProductDownloadLink"],"summary":"Retrieves the collection of DownloadableProductDownloadLink resources.","description":"Retrieves the collection of DownloadableProductDownloadLink resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"DownloadableProductDownloadLink collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopdownloadable-product-download-links_get_collection"}},"/estimate-shippings/{id}":{"get":{"tags":["EstimateShipping"],"summary":"Retrieves a EstimateShipping resource.","description":"Retrieves a EstimateShipping resource.","parameters":[{"name":"id","in":"path","description":"EstimateShipping identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"EstimateShipping resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopestimate-shippings_id_get"}},"/estimate-shippings":{"get":{"tags":["EstimateShipping"],"summary":"Retrieves the collection of EstimateShipping resources.","description":"Retrieves the collection of EstimateShipping resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"EstimateShipping collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopestimate-shippings_get_collection"}},"/filters/attributes":{"get":{"tags":["CategoryAttributeFilter"],"summary":"Retrieves the collection of CategoryAttributeFilter resources.","description":"Retrieves the collection of CategoryAttributeFilter resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"CategoryAttributeFilter collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopfiltersattributes_get_collection"}},"/get-cart-tokens/{id}":{"get":{"tags":["GetCartToken"],"summary":"Retrieves a GetCartToken resource.","description":"Retrieves a GetCartToken resource.","parameters":[{"name":"id","in":"path","description":"GetCartToken identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"GetCartToken resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopget-cart-tokens_id_get"}},"/get-cart-tokens":{"get":{"tags":["GetCartToken"],"summary":"Retrieves the collection of GetCartToken resources.","description":"Retrieves the collection of GetCartToken resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"GetCartToken collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopget-cart-tokens_get_collection"}},"/locales/{id}":{"get":{"tags":["Locale"],"summary":"Retrieves a Locale resource.","description":"Retrieves a Locale resource.","parameters":[{"name":"id","in":"path","description":"Locale identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Locale resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishoplocales_id_get"}},"/locales":{"get":{"tags":["Locale"],"summary":"Retrieves the collection of Locale resources.","description":"Retrieves the collection of Locale resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Locale collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishoplocales_get_collection"}},"/merge-carts/{id}":{"post":{"tags":["MergeCart"],"summary":"Creates a MergeCart resource.","description":"Creates a MergeCart resource.","parameters":[{"name":"id","in":"path","description":"MergeCart identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new MergeCart resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"MergeCart resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopmerge-carts_id_post"}},"/move-to-wishlists/{id}":{"post":{"tags":["MoveToWishlist"],"summary":"Creates a MoveToWishlist resource.","description":"Creates a MoveToWishlist resource.","parameters":[{"name":"id","in":"path","description":"MoveToWishlist identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new MoveToWishlist resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"MoveToWishlist resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopmove-to-wishlists_id_post"}},"/move-wishlist-to-carts":{"post":{"tags":["WishlistToCart"],"summary":"Creates a WishlistToCart resource.","description":"Creates a WishlistToCart resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new WishlistToCart resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"WishlistToCart resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopmove-wishlist-to-carts_post"}},"/newsletters":{"post":{"tags":["Newsletter"],"summary":"Creates a Newsletter resource.","description":"Creates a Newsletter resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new Newsletter resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"Newsletter resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"createNewsletterSubscription"}},"/pages/{id}":{"get":{"tags":["page"],"summary":"Retrieves a page resource.","description":"Retrieves a page resource.","parameters":[{"name":"id","in":"path","description":"page identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"page resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishoppages_id_get"}},"/pages":{"get":{"tags":["page"],"summary":"Retrieves the collection of page resources.","description":"Retrieves the collection of page resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"page collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishoppages_get_collection"}},"/page_translations":{"get":{"tags":["PageTranslation"],"summary":"Retrieves the collection of PageTranslation resources.","description":"Retrieves the collection of PageTranslation resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"PageTranslation collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishoppage_translations_get_collection"}},"/page_translations/{id}":{"get":{"tags":["PageTranslation"],"summary":"Retrieves a PageTranslation resource.","description":"Retrieves a PageTranslation resource.","parameters":[{"name":"id","in":"path","description":"PageTranslation identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"PageTranslation resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishoppage_translations_id_get"}},"/products/{id}":{"get":{"tags":["Product"],"summary":"Retrieves a Product resource.","description":"Retrieves a Product resource.","parameters":[{"name":"id","in":"path","description":"Product identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Product resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopproducts_id_get"},"put":{"tags":["Product"],"summary":"Update the product","description":"Product update endpoint","parameters":[{"name":"id","in":"path","description":"Product identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Product update payload","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"simple"},"attribute_family_id":{"type":"integer","example":1},"sku":{"type":"string","example":"furniture"},"super_attributes":{"type":"object","example":{"color":[1],"size":[6]}}}},"examples":{"simple_product":{"summary":"Simple Product","description":"Create a standard simple product","value":{"channel":"default","locale":"en","sku":"furniture","product_number":"ssf-001","name":"Sofa Set","url_key":"sofa-set-furniture","tax_category_id":null,"new":1,"featured":1,"manage_stock":1,"visible_individually":1,"guest_checkout":0,"status":1,"color":3,"size":9,"brand":17,"short_description":"What is Lorem Ipsum?","description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_title":"Premium sofa sets","meta_description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_keywords":"Sofa set","price":10.5,"cost":0,"special_price":8.3,"special_price_from":"2023-05-30","special_price_to":"2025-05-22","length":0,"width":0,"height":0,"weight":1,"inventories":{"1":500},"images":{"files":[],"position":[1]},"videos":{"files":[],"position":[1]},"categories":[1],"channels":[1],"up_sell":[1],"cross_sell":[1],"related_products":[1]}},"configurable_product":{"summary":"Configurable Product","description":"Update a configurable product with variations","value":{"channel":"default","locale":"en","sku":"skipping-rope","product_number":"sr-001","name":"Skipping Rope","url_key":"skipping-rope","tax_category_id":null,"new":1,"featured":1,"visible_individually":1,"guest_checkout":0,"status":1,"brand":17,"short_description":"What is Lorem Ipsum?","description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_title":"Premium sofa sets","meta_description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_keywords":"Sofa set","price":0,"customer_group_prices":{"customer_group_price_0":{"customer_group_id":1,"qty":2,"value_type":"fixed","value":3.2}},"categories":[1,2],"channels":[1,3,4],"variants":{"28":{"sku":"skipping-rope-variant-1-6","name":"Red-S","color":1,"size":6,"price":10.5,"weight":1.2,"status":1,"inventories":{"1":500},"images[]":["string"]},"29":{"sku":"skipping-rope-variant-1-7","name":"Red-M","color":1,"size":7,"price":15,"weight":1,"status":1,"inventories":{"1":500},"images[files]":["string"]}}}},"downloadable_product":{"summary":"Downloadable Product","description":"Update a downloadable product with links and samples","value":{"channel":"default","locale":"en","sku":"skipping-rope","product_number":"sr-001","name":"Skipping Rope","url_key":"skipping-rope","tax_category_id":null,"new":1,"featured":1,"visible_individually":1,"guest_checkout":0,"status":1,"brand":17,"short_description":"What is Lorem Ipsum?","description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_title":"Premium sofa sets","meta_description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_keywords":"Sofa set","price":0,"customer_group_prices":{"customer_group_price_0":{"customer_group_id":1,"qty":2,"value_type":"fixed","value":3.2}},"categories":[1,2],"channels":[1,3,4],"downloadable_links":{"link_0":{"en":{"title":"Link 1"},"price":5,"type":"url","url":"https://cdn.pixabay.com/photo/2016/03/26/13/08/conceptual-1280533_1280.jpg","sample_type":"url","sample_url":"https://cdn.pixabay.com/photo/2016/11/22/19/11/brick-wall-1850095_1280.jpg","downloads":10,"sort_order":1},"link_1":{"en":{"title":"Link 2"},"price":10,"type":"url","url":"https://cdn.pixabay.com/photo/2016/03/26/13/08/conceptual-1280533_1280.jpg","sample_type":"url","sample_url":"https://cdn.pixabay.com/photo/2016/11/22/19/11/brick-wall-1850095_1280.jpg","downloads":20,"sort_order":2}},"downloadable_samples":{"sample_0":{"en":{"title":"Sample 1"},"type":"url","url":"https://cdn.pixabay.com/photo/2017/10/04/14/50/staging-2816464_1280.jpg","sort_order":1},"sample_1":{"en":{"title":"Sample 2"},"type":"url","url":"https://cdn.pixabay.com/photo/2015/12/05/23/38/nursery-1078923_1280.jpg","sort_order":2}}}},"grouped_product":{"summary":"Group Product","description":"Update a grouped product along with its associated products","value":{"channel":"default","locale":"en","sku":"skipping-rope","product_number":"sr-001","name":"Skipping Rope","url_key":"skipping-rope","tax_category_id":null,"new":1,"featured":1,"visible_individually":1,"guest_checkout":0,"status":1,"brand":17,"short_description":"What is Lorem Ipsum?","description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_title":"Premium sofa sets","meta_description":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.","meta_keywords":"Sofa set","price":0,"customer_group_prices":{"customer_group_price_0":{"customer_group_id":1,"qty":2,"value_type":"fixed","value":3.2}},"categories":[1,2],"channels":[1,3,4],"links":{"link_0":{"associated_product_id":1,"qty":2,"sort_order":1},"link_1":{"associated_product_id":2,"qty":3,"sort_order":2}}}}}}},"required":true},"responses":{"200":{"description":"Product resource updated","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"},"403":{"description":"Forbidden"},"404":{"description":"Not found"}},"operationId":"api_apishopproducts_id_put"}},"/products":{"post":{"tags":["Product"],"summary":"Store the product","description":"Product creation endpoint","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Product creation payload","content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","example":"simple"},"attribute_family_id":{"type":"integer","example":1},"sku":{"type":"string","example":"furniture"},"super_attributes":{"type":"object","example":{"color":[1],"size":[6]}}}},"examples":{"simple_product":{"summary":"Simple Product","description":"Create a standard simple product","value":{"type":"simple","attribute_family_id":1,"sku":"furniture"}},"configurable_product":{"summary":"Configurable Product","description":"Create a configurable product with variations","value":{"type":"configurable","attribute_family_id":1,"sku":"furniture","super_attributes":{"color":[1],"size":[6]}}}}}},"required":true},"responses":{"201":{"description":"Product resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"},"403":{"description":"Forbidden"}},"operationId":"api_apishopproducts_post"}},"/product-bundle-option-products":{"get":{"tags":["ProductBundleOptionProduct"],"summary":"Retrieves the collection of ProductBundleOptionProduct resources.","description":"Retrieves the collection of ProductBundleOptionProduct resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductBundleOptionProduct collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopproduct-bundle-option-products_get_collection"}},"/product-bundle-option-products/{id}":{"get":{"tags":["ProductBundleOptionProduct"],"summary":"Retrieves a ProductBundleOptionProduct resource.","description":"Retrieves a ProductBundleOptionProduct resource.","parameters":[{"name":"id","in":"path","description":"ProductBundleOptionProduct identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductBundleOptionProduct resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopproduct-bundle-option-products_id_get"}},"/product-downloadable-links":{"get":{"tags":["ProductDownloadableLink"],"summary":"Retrieves the collection of ProductDownloadableLink resources.","description":"Retrieves the collection of ProductDownloadableLink resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductDownloadableLink collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopproduct-downloadable-links_get_collection"}},"/product-downloadable-links/{id}":{"get":{"tags":["ProductDownloadableLink"],"summary":"Retrieves a ProductDownloadableLink resource.","description":"Retrieves a ProductDownloadableLink resource.","parameters":[{"name":"id","in":"path","description":"ProductDownloadableLink identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductDownloadableLink resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopproduct-downloadable-links_id_get"}},"/product-downloadable-samples":{"get":{"tags":["ProductDownloadableSample"],"summary":"Retrieves the collection of ProductDownloadableSample resources.","description":"Retrieves the collection of ProductDownloadableSample resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductDownloadableSample collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopproduct-downloadable-samples_get_collection"}},"/product-downloadable-samples/{id}":{"get":{"tags":["ProductDownloadableSample"],"summary":"Retrieves a ProductDownloadableSample resource.","description":"Retrieves a ProductDownloadableSample resource.","parameters":[{"name":"id","in":"path","description":"ProductDownloadableSample identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductDownloadableSample resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopproduct-downloadable-samples_id_get"}},"/images":{"get":{"tags":["ProductImages"],"summary":"Retrieves the collection of ProductImages resources.","description":"Retrieves the collection of ProductImages resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductImages collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopimages_get_collection"}},"/reviews":{"get":{"tags":["ProductReview"],"summary":"Retrieves the collection of ProductReview resources.","description":"Retrieves the collection of ProductReview resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductReview collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopreviews_get_collection"},"post":{"tags":["ProductReview"],"summary":"Creates a ProductReview resource.","description":"Creates a ProductReview resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new ProductReview resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"ProductReview resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopreviews_post"}},"/reviews/{id}":{"get":{"tags":["ProductReview"],"summary":"Retrieves a ProductReview resource.","description":"Retrieves a ProductReview resource.","parameters":[{"name":"id","in":"path","description":"ProductReview identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductReview resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopreviews_id_get"},"patch":{"tags":["ProductReview"],"summary":"Updates the ProductReview resource.","description":"Updates the ProductReview resource.","parameters":[{"name":"id","in":"path","description":"ProductReview identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The updated ProductReview resource","content":{"application/merge-patch+json":{"schema":[]}},"required":true},"responses":{"200":{"description":"ProductReview resource updated","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"},"404":{"description":"Not found"}},"operationId":"api_apishopreviews_id_patch"},"delete":{"tags":["ProductReview"],"summary":"Removes the ProductReview resource.","description":"Removes the ProductReview resource.","parameters":[{"name":"id","in":"path","description":"ProductReview identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"204":{"description":"ProductReview resource deleted"},"404":{"description":"Not found"}},"operationId":"api_apishopreviews_id_delete"}},"/videos":{"get":{"tags":["ProductVideos"],"summary":"Retrieves the collection of ProductVideos resources.","description":"Retrieves the collection of ProductVideos resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ProductVideos collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopvideos_get_collection"}},"/remove-cart-item":{"post":{"tags":["RemoveCartItem"],"summary":"Creates a RemoveCartItem resource.","description":"Creates a RemoveCartItem resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new RemoveCartItem resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"RemoveCartItem resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"removeItem"}},"/remove-cart-items":{"post":{"tags":["RemoveCartItems"],"summary":"Remove multiple items from cart","description":"Remove multiple items from the shopping cart in a single operation.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Cart items to remove","content":{"application/json":{"schema":{"type":"object","properties":{"itemIds":{"type":"array","items":{"type":"integer"},"example":[7,8,9],"description":"Array of cart item IDs"}}},"examples":{"remove_items":{"summary":"Remove Multiple Items","description":"Remove multiple items from cart","value":{"itemIds":[7,8,9]}}}}},"required":true},"responses":{"201":{"description":"RemoveCartItems resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"removeItems"}},"/remove-coupon":{"post":{"tags":["RemoveCoupon"],"summary":"Remove coupon from cart","description":"Remove the applied discount coupon from the shopping cart.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Remove coupon request","content":{"application/json":{"schema":{"type":"object","properties":[]},"examples":{"remove_coupon":{"summary":"Remove Coupon","description":"Remove the applied coupon code","value":{}}}}},"required":true},"responses":{"201":{"description":"RemoveCoupon resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"removeCoupon"}},"/reorder":{"post":{"tags":["ReorderOrder"],"summary":"Creates a ReorderOrder resource.","description":"Creates a ReorderOrder resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new ReorderOrder resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"ReorderOrder resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopreorder_post"}},"/theme-customizations/{id}":{"get":{"tags":["ThemeCustomization"],"summary":"Retrieves a ThemeCustomization resource.","description":"Retrieves a ThemeCustomization resource.","parameters":[{"name":"id","in":"path","description":"ThemeCustomization identifier","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"ThemeCustomization type","schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ThemeCustomization resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishoptheme-customizations_id_get"}},"/theme-customizations":{"get":{"tags":["ThemeCustomization"],"summary":"Retrieves the collection of ThemeCustomization resources.","description":"Retrieves the collection of ThemeCustomization resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"type","in":"query","description":"ThemeCustomization type","schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"ThemeCustomization collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishoptheme-customizations_get_collection"}},"/update-cart-item":{"post":{"tags":["UpdateCartItem"],"summary":"Update cart item quantity","description":"Update the quantity of an item in the shopping cart.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"Cart item update data","content":{"application/json":{"schema":{"type":"object","properties":{"cartItemId":{"type":"integer","example":7,"description":"Cart item ID"},"quantity":{"type":"integer","example":2,"description":"New quantity"}}},"examples":{"update_quantity":{"summary":"Update Item Quantity","description":"Update the quantity of a cart item","value":{"cartItemId":7,"quantity":2}}}}},"required":true},"responses":{"201":{"description":"UpdateCartItem resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"updateItem"}},"/wishlists/{id}":{"get":{"tags":["Wishlist"],"summary":"Retrieves a Wishlist resource.","description":"Retrieves a Wishlist resource.","parameters":[{"name":"id","in":"path","description":"Wishlist identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Wishlist resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"404":{"description":"Not found"}},"operationId":"api_apishopwishlists_id_get"},"delete":{"tags":["Wishlist"],"summary":"Removes the Wishlist resource.","description":"Removes the Wishlist resource.","parameters":[{"name":"id","in":"path","description":"Wishlist identifier","required":true,"schema":{"type":"string"}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"204":{"description":"Wishlist resource deleted"},"404":{"description":"Not found"}},"operationId":"api_apishopwishlists_id_delete"}},"/wishlists":{"get":{"tags":["Wishlist"],"summary":"Retrieves the collection of Wishlist resources.","description":"Retrieves the collection of Wishlist resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","schema":{"type":"integer","default":1}},{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"responses":{"200":{"description":"Wishlist collection","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}}},"operationId":"api_apishopwishlists_get_collection"},"post":{"tags":["Wishlist"],"summary":"Creates a Wishlist resource.","description":"Creates a Wishlist resource.","parameters":[{"name":"X-STOREFRONT-KEY","in":"header","description":"Storefront API Key for authentication. Required for all shop/storefront API requests.","required":true,"schema":{"type":"string","example":"pk_storefront_vxLIYv5PIp7jkujPNGLFQoDvIdsh2RMF"}}],"requestBody":{"description":"The new Wishlist resource","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}},"required":true},"responses":{"201":{"description":"Wishlist resource created","content":{"application/json":{"schema":[]},"text/html":{"schema":[]}}},"400":{"description":"Invalid input"},"422":{"description":"Validation Error"}},"operationId":"api_apishopwishlists_post"}}},"components":{"schemas":{"AddProductInCart.CartData-mutation":[],"AddUpdateCustomerAddress":[],"ApplyCoupon.CartData-mutation":[],"Attribute":[],"AttributeFamily":[],"AttributeOption":[],"AttributeOptionTranslation":[],"AttributeTranslation":[],"AttributeTranslation.jsonMergePatch":[],"CancelOrder-mutation":[],"CancelOrder.CancelOrderInput":[],"CartItemData-mutation":[],"CartToken-query":[],"Category":[],"CategoryAttributeFilter":[],"CategoryTranslation":[],"CategoryTree":[],"Channel":[],"ChannelTranslation":[],"CheckoutAddress":[],"CheckoutOrder":[],"CheckoutShippingMethod":[],"CompareItem":[],"ContactUs.ContactUsInput-mutation":[],"ContactUs.ContactUsOutput-mutation":[],"Country":[],"CountryState":[],"CountryStateTranslation":[],"CountryTranslation":[],"Currency":[],"Customer":[],"Customer-mutation":[],"CustomerAddress":[],"CustomerAddressToken":[],"CustomerDownloadableProduct":[],"CustomerInvoice":[],"CustomerLogin":[],"CustomerLogin.LoginInput-mutation":[],"CustomerOrder":[],"CustomerOrderAddress":[],"CustomerOrderPayment":[],"CustomerOrderShipment":[],"CustomerOrderShipmentItem":[],"CustomerProfile":[],"CustomerProfileDelete":[],"CustomerProfileUpdate":[],"CustomerReview":[],"DeleteAllCompareItems-mutation":[],"DeleteAllCompareItems.DeleteAllCompareItemsInput":[],"DeleteAllWishlists-mutation":[],"DeleteAllWishlists.DeleteAllWishlistsInput":[],"DownloadableProductDownloadLink":[],"EstimateShipping":[],"Filter.AttributeTranslation":[],"GetCartToken":[],"GetCustomerAddress":[],"GetCustomerAddresses":[],"Locale":[],"MergeCart":[],"MoveToWishlist":[],"Newsletter.SubscribeToNewsletterInput-mutation":[],"Newsletter.SubscribeToNewsletterOutput-mutation":[],"PageTranslation":[],"Product":[],"ProductBundleOption":[],"ProductBundleOptionProduct":[],"ProductBundleOptionTranslation":[],"ProductDownloadableLink":[],"ProductDownloadableLinkTranslation":[],"ProductDownloadableSample":[],"ProductDownloadableSampleTranslation":[],"ProductImages":[],"ProductReview":[],"ProductReview-mutation":[],"ProductReview-mutation.jsonMergePatch":[],"ProductVideos":[],"RemoveCartItem.CartData-mutation":[],"RemoveCartItem.CartInput-mutation":[],"RemoveCartItems.CartData-mutation":[],"RemoveCoupon.CartData-mutation":[],"ReorderOrder-mutation":[],"ReorderOrder.ReorderInput":[],"ThemeCustomization":[],"ThemeCustomizationTranslation":[],"UpdateCartItem.CartData-mutation":[],"Wishlist":[],"WishlistToCart.CartData-mutation":[],"WishlistToCart.MoveWishlistToCartInput":[],"page":[]},"responses":[],"parameters":[],"requestBodies":[],"securitySchemes":{"api":{"type":"apiKey","description":"Value for the Authorization header parameter.","name":"Authorization","in":"header"}}},"security":[{"api":[]}]}