5.8 KiB
5.8 KiB
name, description
| name | description |
|---|---|
| locations-routes | Handle 20 OpenAPI operation(s) under /v2/locations for the locations route group. |
locations API Routes
Handle 20 OpenAPI operation(s) under /v2/locations for the locations route group.
Use the generated operation tools to make real API calls. Do not invent API responses. If a tool reports missing setup, return the exact setup field name to the caller. For write, update, or delete operations, state the intended action before calling the tool.
Operations
list_locations
- Operation ID:
list_locations - Route:
GET /v2/locations - Mode: READ
- Summary: ListLocations
create_location
- Operation ID:
create_location - Route:
POST /v2/locations - Mode: WRITE
- Summary: CreateLocation
- Body: JSON request body accepted.
list_location_custom_attribute_definitions
- Operation ID:
list_location_custom_attribute_definitions - Route:
GET /v2/locations/custom-attribute-definitions - Mode: READ
- Summary: ListLocationCustomAttributeDefinitions
- Parameters:
visibility_filterinquerylimitinquerycursorinquery
create_location_custom_attribute_definition
- Operation ID:
create_location_custom_attribute_definition - Route:
POST /v2/locations/custom-attribute-definitions - Mode: WRITE
- Summary: CreateLocationCustomAttributeDefinition
- Body: JSON request body accepted.
delete_location_custom_attribute_definition
- Operation ID:
delete_location_custom_attribute_definition - Route:
DELETE /v2/locations/custom-attribute-definitions/{key} - Mode: WRITE
- Summary: DeleteLocationCustomAttributeDefinition
- Parameters:
keyinpathrequired
retrieve_location_custom_attribute_definition
- Operation ID:
retrieve_location_custom_attribute_definition - Route:
GET /v2/locations/custom-attribute-definitions/{key} - Mode: READ
- Summary: RetrieveLocationCustomAttributeDefinition
- Parameters:
keyinpathrequiredversioninquery
update_location_custom_attribute_definition
- Operation ID:
update_location_custom_attribute_definition - Route:
PUT /v2/locations/custom-attribute-definitions/{key} - Mode: WRITE
- Summary: UpdateLocationCustomAttributeDefinition
- Parameters:
keyinpathrequired
- Body: JSON request body accepted.
bulk_delete_location_custom_attributes
- Operation ID:
bulk_delete_location_custom_attributes - Route:
POST /v2/locations/custom-attributes/bulk-delete - Mode: WRITE
- Summary: BulkDeleteLocationCustomAttributes
- Body: JSON request body accepted.
bulk_upsert_location_custom_attributes
- Operation ID:
bulk_upsert_location_custom_attributes - Route:
POST /v2/locations/custom-attributes/bulk-upsert - Mode: WRITE
- Summary: BulkUpsertLocationCustomAttributes
- Body: JSON request body accepted.
retrieve_location
- Operation ID:
retrieve_location - Route:
GET /v2/locations/{location_id} - Mode: READ
- Summary: RetrieveLocation
- Parameters:
location_idinpathrequired
update_location
- Operation ID:
update_location - Route:
PUT /v2/locations/{location_id} - Mode: WRITE
- Summary: UpdateLocation
- Parameters:
location_idinpathrequired
- Body: JSON request body accepted.
create_checkout
- Operation ID:
create_checkout - Route:
POST /v2/locations/{location_id}/checkouts - Mode: WRITE
- Summary: CreateCheckout
- Parameters:
location_idinpathrequired
- Body: JSON request body accepted.
list_location_custom_attributes
- Operation ID:
list_location_custom_attributes - Route:
GET /v2/locations/{location_id}/custom-attributes - Mode: READ
- Summary: ListLocationCustomAttributes
- Parameters:
location_idinpathrequiredvisibility_filterinquerylimitinquerycursorinquerywith_definitionsinquery
delete_location_custom_attribute
- Operation ID:
delete_location_custom_attribute - Route:
DELETE /v2/locations/{location_id}/custom-attributes/{key} - Mode: WRITE
- Summary: DeleteLocationCustomAttribute
- Parameters:
location_idinpathrequiredkeyinpathrequired
retrieve_location_custom_attribute
- Operation ID:
retrieve_location_custom_attribute - Route:
GET /v2/locations/{location_id}/custom-attributes/{key} - Mode: READ
- Summary: RetrieveLocationCustomAttribute
- Parameters:
location_idinpathrequiredkeyinpathrequiredwith_definitioninqueryversioninquery
upsert_location_custom_attribute
- Operation ID:
upsert_location_custom_attribute - Route:
POST /v2/locations/{location_id}/custom-attributes/{key} - Mode: WRITE
- Summary: UpsertLocationCustomAttribute
- Parameters:
location_idinpathrequiredkeyinpathrequired
- Body: JSON request body accepted.
list_transactions
- Operation ID:
list_transactions - Route:
GET /v2/locations/{location_id}/transactions - Mode: READ
- Summary: ListTransactions
- Parameters:
location_idinpathrequiredbegin_timeinqueryend_timeinquerysort_orderinquerycursorinquery
retrieve_transaction
- Operation ID:
retrieve_transaction - Route:
GET /v2/locations/{location_id}/transactions/{transaction_id} - Mode: READ
- Summary: RetrieveTransaction
- Parameters:
location_idinpathrequiredtransaction_idinpathrequired
capture_transaction
- Operation ID:
capture_transaction - Route:
POST /v2/locations/{location_id}/transactions/{transaction_id}/capture - Mode: WRITE
- Summary: CaptureTransaction
- Parameters:
location_idinpathrequiredtransaction_idinpathrequired
void_transaction
- Operation ID:
void_transaction - Route:
POST /v2/locations/{location_id}/transactions/{transaction_id}/void - Mode: WRITE
- Summary: VoidTransaction
- Parameters:
location_idinpathrequiredtransaction_idinpathrequired