{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Custom Fields API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Custom Fields", "type": "folder" }, "items": [ { "info": { "name": "List Custom Fields", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id/fields", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." }, { "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 Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).\n" } ] }, "docs": "Retrieves a list of Custom Fields\n\n## Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) Custom Fields:\n\n| Attribute | Operators | Example |\n|---------------|-------------------------------|-----------------------------------------------|\n| `id` | `lt`,`le`,`eq`,`gt`,`ge`,`in` | `eq(id,859aeba1-03c2-4822-bd4c-89afce93d7eb)` |\n| `created_at` | `lt`,`le`,`eq`,`gt`," }, { "info": { "name": "Create a Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id/fields", "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": "Create a Custom Field" }, { "info": { "name": "Get a Custom Field", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id/fields/:custom-field-id", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." }, { "name": "custom-field-id", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "type": "path", "description": "The unique identifier of the Custom Field." } ] }, "docs": "Get a Custom Field" }, { "info": { "name": "Update a Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id/fields/:custom-field-id", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." }, { "name": "custom-field-id", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "type": "path", "description": "The unique identifier of the Custom Field." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Custom Field" }, { "info": { "name": "Delete a Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom-api-id/fields/:custom-field-id", "params": [ { "name": "custom-api-id", "value": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "path", "description": "The unique identifier of the Custom API." }, { "name": "custom-field-id", "value": "859aeba1-03c2-4822-bd4c-89afce93d7eb", "type": "path", "description": "The unique identifier of the Custom Field." } ] }, "docs": "Delete a Custom Field" } ] } ], "bundled": true }