{
  "opencollection": "1.0.0",
  "info": {
    "name": "Cart Actions Endpoints Customer Address API",
    "version": "3.0.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Customer Address",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Customer's Addresses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The number of records to skip before returning records. For example, when offset is 20 and limit's 10, this endpoint returns records from 21 to 30."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of records per page."
              },
              {
                "name": "sort",
                "value": "",
                "type": "query",
                "description": "The criteria to sort results, where `-` indicates a descending order and `+` indicates an ascending order. You can sort the following fields - `updatedAt`, `country`, `city`, and `region`."
              },
              {
                "name": "isDeleted",
                "value": "",
                "type": "query",
                "description": "A flag indicating whether only the deleted addresses must be included in the response. Set to `true` to include only the deleted addresses of the customers and `false` to exclude the deleted addresses."
              }
            ]
          },
          "docs": "Using this endpoint, you can get all addresses of a customer. <br /> By specifying the query parameters `offset` and `limit`, you can narrow down the search results. You can also `sort` the results in an ascending or descending order. Additionally, with the `isDeleted` query parameter, you can filter for either deleted or non-deleted customers. When no query parameter is specified, by default, you get up to 10 records."
        },
        {
          "info": {
            "name": "Add a New Address",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Using this endpoint, you can add a new address for the customer by `customerId`."
        },
        {
          "info": {
            "name": "Get Customer's Address",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address/:addressId",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              },
              {
                "name": "addressId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer's address."
              }
            ]
          },
          "docs": "Using this endpoint, you can get a single address of a customer based on the `customerId` and `addressId`."
        },
        {
          "info": {
            "name": "Update Customer's Address",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address/:addressId",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              },
              {
                "name": "addressId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer's address."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Using this endpoint, you can update a customer's address based on the `customerId` and `addressId`. This replaces the existing address with the new one. If you want to make only a partial update, use the `PATCH /customers/{customerId}/customer-address/{addressId}` endpoint."
        },
        {
          "info": {
            "name": "Partially Update Customer's Address",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address/:addressId",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              },
              {
                "name": "addressId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer's address."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Using this endpoint, you can partially update a customer's address based on the `customerId` and `addressId`. To fully replace an existing address, use the `PUT /customers/{customerId}/customer-address/{addressId}` endpoint."
        },
        {
          "info": {
            "name": "Delete Customer's Address",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address/:addressId",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              },
              {
                "name": "addressId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer's address."
              }
            ]
          },
          "docs": "Using this endpoint, you can delete an existing address of a customer based on the `customerId` and `addressId`."
        },
        {
          "info": {
            "name": "Search for Customer's Addresses",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.fabric.inc/v3/customers/:customerId/customer-address/search",
            "headers": [
              {
                "name": "x-fabric-tenant-id",
                "value": ""
              },
              {
                "name": "x-fabric-request-id",
                "value": "263e731c-45c8-11ed-b878-0242ac120002"
              }
            ],
            "params": [
              {
                "name": "customerId",
                "value": "",
                "type": "path",
                "description": "A 24-character system-generated ID of the customer. This is returned in the response of the `POST /customers` endpoint."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "With this endpoint, you can search for customer's addresses based on the specified filter conditions. In addition, you can tailor the search results by including or excluding the deleted addresses and the default addresses.<br />**Note**:A customer can have a default address for both billing and shipping."
        }
      ]
    }
  ],
  "bundled": true
}