227 lines
5.8 KiB
Markdown
227 lines
5.8 KiB
Markdown
---
|
|
name: orders-routes
|
|
description: Handle 22 OpenAPI operation(s) for the orders route group.
|
|
---
|
|
|
|
# orders API Routes
|
|
|
|
Handle 22 OpenAPI operation(s) for the orders 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
|
|
|
|
### v1_list_orders
|
|
|
|
- Operation ID: `v1_list_orders`
|
|
- Route: `GET /v1/{location_id}/orders`
|
|
- Mode: READ
|
|
- Summary: V1ListOrders
|
|
- Parameters:
|
|
- `location_id` in `path` required
|
|
- `order` in `query`
|
|
- `limit` in `query`
|
|
- `batch_token` in `query`
|
|
|
|
### v1_retrieve_order
|
|
|
|
- Operation ID: `v1_retrieve_order`
|
|
- Route: `GET /v1/{location_id}/orders/{order_id}`
|
|
- Mode: READ
|
|
- Summary: V1RetrieveOrder
|
|
- Parameters:
|
|
- `location_id` in `path` required
|
|
- `order_id` in `path` required
|
|
|
|
### v1_update_order
|
|
|
|
- Operation ID: `v1_update_order`
|
|
- Route: `PUT /v1/{location_id}/orders/{order_id}`
|
|
- Mode: WRITE
|
|
- Summary: V1UpdateOrder
|
|
- Parameters:
|
|
- `location_id` in `path` required
|
|
- `order_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### create_order
|
|
|
|
- Operation ID: `create_order`
|
|
- Route: `POST /v2/orders`
|
|
- Mode: WRITE
|
|
- Summary: CreateOrder
|
|
- Body: JSON request body accepted.
|
|
|
|
### batch_retrieve_orders
|
|
|
|
- Operation ID: `batch_retrieve_orders`
|
|
- Route: `POST /v2/orders/batch-retrieve`
|
|
- Mode: WRITE
|
|
- Summary: BatchRetrieveOrders
|
|
- Body: JSON request body accepted.
|
|
|
|
### calculate_order
|
|
|
|
- Operation ID: `calculate_order`
|
|
- Route: `POST /v2/orders/calculate`
|
|
- Mode: WRITE
|
|
- Summary: CalculateOrder
|
|
- Body: JSON request body accepted.
|
|
|
|
### clone_order
|
|
|
|
- Operation ID: `clone_order`
|
|
- Route: `POST /v2/orders/clone`
|
|
- Mode: WRITE
|
|
- Summary: CloneOrder
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_order_custom_attribute_definitions
|
|
|
|
- Operation ID: `list_order_custom_attribute_definitions`
|
|
- Route: `GET /v2/orders/custom-attribute-definitions`
|
|
- Mode: READ
|
|
- Summary: ListOrderCustomAttributeDefinitions
|
|
- Parameters:
|
|
- `visibility_filter` in `query`
|
|
- `cursor` in `query`
|
|
- `limit` in `query`
|
|
|
|
### create_order_custom_attribute_definition
|
|
|
|
- Operation ID: `create_order_custom_attribute_definition`
|
|
- Route: `POST /v2/orders/custom-attribute-definitions`
|
|
- Mode: WRITE
|
|
- Summary: CreateOrderCustomAttributeDefinition
|
|
- Body: JSON request body accepted.
|
|
|
|
### delete_order_custom_attribute_definition
|
|
|
|
- Operation ID: `delete_order_custom_attribute_definition`
|
|
- Route: `DELETE /v2/orders/custom-attribute-definitions/{key}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteOrderCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
|
|
### retrieve_order_custom_attribute_definition
|
|
|
|
- Operation ID: `retrieve_order_custom_attribute_definition`
|
|
- Route: `GET /v2/orders/custom-attribute-definitions/{key}`
|
|
- Mode: READ
|
|
- Summary: RetrieveOrderCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
- `version` in `query`
|
|
|
|
### update_order_custom_attribute_definition
|
|
|
|
- Operation ID: `update_order_custom_attribute_definition`
|
|
- Route: `PUT /v2/orders/custom-attribute-definitions/{key}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateOrderCustomAttributeDefinition
|
|
- Parameters:
|
|
- `key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_delete_order_custom_attributes
|
|
|
|
- Operation ID: `bulk_delete_order_custom_attributes`
|
|
- Route: `POST /v2/orders/custom-attributes/bulk-delete`
|
|
- Mode: WRITE
|
|
- Summary: BulkDeleteOrderCustomAttributes
|
|
- Body: JSON request body accepted.
|
|
|
|
### bulk_upsert_order_custom_attributes
|
|
|
|
- Operation ID: `bulk_upsert_order_custom_attributes`
|
|
- Route: `POST /v2/orders/custom-attributes/bulk-upsert`
|
|
- Mode: WRITE
|
|
- Summary: BulkUpsertOrderCustomAttributes
|
|
- Body: JSON request body accepted.
|
|
|
|
### search_orders
|
|
|
|
- Operation ID: `search_orders`
|
|
- Route: `POST /v2/orders/search`
|
|
- Mode: WRITE
|
|
- Summary: SearchOrders
|
|
- Body: JSON request body accepted.
|
|
|
|
### retrieve_order
|
|
|
|
- Operation ID: `retrieve_order`
|
|
- Route: `GET /v2/orders/{order_id}`
|
|
- Mode: READ
|
|
- Summary: RetrieveOrder
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
|
|
### update_order
|
|
|
|
- Operation ID: `update_order`
|
|
- Route: `PUT /v2/orders/{order_id}`
|
|
- Mode: WRITE
|
|
- Summary: UpdateOrder
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### list_order_custom_attributes
|
|
|
|
- Operation ID: `list_order_custom_attributes`
|
|
- Route: `GET /v2/orders/{order_id}/custom-attributes`
|
|
- Mode: READ
|
|
- Summary: ListOrderCustomAttributes
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
- `visibility_filter` in `query`
|
|
- `cursor` in `query`
|
|
- `limit` in `query`
|
|
- `with_definitions` in `query`
|
|
|
|
### delete_order_custom_attribute
|
|
|
|
- Operation ID: `delete_order_custom_attribute`
|
|
- Route: `DELETE /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}`
|
|
- Mode: WRITE
|
|
- Summary: DeleteOrderCustomAttribute
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
- `custom_attribute_key` in `path` required
|
|
|
|
### retrieve_order_custom_attribute
|
|
|
|
- Operation ID: `retrieve_order_custom_attribute`
|
|
- Route: `GET /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}`
|
|
- Mode: READ
|
|
- Summary: RetrieveOrderCustomAttribute
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
- `custom_attribute_key` in `path` required
|
|
- `version` in `query`
|
|
- `with_definition` in `query`
|
|
|
|
### upsert_order_custom_attribute
|
|
|
|
- Operation ID: `upsert_order_custom_attribute`
|
|
- Route: `POST /v2/orders/{order_id}/custom-attributes/{custom_attribute_key}`
|
|
- Mode: WRITE
|
|
- Summary: UpsertOrderCustomAttribute
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
- `custom_attribute_key` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### pay_order
|
|
|
|
- Operation ID: `pay_order`
|
|
- Route: `POST /v2/orders/{order_id}/pay`
|
|
- Mode: WRITE
|
|
- Summary: PayOrder
|
|
- Parameters:
|
|
- `order_id` in `path` required
|
|
- Body: JSON request body accepted.
|