{"openapi":"3.1.0","info":{"title":"Shopiza API","version":"1.0.0","description":"Read and update a Shopiza shop: orders, products, customers, and webhook subscriptions. Create a key in the admin under Settings > Integrations. Full guide: https://shopiza.io/developers"},"servers":[{"url":"https://shopiza.io/api/v1"}],"components":{"securitySchemes":{"apiKey":{"type":"http","scheme":"bearer","description":"An API key: sz_live_..."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","example":"insufficient_scope"},"message":{"type":"string"},"param":{"type":"string","description":"Query parameter at fault, when there is one."},"field":{"type":"string","description":"Body field at fault, when there is one."},"required_scope":{"type":"string","enum":["orders:read","orders:write","products:read","products:write","customers:read","webhooks:write"]}}}}},"OrderItem":{"type":"object","properties":{"id":{"type":"integer"},"product_id":{"type":["integer","null"]},"variant_id":{"type":["integer","null"]},"sku":{"type":["string","null"],"example":"MUG-01"},"ean":{"type":["string","null"],"example":null},"name":{"type":"string","example":"Ceramic mug"},"variant":{"type":["string","null"],"example":"Blue"},"quantity":{"type":"integer","example":2},"unit_price":{"type":"string","pattern":"^\\d+\\.\\d{2}$","example":"24.90"},"total":{"type":"string","pattern":"^\\d+\\.\\d{2}$","example":"24.90"},"tax_rate":{"type":["number","null"],"example":27},"tax_amount":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"}}},"Order":{"type":"object","properties":{"id":{"type":"integer","example":1234},"number":{"type":"string","example":"K7Q2M9","description":"The order number the customer sees."},"status":{"type":"string","enum":["new","processing","fulfilled","cancelled"]},"payment_status":{"type":"string","enum":["pending","paid","failed","refunded","partially_refunded","disputed","chargeback"]},"payment_method":{"type":["string","null"],"example":"Card"},"shipping_method":{"type":["string","null"],"example":"Home delivery"},"currency":{"type":"string","example":"EUR"},"subtotal":{"type":"string","pattern":"^\\d+\\.\\d{2}$","example":"24.90"},"shipping_total":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"payment_fee":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"discount_total":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"gift_card_amount":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"tax_total":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"total":{"type":"string","pattern":"^\\d+\\.\\d{2}$","example":"24.90"},"discount_code":{"type":["string","null"],"example":null},"customer":{"type":"object","properties":{"id":{"type":["integer","null"],"description":"null for a guest checkout."},"email":{"type":["string","null"],"example":"anna@example.com"},"first_name":{"type":["string","null"],"example":"Anna"},"last_name":{"type":["string","null"],"example":"Kovács"},"name":{"type":["string","null"],"example":"Anna Kovács"},"phone":{"type":["string","null"],"example":"+36 30 123 4567"}}},"shipping_address":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"example":"Anna Kovács"},"address":{"type":["string","null"],"example":"Fő utca 1."},"city":{"type":["string","null"],"example":"Budapest"},"postal_code":{"type":["string","null"],"example":"1011"},"country":{"type":["string","null"],"example":"HU"}}},"billing_address":{"type":["object","null"],"properties":{"name":{"type":["string","null"],"example":"Anna Kovács"},"address":{"type":["string","null"],"example":"Fő utca 1."},"city":{"type":["string","null"],"example":"Budapest"},"postal_code":{"type":["string","null"],"example":"1011"},"country":{"type":["string","null"],"example":"HU"}}},"vat_id":{"type":["string","null"],"example":null},"notes":{"type":["string","null"],"example":null},"locale":{"type":["string","null"],"example":"hu"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"paid_at":{"type":["string","null"],"format":"date-time"},"refunded_at":{"type":["string","null"],"format":"date-time"},"refund_amount":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"},"admin_url":{"type":"string","format":"uri"}}},"Variant":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":["string","null"],"example":"Blue / L"},"options":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","example":"Color"},"value":{"type":"string","example":"Blue"}}}},"sku":{"type":["string","null"],"example":"TEE-BL-L"},"ean":{"type":["string","null"],"example":null},"price":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90","description":"null: the variant charges the product price."},"sale_price":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"stock":{"type":["integer","null"],"description":"null: stock is not tracked."},"is_active":{"type":"boolean"}}},"Product":{"type":"object","properties":{"id":{"type":"integer","example":987},"name":{"type":"string","description":"In the shop's default language."},"description":{"type":["string","null"],"description":"HTML."},"short_description":{"type":["string","null"],"example":null},"translations":{"type":"object","description":"Every language the shop has, keyed by language code.","properties":{"name":{"type":"object"},"description":{"type":"object"},"short_description":{"type":"object"}}},"slug":{"type":"string"},"sku":{"type":["string","null"],"example":"MUG-01"},"ean":{"type":["string","null"],"example":null},"price":{"type":"string","pattern":"^\\d+\\.\\d{2}$","example":"24.90"},"sale_price":{"type":["string","null"],"pattern":"^\\d+\\.\\d{2}$","example":"19.90"},"currency":{"type":"string","example":"EUR"},"stock":{"type":["integer","null"],"description":"null: stock is not tracked. For products with variants, stock lives on each variant."},"is_active":{"type":"boolean"},"weight_kg":{"type":["number","null"]},"has_variants":{"type":"boolean"},"variants":{"type":"array","items":{"$ref":"#/components/schemas/Variant"}},"category_ids":{"type":"array","items":{"type":"integer"}},"images":{"type":"array","items":{"type":"string","format":"uri"}},"url":{"type":["string","null"],"format":"uri","description":"The product page on the shop."},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}}},"Customer":{"type":"object","properties":{"id":{"type":"integer"},"email":{"type":"string"},"first_name":{"type":["string","null"],"example":"Anna"},"last_name":{"type":["string","null"],"example":"Kovács"},"phone":{"type":["string","null"],"example":null},"locale":{"type":["string","null"],"example":"hu"},"accepts_marketing":{"type":"boolean"},"email_verified":{"type":"boolean"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}}},"Shop":{"type":"object","properties":{"id":{"type":"integer"},"slug":{"type":"string"},"name":{"type":"string"},"url":{"type":["string","null"]},"currency":{"type":["string","null"],"example":"EUR"},"locale":{"type":["string","null"],"example":"en"},"locales":{"type":"array","items":{"type":"string"}},"contact_email":{"type":["string","null"],"example":null},"api_key":{"type":"object","properties":{"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["orders:read","orders:write","products:read","products:write","customers:read","webhooks:write"]}}}}}},"Webhook":{"type":"object","properties":{"id":{"type":"integer"},"url":{"type":"string","format":"uri"},"description":{"type":["string","null"],"example":null},"events":{"type":"array","items":{"type":"string","enum":["order.created","order.paid","order.updated","order.cancelled","order.refunded","product.created","product.updated","product.deleted","customer.created"]}},"is_active":{"type":"boolean"},"disabled_reason":{"type":["string","null"],"enum":["failing",null]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}}},"Event":{"type":"object","description":"The body of every webhook request.","properties":{"id":{"type":"string","format":"uuid","description":"Same id on every retry and resend: use it to ignore duplicates."},"type":{"type":"string","enum":["order.created","order.paid","order.updated","order.cancelled","order.refunded","product.created","product.updated","product.deleted","customer.created","ping"]},"created_at":{"type":["string","null"],"format":"date-time"},"shop_id":{"type":"integer"},"data":{"type":"object","properties":{"object":{"description":"An Order, Product or Customer, exactly as the API returns it. product.deleted carries only id, name, sku, deleted_at."}}}}}}},"security":[{"apiKey":[]}],"paths":{"/shop":{"get":{"summary":"The shop this key belongs to","operationId":"getShop","x-required-scope":null,"security":[{"apiKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Shop"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/orders":{"get":{"summary":"List orders, newest first","operationId":"listOrders","x-required-scope":"orders:read","security":[{"apiKey":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"sort","in":"query","description":"Newest first by creation time (default) or by last change.","schema":{"type":"string","enum":["created_at","updated_at"]}},{"name":"created_after","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"updated_after","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","schema":{"type":"string","enum":["new","processing","fulfilled","cancelled"]}},{"name":"payment_status","in":"query","schema":{"type":"string","enum":["pending","paid","failed","refunded","partially_refunded","disputed","chargeback"]}},{"name":"number","in":"query","description":"The order number the customer sees.","schema":{"type":"string"}},{"name":"email","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Order"}},"page":{"type":"integer"},"limit":{"type":"integer"},"has_more":{"type":"boolean"}}}}}},"400":{"description":"Bad parameter","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/orders/{id}":{"get":{"summary":"Get an order","operationId":"getOrder","x-required-scope":"orders:read","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Change an order status","operationId":"updateOrder","x-required-scope":"orders:write","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"description":"Setting `fulfilled` sends the customer the same \"your order is on its way\" email as the admin, unless `notify_customer` is false. Cancelling restores stock; it does not refund.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["status"],"properties":{"status":{"type":"string","enum":["new","processing","fulfilled","cancelled"]},"notify_customer":{"type":"boolean","default":true},"tracking_number":{"type":"string"},"tracking_url":{"type":"string","format":"uri"}}}}}},"responses":{"200":{"description":"The updated order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid body (`field` names it)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/products":{"get":{"summary":"List products, newest first","operationId":"listProducts","x-required-scope":"products:read","security":[{"apiKey":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"sort","in":"query","description":"Newest first by creation time (default) or by last change.","schema":{"type":"string","enum":["created_at","updated_at"]}},{"name":"created_after","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"updated_after","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"q","in":"query","description":"Words from the product name (any language) or SKU.","schema":{"type":"string"}},{"name":"sku","in":"query","schema":{"type":"string"}},{"name":"is_active","in":"query","schema":{"type":"string","enum":["true","false"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"page":{"type":"integer"},"limit":{"type":"integer"},"has_more":{"type":"boolean"}}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/products/{id}":{"get":{"summary":"Get a product","operationId":"getProduct","x-required-scope":"products:read","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"patch":{"summary":"Update price, sale price, stock or visibility","operationId":"updateProduct","x-required-scope":"products:write","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"price":{"type":"number","minimum":0,"example":24.9,"description":"Entered the same way as in the admin (net or gross, per the shop's pricing setting)."},"sale_price":{"type":["number","null"],"description":"null or 0 removes the sale. Must be lower than the price."},"stock":{"type":["integer","null"],"minimum":0,"description":"null stops tracking stock."},"is_active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The updated product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid body (`field` names it)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/products/{id}/variants/{variantId}":{"patch":{"summary":"Update one variant","operationId":"updateVariant","x-required-scope":"products:write","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"variantId","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"price":{"type":"number","minimum":0,"example":24.9,"description":"Entered the same way as in the admin (net or gross, per the shop's pricing setting)."},"sale_price":{"type":["number","null"],"description":"null or 0 removes the sale. Must be lower than the price."},"stock":{"type":["integer","null"],"minimum":0,"description":"null stops tracking stock."},"is_active":{"type":"boolean"}}}}}},"responses":{"200":{"description":"The whole updated product","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid body (`field` names it)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/customers":{"get":{"summary":"List customer accounts, newest first","operationId":"listCustomers","x-required-scope":"customers:read","security":[{"apiKey":[]}],"parameters":[{"name":"limit","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":50}},{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},{"name":"sort","in":"query","description":"Newest first by creation time (default) or by last change.","schema":{"type":"string","enum":["created_at","updated_at"]}},{"name":"created_after","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"updated_after","in":"query","schema":{"type":"string","format":"date-time"}},{"name":"email","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"page":{"type":"integer"},"limit":{"type":"integer"},"has_more":{"type":"boolean"}}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/customers/{id}":{"get":{"summary":"Get a customer","operationId":"getCustomer","x-required-scope":"customers:read","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhooks":{"get":{"summary":"Webhooks this key created","operationId":"listWebhooks","x-required-scope":"webhooks:write","security":[{"apiKey":[]}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Webhook"}}}}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"post":{"summary":"Subscribe a URL to events","operationId":"createWebhook","x-required-scope":"webhooks:write","security":[{"apiKey":[]}],"description":"Also needs the read scope of each event: orders:read for order.*, products:read for product.*, customers:read for customer.*. The response carries the signing `secret` once.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["url","events"],"properties":{"url":{"type":"string","format":"uri","description":"https only"},"events":{"type":"array","items":{"type":"string","enum":["order.created","order.paid","order.updated","order.cancelled","order.refunded","product.created","product.updated","product.deleted","customer.created"]}},"description":{"type":"string"}}}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Webhook"},{"type":"object","properties":{"secret":{"type":"string","example":"whsec_..."}}}]}}}},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Invalid body (`field` names it)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/webhooks/{id}":{"delete":{"summary":"Unsubscribe","operationId":"deleteWebhook","x-required-scope":"webhooks:write","security":[{"apiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"Deleted"},"401":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"The key lacks the scope (`required_scope`) or the shop is unavailable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limited (120 requests a minute per key). See Retry-After.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}}},"webhooks":{"order.created":{"post":{"summary":"order.created","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"order.paid":{"post":{"summary":"order.paid","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"order.updated":{"post":{"summary":"order.updated","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"order.cancelled":{"post":{"summary":"order.cancelled","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"order.refunded":{"post":{"summary":"order.refunded","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"product.created":{"post":{"summary":"product.created","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"product.updated":{"post":{"summary":"product.updated","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"product.deleted":{"post":{"summary":"product.deleted","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}},"customer.created":{"post":{"summary":"customer.created","description":"Signed with the Shopiza-Signature header: t=<unix seconds>,v1=<hex HMAC-SHA256 of \"<t>.<raw body>\" with the webhook secret>. Answer 2xx within 10 seconds.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}},"responses":{"200":{"description":"Received"}}}}}}