{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Custom APIs API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Custom APIs", "type": "folder" }, "items": [ { "info": { "name": "List Custom APIs", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis", "params": [ { "name": "page[offset]", "value": "", "type": "query", "description": "The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used." }, { "name": "page[limit]", "value": "", "type": "query", "description": "The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the [page length](/docs/api/settings/settings-introduction#page-length) store setting is used." }, { "name": "filter", "value": "", "type": "query", "description": "Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the order in which Custom APIs will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n" } ] }, "docs": "Retrieves a list of Custom APIs\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) Custom APIs:\n\n| Attribute | Operators | Example |\n|---------------------|-------------------------------|-----------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,7e067539-6f6c-46e1-8c55-940031b36c6a)` |\n| `created_at` | " }, { "info": { "name": "Create a Custom API", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis", "body": { "type": "json", "data": "{}" } }, "docs": "Create a Custom API" }, { "info": { "name": "Get a Custom API", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." } ] }, "docs": "Get a Custom API" }, { "info": { "name": "Update a Custom API", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Custom API" }, { "info": { "name": "Delete a Custom API", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." } ] }, "docs": "Delete a Custom API" }, { "info": { "name": "Get OpenAPI Specification", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/specifications/openapi" }, "docs": "Generates an OpenAPI specification based on the Custom APIs and Custom Fields configured for the current store.\nThis dynamically generated specification provides typed schemas for the `/v2/extensions/` endpoints.\n" } ] } ], "bundled": true }