143 lines
4.1 KiB
Markdown
143 lines
4.1 KiB
Markdown
---
|
|
name: merchants-routes
|
|
description: Handle 13 OpenAPI operation(s) under /v2/merchants for the merchants route group.
|
|
---
|
|
|
|
# merchants API Routes
|
|
|
|
Handle 13 OpenAPI operation(s) under /v2/merchants for the merchants 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_merchants
|
|
|
|
- Operation ID: `list_merchants`
|
|
- Route: `GET /v2/merchants`
|
|
- Mode: READ
|
|
- Summary: ListMerchants
|
|
- Parameters:
|
|
- `cursor` in `query`
|
|
|
|
### list_merchant_custom_attribute_definitions
|
|
|
|
- Operation ID: `list_merchant_custom_attribute_definitions`
|
|
- Route: `GET /v2/merchants/custom-attribute-definitions`
|
|
- Mode: READ
|
|
- Summary: ListMerchantCustomAttributeDefinitions
|
|
- Parameters:
|
|
- `visibility_filter` in `query`
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
|
|
### create_merchant_custom_attribute_definition
|
|
|
|
- Operation ID: `create_merchant_custom_attribute_definition`
|
|
- Route: `POST /v2/merchants/custom-attribute-definitions`
|
|
- Mode: WRITE
|
|
- Summary: CreateMerchantCustomAttributeDefinition
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_merchant_custom_attribute_definition
|
|
|
|
- Operation ID: `delete_merchant_custom_attribute_definition`
|
|
- Route: `DELETE /v2/merchants/custom-attribute-definitions/{key}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteMerchantCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
|
|
### retrieve_merchant_custom_attribute_definition
|
|
|
|
- Operation ID: `retrieve_merchant_custom_attribute_definition`
|
|
- Route: `GET /v2/merchants/custom-attribute-definitions/{key}`
|
|
- Mode: READ
|
|
- Summary: RetrieveMerchantCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
- `version` in `query`
|
|
|
|
### update_merchant_custom_attribute_definition
|
|
|
|
- Operation ID: `update_merchant_custom_attribute_definition`
|
|
- Route: `PUT /v2/merchants/custom-attribute-definitions/{key}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateMerchantCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_delete_merchant_custom_attributes
|
|
|
|
- Operation ID: `bulk_delete_merchant_custom_attributes`
|
|
- Route: `POST /v2/merchants/custom-attributes/bulk-delete`
|
|
- Mode: WRITE
|
|
- Summary: BulkDeleteMerchantCustomAttributes
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_upsert_merchant_custom_attributes
|
|
|
|
- Operation ID: `bulk_upsert_merchant_custom_attributes`
|
|
- Route: `POST /v2/merchants/custom-attributes/bulk-upsert`
|
|
- Mode: WRITE
|
|
- Summary: BulkUpsertMerchantCustomAttributes
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_merchant
|
|
|
|
- Operation ID: `retrieve_merchant`
|
|
- Route: `GET /v2/merchants/{merchant_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveMerchant
|
|
- Parameters:
|
|
- `merchant_id` in `path` required
|
|
|
|
### list_merchant_custom_attributes
|
|
|
|
- Operation ID: `list_merchant_custom_attributes`
|
|
- Route: `GET /v2/merchants/{merchant_id}/custom-attributes`
|
|
- Mode: READ
|
|
- Summary: ListMerchantCustomAttributes
|
|
- Parameters:
|
|
- `merchant_id` in `path` required
|
|
- `visibility_filter` in `query`
|
|
- `limit` in `query`
|
|
- `cursor` in `query`
|
|
- `with_definitions` in `query`
|
|
|
|
### delete_merchant_custom_attribute
|
|
|
|
- Operation ID: `delete_merchant_custom_attribute`
|
|
- Route: `DELETE /v2/merchants/{merchant_id}/custom-attributes/{key}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteMerchantCustomAttribute
|
|
- Parameters:
|
|
- `merchant_id` in `path` required
|
|
- `key` in `path` required
|
|
|
|
### retrieve_merchant_custom_attribute
|
|
|
|
- Operation ID: `retrieve_merchant_custom_attribute`
|
|
- Route: `GET /v2/merchants/{merchant_id}/custom-attributes/{key}`
|
|
- Mode: READ
|
|
- Summary: RetrieveMerchantCustomAttribute
|
|
- Parameters:
|
|
- `merchant_id` in `path` required
|
|
- `key` in `path` required
|
|
- `with_definition` in `query`
|
|
- `version` in `query`
|
|
|
|
### upsert_merchant_custom_attribute
|
|
|
|
- Operation ID: `upsert_merchant_custom_attribute`
|
|
- Route: `POST /v2/merchants/{merchant_id}/custom-attributes/{key}`
|
|
- Mode: WRITE
|
|
- Summary: UpsertMerchantCustomAttribute
|
|
- Parameters:
|
|
- `merchant_id` in `path` required
|
|
- `key` in `path` required
|
|
- Body: JSON request body accepted.
|