{
  "opencollection": "1.0.0",
  "info": {
    "name": "Addresses Introduction Account Addresses Account Membership API",
    "version": "25.1126.6886238"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Account Membership",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all Account Memberships",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships",
            "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": "include",
                "value": "",
                "type": "query",
                "description": "Parameter to retrieve more information about any related resources like account members."
              },
              {
                "name": "accountID",
                "value": "",
                "type": "path",
                "description": "The ID of the account for which you want to get the list of unassigned account members."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting)."
              }
            ]
          },
          "docs": "You can also use `include=account_member` to retrieve details about the account members associated with the account memberships. With this option, you can get more information about the account members such as name and email in a single request. For more information see [including resources](/guides/Getting-Started/includes).\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) account memberships.\n\n| Operator | Description |\n| :"
        },
        {
          "info": {
            "name": "Create an Account Membership",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships",
            "params": [
              {
                "name": "accountID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account that the account is associated with."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": ":::caution\n\nYou can only create up to 1000 account memberships in an account.\n\n:::\n"
        },
        {
          "info": {
            "name": "Get a List of Account Memberships of Account Member",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/account-members/:accountMemberId/account-memberships",
            "params": [
              {
                "name": "filter",
                "value": "",
                "type": "query",
                "description": "Specifies the filter attributes."
              },
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Parameter to retrieve more information about any related resources like accounts."
              },
              {
                "name": "accountMemberId",
                "value": "",
                "type": "path",
                "description": "The ID of the account member for which you want to list the memberships."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the order in which account memberships will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting)."
              }
            ]
          },
          "docs": "You can also use `include=account` to retrieve details about the accounts associated with the account memberships. For more information see [including resources](/guides/Getting-Started/includes).\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) account memberships.\n\n| Operator | Description |\n| :--- | :--- "
        },
        {
          "info": {
            "name": "Get a List of Unassigned Account Members",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/unassigned-account-members",
            "params": [
              {
                "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": "filter",
                "value": "",
                "type": "query",
                "description": "Specifies the filter attributes."
              },
              {
                "name": "accountID",
                "value": "",
                "type": "path",
                "description": "The ID of the account for which you want to get the list of unassigned account members."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "Specifies the order in which unassigned account members will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting)."
              }
            ]
          },
          "docs": "Use this resource to get a list of all account members that are not assigned to an account.\n\n### Filtering\n\nThe following operators and attributes are available for [filtering](/guides/Getting-Started/filtering) unassigned account members.\n\n| Operator | Description   |\n| :------- | :--------------------------------------------------------------------------------------------------- |\n| `eq`     | Checks whether the values of two operands are equal. If the values are equal, the condition is true. "
        },
        {
          "info": {
            "name": "Get an Account Membership",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/:membershipID",
            "params": [
              {
                "name": "include",
                "value": "",
                "type": "query",
                "description": "Parameter to retrieve more information about any related resources like account members."
              },
              {
                "name": "accountID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account that the account member is associated with."
              },
              {
                "name": "membershipID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account membership to update the details of the account member."
              }
            ]
          },
          "docs": "Get an account membership from an account in your store.\n\nYou can also use `include=account_member` to retrieve details about the account member associated with this account membership. With this option, you can get more information about the account member such as name and email in a single request. For more information see [including resources](/guides/Getting-Started/includes).\n"
        },
        {
          "info": {
            "name": "Update an Account Membership",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/:membershipID",
            "params": [
              {
                "name": "accountID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account that the account member is associated with."
              },
              {
                "name": "membershipID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account membership to update the details of the account member."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "You can update and extend an account member details using [core flows](/docs/api/flows/flows#extend-an-existing-resource). However, you cannot update the `account_member_id` of an account member."
        },
        {
          "info": {
            "name": "Delete an Account Membership",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://useast.api.elasticpath.com/v2/accounts/:accountID/account-memberships/:membershipID",
            "params": [
              {
                "name": "accountID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account that the account member is associated with."
              },
              {
                "name": "membershipID",
                "value": "",
                "type": "path",
                "description": "The unique identifier of the account membership to update the details of the account member."
              }
            ]
          },
          "docs": "Delete a membership from an account"
        }
      ]
    }
  ],
  "bundled": true
}