List addresses

Overview

Addresses store shipping and billing information for customers. Each address can be marked as default and associated with subscriptions for fulfillment.


How It Works

  1. Create an address - Add a shipping or billing address for a customer
  2. Set as default - Mark an address as the customer's default
  3. Use for fulfillment - Associate addresses with subscriptions for shipping

Example: A customer adds their home address for magazine delivery. Later, they add a work address and set it as default for future subscriptions.


API Endpoints

MethodEndpointDescription
GET/api/v1/core/addressesList all addresses
POST/api/v1/core/addressesCreate an address
GET/api/v1/core/addresses/{id}Get an address
PUT/api/v1/core/addresses/{id}Update an address
DELETE/api/v1/core/addresses/{id}Delete an address

Address Types

TypeDescription
shippingDelivery address for physical products
billingAddress used for invoicing and payments

Related Endpoints

Language
Credentials
Click Try It! to start a request and see the response here!