{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Account Addresses", "type": "folder" }, "items": [ { "info": { "name": "Get Account Addresses", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/addresses", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." }, { "name": "page[offset]", "value": "", "type": "query", "description": "The number of records to offset the results by." }, { "name": "page[limit]", "value": "", "type": "query", "description": "The number of records per page. If not specified, defaults to the `page_length` setting from the Settings API." }, { "name": "page[total_method]", "value": "", "type": "query", "description": "The method used to calculate the total count. `lower_bound` limits expensive count operations, `observed` uses a lightweight +1 fetch strategy that will indicate if there is a next page." }, { "name": "filter", "value": "", "type": "query", "description": "Filter addresses using a simple query language." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get all addresses for an Account.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) addresses:\n\n| Attribute | Operators | Example |\n|----------------|---------------------------------|---------------------------------------|\n| `name` | `eq`,`in`" }, { "info": { "name": "Create an Account Address", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/addresses", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to create an address for." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an address for an Account." }, { "info": { "name": "Get an Account Address", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/addresses/:addressID", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." }, { "name": "addressID", "value": "", "type": "path", "description": "The ID of the address you want to retrieve." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Get a specific address for an Account." }, { "info": { "name": "Update an Account Address", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/addresses/:addressID", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to create an address for." }, { "name": "addressID", "value": "", "type": "path", "description": "The ID of the address you want to update." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Update an address for an Account." }, { "info": { "name": "Delete an Account Address", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/addresses/:addressID", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account that contains the address to delete." }, { "name": "addressID", "value": "", "type": "path", "description": "The ID of the address to delete." } ], "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "Delete an address for an Account." } ] } ], "bundled": true }