v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-10-2916802.4 MB

🛒 Ecommerce

Get all addresses

The API endpoint allows a logged-in user to retrieve all the addresses saved in their profile within an e-commerce application.

By accessing this endpoint, the user can retrieve a list of their saved addresses, that have been previously stored in their account.

This functionality enables users to conveniently access and manage their saved addresses for a seamless checkout experience, eliminating the need to repeatedly enter address information for each transaction.

get/ecommerce/addresses

Query parameters

pagestring

Example:1

limitstring

Example:10

Response

Get all addresses

messagestring

statusCodenumber

successboolean

Example response

{
  "data": {
    "addresses": [
      {
        "__v": 0,
        "_id": "649e792a64e7dba29b72666d",
        "addressLine1": "67725 Bernadine Causeway",
        "addressLine2": "Franey Highway",
        "city": "Devanfurt",
        "country": "Uzbekistan",
        "createdAt": "2023-06-30T06:41:46.395Z",
        "owner": "649e792964e7dba29b72633e",
        "pincode": "159233",
        "state": "Louisiana",
        "updatedAt": "2023-06-30T06:41:46.395Z"
      },
      {
        "__v": 0,
        "_id": "649e792a64e7dba29b7266a7",
        "addressLine1": "63583 Heller Mill",
        "addressLine2": "Carole Path",
        "city": "North Jarvismouth",
        "country": "Cayman Islands",
        "createdAt": "2023-06-30T06:41:46.397Z",
        "owner": "649e792964e7dba29b72633e",
        "pincode": "448547",
        "state": "West Virginia",
        "updatedAt": "2023-06-30T06:41:46.397Z"
      }
    ],
    "limit": 10,
    "page": 1,
    "serialNumberStartFrom": 1,
    "totalAddresses": 2,
    "totalPages": 1
  },
  "message": "Addresses fetched successfully",
  "statusCode": 200,
  "success": true
}