Customer Information API
      Back to home
      1. Help Center
      2. API
      3. Customer Information API

      Address API

      Create Address
      URL /Address/Create
      Method POST
      Body

      [
      {
      "AVSChecked": false,
      "AddressLine1": "666 Rio Grande Drive",
      "AddressLine2": "Virginia Beach, VA 23666, United States",
      "AddressName": "Some Name",
      "AddressTypeId": null,
      "AppartmentNumber": null,
      "CustomerId": 8,
      "Description": null,
      "SalespersonId": 1
      }
      ]
      Response
      HTTP/1.1 400 Business rule violation. Address is Required
      HTTP/1.1 200 OK

      [
      {
      "AVSChecked": false,
      "AddressLine1": "666 Rio Grande Drive",
      "AddressLine2": "Virginia Beach, VA 23666, United States",
      "AddressName": "Some Name",
      "AddressTypeId": null,
      "AppartmentNumber": null,
      "CustomerId": 8,
      "Description": null,
      "Id": 8,
      "LastChangeDate": "/Date(1536324651060)/",
      "SalespersonId": 1
      }
      ]
      Comments

       
        Update Address
      URL /Address
      Method PUT
      Body

      {
      "AVSChecked": false,
      "AddressLine1": "666 Rio Grande Drive",
      "AddressLine2": "Virginia Beach, VA 23666, United States",
      "AddressName": "Some Name",
      "AddressTypeId": null,
      "AppartmentNumber": null,
      "CustomerId": 8,
      "Description": null,
      "Id": 8,
      "SalespersonId": 1
      }
      Response
      HTTP/1.1 400 Business rule violation. Address is Required
      HTTP/1.1 200 OK

      [
      {
      "AVSChecked": false,
      "AddressLine1": "666 Rio Grande Drive",
      "AddressLine2": "Virginia Beach, VA 23666, United States",
      "AddressName": "Some Name",
      "AddressTypeId": null,
      "AppartmentNumber": null,
      "CustomerId": 8,
      "Description": null,
      "Id": 8,
      "LastChangeDate": "/Date(1536324651060)/",
      "SalespersonId": 1
      }
      ]
      Comments

       
        Delete Address
      URL /Address/{id}
      Method DELETE
      Body

       
      Response
      HTTP/1.1 400 Entity with 386 id not found
      HTTP/1.1 200 OK
      Comments

       
        Get Address
      URL /Address/List/{customerId}
      Method GET
      Body

       
      Response

      [
      {
      "AVSChecked": false,
      "AddressLine1": "666 Rio Grande Drive",
      "AddressLine2": "Virginia Beach, VA 23666, United States",
      "AddressName": "Some Name",
      "AddressTypeId": null,
      "AppartmentNumber": null,
      "CustomerId": 8,
      "Description": null,
      "Id": 8,
      "LastChangeDate": "/Date(1536324651060)/",
      "SalespersonId": 1
      }
      ]
      Comments

       
        Get Address
      URL /Address/{id}
      Method GET
      Body

       
      Response

      {
      "AVSChecked": false,
      "AddressLine1": "666 Rio Grande Drive",
      "AddressLine2": "Virginia Beach, VA 23666, United States",
      "AddressName": "Some Name",
      "AddressTypeId": null,
      "AppartmentNumber": null,
      "CustomerId": 8,
      "Description": null,
      "Id": 8,
      "LastChangeDate": "/Date(1536324651060)/",
      "SalespersonId": 1
      }
      Comments