Address Management

The Address Management section provides functionalities for adding, updating, and managing delivery addresses. It ensures that your customers can specify where they want their purchases delivered and manage their multiple addresses if needed.

Included APIs:

1. Add Delivery Address: Lets users add a new delivery address, useful for users who have multiple shipping locations.

2. Get Address Details: Retrieves all saved addresses for a user, allowing them to choose a shipping address during checkout.

3. Update Address: Allows users to modify an existing address, keeping their delivery information up to date.

4. Delete Address: Users can remove an unwanted address, simplifying their address list.

5. Set Default Address: Designates one of the saved addresses as the default, streamlining the checkout process by pre-selecting the user's preferred shipping address.

1. Add Delivery Address

Good to know: Krepling Pay is equipped to manage intricate data structures associated with your customers. This capability allows users to manage multiple addresses and establish default shipping preferences efficiently.

• Endpoint: POST /api/Address/AddAddress

• Purpose: Adds a new delivery address for the user.

• Request Body:

{
  "StreetAddress1": "123 Main St",
  "City": "Anytown",
  "State": "Anystate",
  "ZipCode": "12345",
  "Country": "USA",
  "UserId": "4936"
}

Response:

• Status 200: Address added successfully.

{
  "status": 1,
  "message": "Address added successfully"
}

2. Get Address Details

• Endpoint: GET /api/Address/GetAddresses

• Purpose: Retrieves all saved addresses for a given user, allowing them to manage and select from multiple addresses easily. This API is particularly useful for users with multiple delivery locations or those looking to verify their saved addresses.

• Request Parameters:

  • Type: UserId

  • Values: int (The user's unique identifier)

• Response:

[
  {
    "addressId": 6387,
    "streetAddress1": "1007 Mountain Drive",
    "streetAddress2": "",
    "isDefault": true,
    "userId": null,
    "isDeleted": false,
    "city": "Gotham City",
    "state": "Bruce Wayne",
    "country": "GC",
    "zipCode": "37408",
    "billingAddress": false,
    "billingAddress1": null,
    "billingAddress2": null,
    "billingCity": null,
    "billingState": null,
    "billingZipCode": null,
    "billingCountry": null
  },
  {
    "addressId": 6388,
    "streetAddress1": "1007 Mountain Drive",
    "streetAddress2": "Wayne Manor",
    "isDefault": false,
    "userId": null,
    "isDeleted": false,
    "city": "Gotham City",
    "state": "Bruce Wayne",
    "country": "GC",
    "zipCode": "37408",
    "billingAddress": false,
    "billingAddress1": null,
    "billingAddress2": null,
    "billingCity": null,
    "billingState": null,
    "billingZipCode": null,
    "billingCountry": null
  },
  {
    "addressId": 6389,
    "streetAddress1": "1007 Mountain Drive",
    "streetAddress2": "Wayne Manor",
    "isDefault": false,
    "userId": null,
    "isDeleted": false,
    "city": "Gotham City",
    "state": "Bruce Wayne",
    "country": "GC",
    "zipCode": "37408",
    "billingAddress": false,
    "billingAddress1": null,
    "billingAddress2": null,
    "billingCity": null,
    "billingState": null,
    "billingZipCode": null,
    "billingCountry": null
  }
]

Tip: This API can automatically retrieve the default address if no specific address ID is provided, ensuring users always have quick access to their primary delivery location. However, if no default has been set, and an address ID is not specified, an error will be returned.

3. Update Address

• Endpoint: POST /api/Address/UpdateAddress

• Purpose: Allows users to edit their saved addresses, ensuring their delivery information is always accurate and up-to-date. This API is crucial for maintaining the integrity of user data and facilitating smooth delivery processes.

• Request Details:

  • Method: POST

  • URL: api/Address/UpdateAddress

  • Body:

{
  "AddressId": 9388,
  "StreetAddress1": "344 Clinton Street",
  "StreetAddress2": "Apt. 3B",
  "IsDefault": false,
  "UserId": "7901",
  "IsDeleted": false,
  "City": "Metropolis City",
  "State": "Metropolis",
  "Country": "USA",
  "ZipCode": "210011",
  "BillingAddress": false,
  "BillingAddress1": "344 Clinton Street",
  "BillingAddress2": "APT. 3B",
  "BillingCity": "Metropolis City",
  "BillingState": "Metropolis",
  "BillingZipCode": "210011",
  "BillingCountry": "USA"
}

Response:

{
  "status": 200,
  "message": "Address Updated Successfully.",
  "id": 571,
  "streetAddress1": "344 Clinton Street",
  "streetAddress2": "APT. 3B",
  "country": null,
  "isDefault": false,
  "isDeleted": false,
  "userId": 9,
  "objTblUser": null,
  "city": null,
  "state": null,
  "zipCode": null
}

4. Delete Delivery Address

• Endpoint: POST /api/Address/DeleteAddress

• Purpose: Allows for the removal of a user's saved address from their account, ensuring users can manage their address book effectively.

• Request Body:

{
  "AddressId": "443",
  "UserId": "4878"
}

Response:

{
  "status": 200,
  "message": "Address Deleted Successfully",
  "addressesVM": []
}

5. Set Default Address

Good to know: Setting a default address simplifies the purchase process for returning customers, leading to a higher conversion rate as it reduces the steps needed to complete a transaction.

• POST /api/Address/SetDefaultAddress

• Purpose: Designates a specific address as the default for shipping, streamlining the checkout process.

• Request Body:

{
  "Id": 614,
  "UserId": 4878,
  "IsDefault": true
}

Response:

{
  "status": 200,
  "message": "Set Address as Default Successfully"
}