openapi-directory/api/squareup.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"contact":{"email":"developers@squareup.com","name":"Square Developer Platform","url":"https://squareup.com/developers"},"description":"Client library for accessing the Square Connect APIs","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://connect.squareup.com/tos","title":"Square Connect","version":"2.0","x-apisguru-categories":["payment"],"x-logo":{"url":"http://square.github.io/images/logo.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/square/connect-api-specification/master/api.json","version":"2.0"}],"x-providerName":"squareup.com"},"externalDocs":{"description":"Read the official documentation here:","url":"https://docs.connect.squareup.com/"},"paths":{"/v1/me":{"get":{"deprecated":true,"description":"Get a business's information.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-merchantid"},"operationId":"RetrieveBusiness","responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Merchant"}}}}},"security":[{"oauth2":["MERCHANT_PROFILE_READ"]}],"summary":"Get a business's information.","tags":["V1Locations"]}},"/v1/me/employees":{"get":{"deprecated":false,"description":"Provides summary information for all of a business's employees.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-employees"},"operationId":"ListEmployees","parameters":[{"description":"The order in which employees are listed in the response, based on their created_at field.      Default value: ASC ","in":"query","name":"order","schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format","in":"query","name":"begin_updated_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_updated_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.","in":"query","name":"begin_created_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_created_at","required":false,"schema":{"type":"string"}},{"description":"If provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE).","in":"query","name":"status","schema":{"type":"string","enum":["ACTIVE","INACTIVE"]}},{"description":"If provided, the endpoint returns only employee entities with the specified external_id.","in":"query","name":"external_id","schema":{"type":"string"}},{"description":"The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.","in":"query","name":"limit","schema":{"type":"integer","maximum":200}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Employee"},"type":"array"}}}}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"Provides summary information for all of a business's employees.","tags":["V1Employees"]},"post":{"deprecated":false,"description":"Creates an employee for a business.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-employees"},"operationId":"CreateEmployee","requestBody":{"$ref":"#/components/requestBodies/v1Employee"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Employee"}}}}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"Creates an employee for a business.","tags":["V1Employees"]}},"/v1/me/employees/{employee_id}":{"get":{"deprecated":false,"description":"Provides the details for a single employee.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-employeeid"},"operationId":"RetrieveEmployee","parameters":[{"description":"The employee's ID.","in":"path","name":"employee_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Employee"}}}}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"Provides the details for a single employee.","tags":["V1Employees"]},"put":{"deprecated":false,"externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-employeeid"},"operationId":"UpdateEmployee","parameters":[{"description":"The ID of the role to modify.","in":"path","name":"employee_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Employee"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Employee"}}}}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"V1 UpdateEmployee","tags":["V1Employees"]}},"/v1/me/locations":{"get":{"deprecated":true,"description":"Provides details for a business's locations, including their IDs.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-locations"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Merchant"},"type":"array"}}}}},"security":[{"oauth2":["MERCHANT_PROFILE_READ"]}],"summary":"Provides details for a business's locations, including their IDs.","tags":["V1Locations"]}},"/v1/me/roles":{"get":{"deprecated":false,"description":"Provides summary information for all of a business's employee roles.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-roles"},"operationId":"ListEmployeeRoles","parameters":[{"description":"The order in which employees are listed in the response, based on their created_at field.Default value: ASC ","in":"query","name":"order","schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.","in":"query","name":"limit","schema":{"type":"integer","maximum":200}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1EmployeeRole"},"type":"array"}}}}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"Provides summary information for all of a business's employee roles.","tags":["V1Employees"]},"post":{"deprecated":false,"description":"Creates an employee role you can then assign to employees.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-roles"},"operationId":"CreateEmployeeRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1EmployeeRole"}}},"description":"An EmployeeRole object with a name and permissions, and an optional owner flag.","required":true},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1EmployeeRole"}}}}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"Creates an employee role you can then assign to employees.","tags":["V1Employees"]}},"/v1/me/roles/{role_id}":{"get":{"deprecated":false,"description":"Provides the details for a single employee role.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-roleid"},"operationId":"RetrieveEmployeeRole","parameters":[{"description":"The role's ID.","in":"path","name":"role_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1EmployeeRole"}}}}},"security":[{"oauth2":["EMPLOYEES_READ"]}],"summary":"Provides the details for a single employee role.","tags":["V1Employees"]},"put":{"deprecated":false,"description":"Modifies the details of an employee role.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-roleid"},"operationId":"UpdateEmployeeRole","parameters":[{"description":"The ID of the role to modify.","in":"path","name":"role_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1EmployeeRole"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1EmployeeRole"}}}}},"security":[{"oauth2":["EMPLOYEES_WRITE"]}],"summary":"Modifies the details of an employee role.","tags":["V1Employees"]}},"/v1/me/timecards":{"get":{"deprecated":false,"description":"Provides summary information for all of a business's employee timecards.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-timecards"},"operationId":"ListTimecards","parameters":[{"description":"The order in which timecards are listed in the response, based on their created_at field.","in":"query","name":"order","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"If provided, the endpoint returns only timecards for the employee with the specified ID.","in":"query","name":"employee_id","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their clockin_time field, the beginning of the requested reporting period, in ISO 8601 format.","in":"query","name":"begin_clockin_time","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their clockin_time field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_clockin_time","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their clockout_time field, the beginning of the requested reporting period, in ISO 8601 format.","in":"query","name":"begin_clockout_time","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their clockout_time field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_clockout_time","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format.","in":"query","name":"begin_updated_at","required":false,"schema":{"type":"string"}},{"description":"If filtering results by their updated_at field, the end of the requested reporting period, in ISO 8601 format.","in":"query","name":"end_updated_at","required":false,"schema":{"type":"string"}},{"description":"If true, only deleted timecards are returned. If false, only valid timecards are returned.If you don't provide this parameter, both valid and deleted timecards are returned.","in":"query","name":"deleted","required":false,"schema":{"type":"boolean"}},{"description":"The maximum integer number of employee entities to return in a single response. Default 100, maximum 200.","in":"query","name":"limit","schema":{"type":"integer","maximum":200}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Timecard"},"type":"array"}}}}},"security":[{"oauth2":["TIMECARDS_READ"]}],"summary":"Provides summary information for all of a business's employee timecards.","tags":["V1Employees"]},"post":{"deprecated":false,"description":"Creates a timecard for an employee. Each timecard corresponds to a single shift.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-timecards"},"operationId":"CreateTimecard","requestBody":{"$ref":"#/components/requestBodies/v1Timecard"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Timecard"}}}}},"security":[{"oauth2":["TIMECARDS_WRITE"]}],"summary":"Creates a timecard for an employee. Each timecard corresponds to a single shift.","tags":["V1Employees"]}},"/v1/me/timecards/{timecard_id}":{"delete":{"deprecated":false,"description":"Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-timecardid"},"operationId":"DeleteTimecard","parameters":[{"description":"The ID of the timecard to delete.","in":"path","name":"timecard_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"security":[{"oauth2":["TIMECARDS_WRITE"]}],"summary":"Deletes a timecard. Deleted timecards are still accessible from Connect API endpoints, but the value of their deleted field is set to true. See Handling deleted timecards for more information.","tags":["V1Employees"]},"get":{"deprecated":false,"description":"Provides the details for a single timecard.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-timecardid"},"operationId":"RetrieveTimecard","parameters":[{"description":"The timecard's ID.","in":"path","name":"timecard_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Timecard"}}}}},"security":[{"oauth2":["TIMECARDS_READ"]}],"summary":"Provides the details for a single timecard.","tags":["V1Employees"]},"put":{"deprecated":false,"description":"Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-timecardid"},"operationId":"UpdateTimecard","parameters":[{"description":"TThe ID of the timecard to modify.","in":"path","name":"timecard_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Timecard"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Timecard"}}}}},"security":[{"oauth2":["TIMECARDS_WRITE"]}],"summary":"Modifies a timecard's details. This creates an API_EDIT event for the timecard. You can view a timecard's event history with the List Timecard Events endpoint.","tags":["V1Employees"]}},"/v1/me/timecards/{timecard_id}/events":{"get":{"deprecated":false,"description":"Provides summary information for all events associated with a particular timecard.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-events"},"operationId":"ListTimecardEvents","parameters":[{"description":"The ID of the timecard to list events for.","in":"path","name":"timecard_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1TimecardEvent"},"type":"array"}}}}},"security":[{"oauth2":["TIMECARDS_READ"]}],"summary":"Provides summary information for all events associated with a particular timecard.","tags":["V1Employees"]}},"/v1/{location_id}/bank-accounts":{"get":{"deprecated":false,"description":"Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-bankaccounts"},"operationId":"ListBankAccounts","parameters":[{"description":"The ID of the location to list bank accounts for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1BankAccount"},"type":"array"}}}}},"security":[{"oauth2":["BANK_ACCOUNTS_READ"]}],"summary":"Provides non-confidential details for all of a location's associated bank accounts. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.","tags":["V1Transactions"]}},"/v1/{location_id}/bank-accounts/{bank_account_id}":{"get":{"deprecated":false,"description":"Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-bankaccountid"},"operationId":"RetrieveBankAccount","parameters":[{"description":"The ID of the bank account's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The bank account's Square-issued ID. You obtain this value from Settlement objects returned.","in":"path","name":"bank_account_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1BankAccount"}}}}},"security":[{"oauth2":["BANK_ACCOUNTS_READ"]}],"summary":"Provides non-confidential details for a merchant's associated bank account. This endpoint does not provide full bank account numbers, and there is no way to obtain a full bank account number with the Connect API.","tags":["V1Transactions"]}},"/v1/{location_id}/cash-drawer-shifts":{"get":{"deprecated":false,"description":"Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-cashdrawershifts"},"operationId":"ListCashDrawerShifts","parameters":[{"description":"The ID of the location to list cash drawer shifts for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The order in which cash drawer shifts are listed in the response, based on their created_at field. Default value: ASC","in":"query","name":"order","required":false,"schema":{"type":"string","enum":["ASC","DESC"]}},{"description":"The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time minus 90 days.","in":"query","name":"begin_time","required":false,"schema":{"type":"string"}},{"description":"The beginning of the requested reporting period, in ISO 8601 format. Default value: The current time.","in":"query","name":"end_time","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1CashDrawerShift"},"type":"array"}}}}},"security":[{"oauth2":["PAYMENTS_READ"]}],"summary":"Provides the details for all of a location's cash drawer shifts during a date range. The date range you specify cannot exceed 90 days.","tags":["V1Employees"]}},"/v1/{location_id}/cash-drawer-shifts/{shift_id}":{"get":{"deprecated":false,"description":"Provides the details for a single cash drawer shift, including all events that occurred during the shift.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-cashdrawershiftid"},"operationId":"RetrieveCashDrawerShift","parameters":[{"description":"The ID of the location to list cash drawer shifts for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The shift's ID.","in":"path","name":"shift_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1CashDrawerShift"}}}}},"security":[{"oauth2":["TIMECARDS_READ"]}],"summary":"Provides the details for a single cash drawer shift, including all events that occurred during the shift.","tags":["V1Employees"]}},"/v1/{location_id}/categories":{"get":{"deprecated":false,"description":"Lists all of a location's item categories.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-categories"},"operationId":"ListCategories","parameters":[{"description":"The ID of the location to list categories for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Category"},"type":"array"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Lists all of a location's item categories.","tags":["V1Items"]},"post":{"deprecated":false,"description":"Creates an item category.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-categories"},"operationId":"CreateCategory","parameters":[{"description":"The ID of the location to create an item for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Category"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Category"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Creates an item category.","tags":["V1Items"]}},"/v1/{location_id}/categories/{category_id}":{"delete":{"deprecated":false,"description":"Deletes an existing item category.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-categoryid"},"operationId":"DeleteCategory","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the category to delete.","in":"path","name":"category_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Category"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Deletes an existing item category.","tags":["V1Items"]},"put":{"deprecated":false,"description":"Modifies the details of an existing item category.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-categoryid"},"operationId":"UpdateCategory","parameters":[{"description":"The ID of the category's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the category to edit.","in":"path","name":"category_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Category"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Category"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Modifies the details of an existing item category.","tags":["V1Items"]}},"/v1/{location_id}/discounts":{"get":{"deprecated":false,"description":"Lists all of a location's discounts.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-discounts"},"operationId":"ListDiscounts","parameters":[{"description":"The ID of the location to list categories for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Discount"},"type":"array"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Lists all of a location's discounts.","tags":["V1Items"]},"post":{"deprecated":false,"description":"Creates a discount.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-discounts"},"operationId":"CreateDiscount","parameters":[{"description":"The ID of the location to create an item for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Discount"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Discount"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Creates a discount.","tags":["V1Items"]}},"/v1/{location_id}/discounts/{discount_id}":{"delete":{"deprecated":false,"description":"Deletes an existing discount.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-discountid"},"operationId":"DeleteDiscount","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the discount to delete.","in":"path","name":"discount_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Discount"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Deletes an existing discount.","tags":["V1Items"]},"put":{"deprecated":false,"description":"Modifies the details of an existing discount.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-discountid"},"operationId":"UpdateDiscount","parameters":[{"description":"The ID of the category's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the discount to edit.","in":"path","name":"discount_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Discount"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Discount"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Modifies the details of an existing discount.","tags":["V1Items"]}},"/v1/{location_id}/fees":{"get":{"deprecated":false,"description":"Lists all of a location's fees (taxes).","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-fees"},"operationId":"ListFees","parameters":[{"description":"The ID of the location to list fees for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Fee"},"type":"array"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Lists all of a location's fees (taxes).","tags":["V1Items"]},"post":{"deprecated":false,"description":"Creates a fee (tax).","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-fees"},"operationId":"CreateFee","parameters":[{"description":"The ID of the location to create a fee for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Fee"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Fee"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Creates a fee (tax).","tags":["V1Items"]}},"/v1/{location_id}/fees/{fee_id}":{"delete":{"deprecated":false,"description":"Deletes an existing fee (tax).","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-feeid"},"operationId":"DeleteFee","parameters":[{"description":"The ID of the fee's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the fee to delete.","in":"path","name":"fee_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Fee"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Deletes an existing fee (tax).","tags":["V1Items"]},"put":{"deprecated":false,"description":"Modifies the details of an existing fee (tax).","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-feeid"},"operationId":"UpdateFee","parameters":[{"description":"The ID of the fee's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the fee to edit.","in":"path","name":"fee_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Fee"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Fee"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Modifies the details of an existing fee (tax).","tags":["V1Items"]}},"/v1/{location_id}/inventory":{"get":{"deprecated":false,"description":"Provides inventory information for all of a merchant's inventory-enabled item variations.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-inventory"},"operationId":"ListInventory","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The maximum number of inventory entries to return in a single response. This value cannot exceed 1000.","in":"query","name":"limit","required":false,"schema":{"type":"integer","maximum":1000}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1InventoryEntry"},"type":"array"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Provides inventory information for all of a merchant's inventory-enabled item variations.","tags":["V1Items"]}},"/v1/{location_id}/inventory/{variation_id}":{"post":{"deprecated":false,"description":"Adjusts an item variation's current available inventory.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-inventory-variationid"},"operationId":"AdjustInventory","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the variation to adjust inventory information for.","in":"path","name":"variation_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1AdjustInventoryRequest"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1InventoryEntry"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Adjusts an item variation's current available inventory.","tags":["V1Items"]}},"/v1/{location_id}/items":{"get":{"deprecated":false,"description":"Provides summary information for all of a location's items.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-items"},"operationId":"ListItems","parameters":[{"description":"The ID of the location to list items for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"A pagination cursor to retrieve the next set of results for your\noriginal query to the endpoint.","in":"query","name":"batch_token","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{"Link":{"description":"If returned, there are too many items to return in one request and you must paginate with the supplied link. ","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1Item"},"type":"array"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Provides summary information for all of a location's items.","tags":["V1Items"]},"post":{"deprecated":false,"description":"Creates an item and at least one variation for it.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-items"},"operationId":"CreateItem","parameters":[{"description":"The ID of the location to create an item for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Item"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Creates an item and at least one variation for it.","tags":["V1Items"]}},"/v1/{location_id}/items/{item_id}":{"delete":{"deprecated":false,"description":"Deletes an existing item and all item variations associated with it.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-itemid"},"operationId":"DeleteItem","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to modify.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Deletes an existing item and all item variations associated with it.","tags":["V1Items"]},"get":{"deprecated":false,"description":"Provides the details for a single item, including associated modifier lists and fees.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-itemid"},"operationId":"RetrieveItem","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The item's ID.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Provides the details for a single item, including associated modifier lists and fees.","tags":["V1Items"]},"put":{"deprecated":false,"description":"Modifies the core details of an existing item.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-itemid"},"operationId":"UpdateItem","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to modify.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Item"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Modifies the core details of an existing item.","tags":["V1Items"]}},"/v1/{location_id}/items/{item_id}/fees/{fee_id}":{"delete":{"deprecated":false,"description":"Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-itemid-feeid"},"operationId":"RemoveFee","parameters":[{"description":"The ID of the fee's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to add the fee to.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the fee to apply.","in":"path","name":"fee_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Removes a fee assocation from an item, meaning the fee is no longer automatically applied to the item in Square Register.","tags":["V1Items"]},"put":{"deprecated":false,"description":"Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-itemid-feeid"},"operationId":"ApplyFee","parameters":[{"description":"The ID of the fee's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to add the fee to.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the fee to apply.","in":"path","name":"fee_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Associates a fee with an item, meaning the fee is automatically applied to the item in Square Register.","tags":["V1Items"]}},"/v1/{location_id}/items/{item_id}/modifier-lists/{modifier_list_id}":{"delete":{"deprecated":false,"description":"Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-itemid-modifierlistid"},"operationId":"RemoveModifierList","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the modifier list to remove.","in":"path","name":"modifier_list_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to remove the modifier list from.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Removes a modifier list association from an item, meaning modifier options from the list can no longer be applied to the item.","tags":["V1Items"]},"put":{"deprecated":false,"description":"Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-itemid-modifierlistid"},"operationId":"ApplyModifierList","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the modifier list to apply.","in":"path","name":"modifier_list_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to add the modifier list to.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Item"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Associates a modifier list with an item, meaning modifier options from the list can be applied to the item.","tags":["V1Items"]}},"/v1/{location_id}/items/{item_id}/variations":{"post":{"deprecated":false,"description":"Creates an item variation for an existing item.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-variations"},"operationId":"CreateVariation","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The item's ID.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Variation"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Variation"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Creates an item variation for an existing item.","tags":["V1Items"]}},"/v1/{location_id}/items/{item_id}/variations/{variation_id}":{"delete":{"deprecated":false,"description":"Deletes an existing item variation from an item.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-variationid"},"operationId":"DeleteVariation","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to delete.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the variation to delete.","in":"path","name":"variation_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Variation"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Deletes an existing item variation from an item.","tags":["V1Items"]},"put":{"deprecated":false,"description":"Modifies the details of an existing item variation.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#put-variationid"},"operationId":"UpdateVariation","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the item to modify.","in":"path","name":"item_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the variation to modify.","in":"path","name":"variation_id","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/v1Variation"},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1Variation"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Modifies the details of an existing item variation.","tags":["V1Items"]}},"/v1/{location_id}/modifier-lists":{"get":{"deprecated":false,"description":"Lists all of a location's modifier lists.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-modifierlists"},"operationId":"ListModifierLists","parameters":[{"description":"The ID of the location to list modifier lists for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/v1ModifierList"},"type":"array"}}}}},"security":[{"oauth2":["ITEMS_READ"]}],"summary":"Lists all of a location's modifier lists.","tags":["V1Items"]},"post":{"deprecated":false,"description":"Creates an item modifier list and at least one modifier option for it.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#post-modifierlists"},"operationId":"CreateModifierList","parameters":[{"description":"The ID of the location to create a modifier list for.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ModifierList"}}},"description":"An object containing the fields to POST for the request.\n\nSee the corresponding object definition for field details.","required":true},"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ModifierList"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Creates an item modifier list and at least one modifier option for it.","tags":["V1Items"]}},"/v1/{location_id}/modifier-lists/{modifier_list_id}":{"delete":{"deprecated":false,"description":"Deletes an existing item modifier list and all modifier options associated with it.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#delete-modifierlistid"},"operationId":"DeleteModifierList","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The ID of the modifier list to delete.","in":"path","name":"modifier_list_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/v1ModifierList"}}}}},"security":[{"oauth2":["ITEMS_WRITE"]}],"summary":"Deletes an existing item modifier list and all modifier options associated with it.","tags":["V1Items"]},"get":{"deprecated":false,"description":"Provides the details for a single modifier list.","externalDocs":{"description":"Read the offical documentation here:","url":"https://docs.connect.squareup.com/api/connect/v1/#get-modifierlistid"},"operationId":"RetrieveModifierList","parameters":[{"description":"The ID of the item's associated location.","in":"path","name":"location_id","required":true,"schema":{"type":"string"}},{"description":"The modifier list's ID.","in":"path","name":"modifier_list_id","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","headers":{},"content":{"application/jso