{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/ecommerce:letmc-customer/branch-controller-get-branches":{"get":{"operationId":"ecommerce_letmc_customer_branch_controller_get_branches","summary":"All branches defined for a company","description":"GET /v2/customer/{shortName}/branch/branches","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/get-v2-customer-short-name-branch-branches-branch-id":{"get":{"operationId":"ecommerce_letmc_customer_get_v2_customer_short_name_branch_branches_branch_id","summary":"Get a specific branch given its unique Object ID (OID)","description":"GET /v2/customer/{shortName}/branch/branches/{branchID}","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"branchID","in":"query","required":true,"description":"The unique ID of the Branch","schema":{"type":"string","description":"The unique ID of the Branch"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-accounts":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_accounts","summary":"Get the accounting details for the landlord.","description":"GET /v2/customer/{shortName}/landlord/accounting","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-document":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_document","summary":"Download a Document","description":"GET /v2/customer/{shortName}/landlord/document","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"ID","in":"query","required":true,"description":"The Document ID","schema":{"type":"string","description":"The Document ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-invetory-report":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_invetory_report","summary":"Generate a Inventory PDF for a tenancy","description":"GET /v2/customer/{shortName}/landlord/inventory","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"tenancyID","in":"query","required":true,"description":"The Tenancy ID","schema":{"type":"string","description":"The Tenancy ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-invoice":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_invoice","summary":"Get an invoice pdf belonging to the landlord.","description":"GET /v2/customer/{shortName}/landlord/invoice","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"invoiceID","in":"query","required":true,"description":"The invoice ID to load.","schema":{"type":"string","description":"The invoice ID to load."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-landlord-crm-entries":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_landlord_crm_entries","summary":"Retrieve landlord's CRM ID","description":"GET /v2/customer/{shortName}/landlord/landlordcrmentries","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-maintenance-jobs":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_maintenance_jobs","summary":"Get Active maintenance jobs.","description":"GET /v2/customer/{shortName}/landlord/maintenance","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-profit-loss-report":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_profit_loss_report","summary":"Generate a Profit and Loss Report","description":"GET /v2/customer/{shortName}/landlord/profitloss","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-rent-arrears":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_rent_arrears","summary":"Rent Arrears","description":"GET /v2/customer/{shortName}/landlord/rentarrears","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-sasreport":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_sasreport","summary":"Generate a Self Assessment Tax Report","description":"GET /v2/customer/{shortName}/landlord/sas","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"yearEnd","in":"query","required":true,"description":"The Tax Year End.","schema":{"type":"integer","description":"The Tax Year End."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-settings":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_settings","summary":"Get contact details of all linked landlords.","description":"GET /v2/customer/{shortName}/landlord/settings","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-summary-details":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_summary_details","summary":"Get the summary details for the landlord.","description":"GET /v2/customer/{shortName}/landlord/summary","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-tenancy":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_tenancy","summary":"Get tenancy details.","description":"GET /v2/customer/{shortName}/landlord/tenancy","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"tenancyID","in":"query","required":true,"description":"The Tenancy ID","schema":{"type":"string","description":"The Tenancy ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-create-maintenance-preference":{"post":{"operationId":"ecommerce_letmc_customer_landlord_controller_create_maintenance_preference","summary":"Post tenancy maintenance preferences:-","description":"POST /v2/customer/{shortName}/landlord/tenancy/maintenance/preference","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","token","tenancyID","name","notes"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"token":{"type":"string","description":"The login token returned from the /session POST call"},"tenancyID":{"type":"string","description":"The Tenancy ID"},"name":{"type":"string","description":"Name of the maintenance preference to add"},"notes":{"type":"string","description":"Notes of the maintenance preference to add"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/landlord-controller-get-tenancy-agreement-report":{"get":{"operationId":"ecommerce_letmc_customer_landlord_controller_get_tenancy_agreement_report","summary":"Generate a Tenancy Agreement Copy (PDF)","description":"GET /v2/customer/{shortName}/landlord/tenancyagreement","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"tenancyID","in":"query","required":true,"description":"The Tenancy ID","schema":{"type":"string","description":"The Tenancy ID"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/photo-controller-get-photo-download":{"get":{"operationId":"ecommerce_letmc_customer_photo_controller_get_photo_download","summary":"Downloads the photo of a property given the photo ID.","description":"GET /v2/customer/{shortName}/photo/download","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"photoID","in":"query","required":true,"description":"The unique ID of the photo on the property","schema":{"type":"string","description":"The unique ID of the photo on the property"}},{"name":"width","in":"query","required":false,"description":"An optional parameter specifying the image width","schema":{"type":"integer","description":"An optional parameter specifying the image width"}},{"name":"height","in":"query","required":false,"description":"An optional parameter specifying the image height","schema":{"type":"integer","description":"An optional parameter specifying the image height"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/property-controller-get-properties-photos":{"get":{"operationId":"ecommerce_letmc_customer_property_controller_get_properties_photos","summary":"A collection showing all the photos linked to a specific block, property or room","description":"GET /v2/customer/{shortName}/property/{propertyID}/photos","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}},{"name":"propertyID","in":"query","required":true,"description":"The unique ID of the Property","schema":{"type":"string","description":"The unique ID of the Property"}},{"name":"offset","in":"query","required":true,"description":"The index of the first item to return","schema":{"type":"integer","description":"The index of the first item to return"}},{"name":"count","in":"query","required":true,"description":"The maximum number of items to return (up to 1000 per request)","schema":{"type":"integer","description":"The maximum number of items to return (up to 1000 per request)"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/session-controller-get-session-info":{"get":{"operationId":"ecommerce_letmc_customer_session_controller_get_session_info","summary":"Gets information about the currently logged on customer.","description":"GET /v2/customer/{shortName}/session","tags":["ecommerce"],"parameters":[{"name":"shortName","in":"query","required":true,"description":"The unique client short-name","schema":{"type":"string","description":"The unique client short-name"}},{"name":"token","in":"query","required":true,"description":"The login token returned from the /session POST call","schema":{"type":"string","description":"The login token returned from the /session POST call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/session-controller-login":{"post":{"operationId":"ecommerce_letmc_customer_session_controller_login","summary":"Login as a customer given their username and password.","description":"POST /v2/customer/{shortName}/session","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","username","password"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"username":{"type":"string","description":"The user's username."},"password":{"type":"string","description":"The user's password."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/session-controller-logout":{"post":{"operationId":"ecommerce_letmc_customer_session_controller_logout","summary":"Logout a customer previously logged in via the Login endpoint.","description":"DELETE /v2/customer/{shortName}/session","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","token"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"token":{"type":"string","description":"The login token returned from the /session POST call"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/session-controller-create-landlord-login":{"post":{"operationId":"ecommerce_letmc_customer_session_controller_create_landlord_login","summary":"Send a request to the in-tray to create a landlord login.","description":"POST /v2/customer/{shortName}/session/createlandlordlogin","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","email","title","forename","surname","propertyAddress","contactDetails"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"email":{"type":"string","description":"The email address of the landlord"},"title":{"type":"string","description":"The title of the landlord"},"forename":{"type":"string","description":"The forename of the landlord"},"surname":{"type":"string","description":"The surname of the landlord"},"propertyAddress":{"type":"string","description":"Address of the property linked to the landlord"},"contactDetails":{"type":"string","description":"Contact details of the landlord"},"branchID":{"type":"string","description":"(Optional) The branch ID linked to the login. This will determine which in tray the request display in"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/session-controller-change-password":{"post":{"operationId":"ecommerce_letmc_customer_session_controller_change_password","summary":"Change the password of a customer given their existing and new password.","description":"PUT /v2/customer/{shortName}/session/password","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","token","oldPassword","newPassword"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"token":{"type":"string","description":"The login token returned from the /session POST call"},"oldPassword":{"type":"string","description":"The customer's existing password."},"newPassword":{"type":"string","description":"The customer's new password."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/ecommerce:letmc-customer/session-controller-reset-password":{"post":{"operationId":"ecommerce_letmc_customer_session_controller_reset_password","summary":"Reset the customer's password. An email will be sent out to reset.","description":"POST /v2/customer/{shortName}/session/resetpassword","tags":["ecommerce"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shortName","email"],"properties":{"shortName":{"type":"string","description":"The unique client short-name"},"email":{"type":"string","description":"The login Email Address."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}