{ "opencollection": "1.0.0", "info": { "name": "Addresses Introduction Account Addresses Accounts API", "version": "25.1126.6886238" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "Get All Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/accounts", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Specifies the filter attributes." }, { "name": "page[limit]", "value": "", "type": "query", "description": "The number of records per page." }, { "name": "page[offset]", "value": "", "type": "query", "description": "The number of records to offset the results by." }, { "name": "sort", "value": "", "type": "query", "description": "Specifies the order in which accounts will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting)." } ] }, "docs": "Use this endpoint to Get all accounts.\n\nYou can use pagination with this resource. For more information, see [pagination](/guides/Getting-Started/pagination).\n\n### Filtering\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) accounts:\n\n| Attribute | Operators | Example |\n|-------------------|-------------------------------|----------------------------------------" }, { "info": { "name": "Create an Account", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/accounts", "body": { "type": "json", "data": "{}" }, "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "docs": "With the account creation endpoint, you have the ability to create accounts which can optionally have another account as a parent." }, { "info": { "name": "Get an Account", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." } ] }, "docs": "View a specific account contained within your store" }, { "info": { "name": "Update an Account", "type": "http" }, "http": { "method": "PUT", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the information contained on an account." }, { "info": { "name": "Delete an Account", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." } ] }, "docs": "Delete a specific account within a store" }, { "info": { "name": "Get an Account's Tags Relationship", "type": "http" }, "http": { "method": "GET", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/relationships/account-tags", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." } ] }, "docs": "Get a list of Account Tags on an Account" }, { "info": { "name": "Add Account Tags", "type": "http" }, "http": { "method": "POST", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/relationships/account-tags", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add Account Tags onto an Account. Please note that after adding a tag to an account, the account member token should be regenerated to reflect the updated account status, allowing other services to react accordingly. See [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens)." }, { "info": { "name": "Remove Account Tags", "type": "http" }, "http": { "method": "DELETE", "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/relationships/account-tags", "params": [ { "name": "accountID", "value": "", "type": "path", "description": "The ID of the account you want to retrieve." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove Account Tags from an Account. Please note that after removing a tag from an account, the account member token should be regenerated to reflect the updated status, allowing other services to react accordingly. See [Account Management Authentication Token](/docs/api/accounts/post-v-2-account-members-tokens)." } ] } ], "bundled": true }