> ## Documentation Index > Fetch the complete documentation index at: https://spreecommerce.org/docs/llms.txt > Use this file to discover all available pages before exploring further. # List addresses this cart may use > Everything a checkout address step may offer for this cart: the buyer's own address book, plus the address book of the company set as the cart's `company_id` — that company's own sites and the ones it inherits from the companies above it. Only addresses in a country the cart's market sells to are listed. Requires a signed-in customer, unlike the rest of the cart endpoints. The response is the account's address books rather than the cart's own data, so a guest cart token is not accepted here. A guest cart has neither book and would get an empty list in any case. Each entry carries the `owner` it was filed under — the customer, or the company node that owns the site — so a picker can group and label them from one response. An inherited site names the node above, not the one the cart is for. Any address returned here is accepted as `shipping_address_id` or `billing_address_id` on the cart, so the picker and the cart cannot disagree. Curating either book stays with `/store/customers/me/addresses` and `/store/companies/{company_id}/addresses`. ## Filters Filter with `q[_]=value`, for example `q[address1_cont]=…`. Send a list as `q[_in][]=a&q[_in][]=b`. [How filters work](https://spreecommerce.org/docs/api-reference/store-api/querying.md#which-filters-an-endpoint-accepts). | Attribute | Kind | Predicates | | - | - | - | | `address1` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `address2` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `city` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `company` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `country_code` | One of the `CountryCode` codes | `eq` `not_eq` `in` `not_in` `null` `not_null` | | `created_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` | | `first_name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `id` | Prefixed ID | `eq` `not_eq` `in` `not_in` `null` `not_null` | | `last_name` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `phone` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `postal_code` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `state_code` | Text | `eq` `not_eq` `in` `not_in` `cont` `i_cont` `not_cont` `start` `end` `null` `not_null` `present` `blank` | | `updated_at` | Date and time | `eq` `not_eq` `in` `not_in` `lt` `lteq` `gt` `gteq` `null` `not_null` | **Sort by:** `address1`, `address2`, `city`, `company`, `country_code`, `created_at`, `first_name`, `id`, `last_name`, `phone`, `postal_code`, `state_code`, `updated_at`. Prefix a field with `-` to sort descending. ## OpenAPI ````yaml /api-reference/store.yaml get /api/v3/store/carts/{cart_id}/addresses openapi: 3.0.3 info: title: Store API contact: name: Spree Commerce url: https://spreecommerce.org email: hello@spreecommerce.org description: > Spree Store API v3 - Customer-facing storefront API for building headless commerce experiences. ## Authentication The Store API uses two authentication methods: ### API Key (Required) All requests must include a publishable API key in the `x-spree-api-key` header. ### JWT Bearer Token (For authenticated customers) After login, include the JWT token in the `Authorization: Bearer ` header. ### Order Token (For guest checkout) When creating an order, a `token` is returned. Include this in the `x-spree-token` header for guest access to that specific order. ## Response Format All responses are JSON. List endpoints return paginated responses with `data` and `meta` keys. ## Error Handling Errors return a consistent format: ```json { "error": { "code": "record_not_found", "message": "Product not found" } } ``` version: v3 servers: - url: http://{defaultHost} variables: defaultHost: default: localhost:3000 security: [] tags: - name: Authentication description: Customer authentication (login, logout, token refresh) - name: Product Catalog description: Products and categories - name: Carts description: Shopping cart management - name: Orders description: Order lookup - name: Customers description: Customer account, addresses, saved payment methods, and order history - name: Markets description: Markets, countries, currencies, and locales - name: Wishlists description: Customer wishlists - name: Newsletter Subscribers description: Guest and customer newsletter subscriptions (double opt-in) - name: Policies description: Store policies (return policy, privacy policy, terms of service) - name: Digitals description: Digital product downloads paths: /api/v3/store/carts/{cart_id}/addresses: parameters: - name: cart_id in: path required: true description: Cart prefixed ID schema: type: string get: tags: - Carts summary: List addresses this cart may use description: > Everything a checkout address step may offer for this cart: the buyer's own address book, plus the address book of the company set as the cart's `company_id` — that company's own sites and the ones it inherits from the companies above it. Only addresses in a country the cart's market sells to are listed. Requires a signed-in customer, unlike the rest of the cart endpoints. The response is the account's address books rather than the cart's own data, so a guest cart token is not accepted here. A guest cart has neither book and would get an empty list in any case. Each entry carries the `owner` it was filed under — the customer, or the company node that owns the site — so a picker can group and label them from one response. An inherited site names the node above, not the one the cart is for. Any address returned here is accepted as `shipping_address_id` or `billing_address_id` on the cart, so the picker and the cart cannot disagree. Curating either book stays with `/store/customers/me/addresses` and `/store/companies/{company_id}/addresses`. parameters: - name: x-spree-api-key in: header required: true schema: type: string - name: Authorization in: header required: true schema: type: string - name: page in: query required: false schema: type: integer - name: limit in: query required: false schema: type: integer - name: q in: query required: false style: deepObject explode: true schema: type: object additionalProperties: true description: >- Attribute filters, as `q[_]=value`. See Filters above for the list. responses: '200': description: addresses found content: application/json: example: data: - id: addr_UkLWZg9DAJ label: null first_name: John last_name: Doe full_name: John Doe address1: 362 Lovely Street address2: Northwest postal_code: '10118' city: New York phone: 555-555-0199 company: Company country_name: United States country_code: US state_text: NY state_code: NY quick_checkout: false is_default_billing: false is_default_shipping: true state_abbr: NY country_iso: US state_name: New York owner: id: cust_UkLWZg9DAJ type: customer name: null - id: addr_gbHJdmfrXB label: null first_name: John last_name: Doe full_name: John Doe address1: 363 Lovely Street address2: Northwest postal_code: '10118' city: New York phone: 555-555-0199 company: Company country_name: United States country_code: US state_text: NY state_code: NY quick_checkout: false is_default_billing: true is_default_shipping: false state_abbr: NY country_iso: US state_name: New York owner: id: cust_UkLWZg9DAJ type: customer name: null - id: addr_EfhxLZ9ck8 label: null first_name: John last_name: Doe full_name: John Doe address1: 364 Lovely Street address2: Northwest postal_code: '10118' city: New York phone: 555-555-0199 company: Company country_name: United States country_code: US state_text: NY state_code: NY quick_checkout: false is_default_billing: false is_default_shipping: false state_abbr: NY country_iso: US state_name: New York owner: id: cust_UkLWZg9DAJ type: customer name: null meta: page: 1 limit: 25 count: 3 pages: 1 from: 1 to: 3 in: 3 previous: null next: null schema: type: object properties: data: type: array items: $ref: '#/components/schemas/Address' meta: $ref: '#/components/schemas/PaginationMeta' '401': description: not authenticated content: application/json: example: error: code: authentication_required message: Authentication required schema: $ref: '#/components/schemas/ErrorResponse' '404': description: cart not found content: application/json: example: error: code: record_not_found message: Cart not found schema: $ref: '#/components/schemas/ErrorResponse' security: - api_key: [] bearer_auth: [] x-codeSamples: - lang: javascript label: Spree SDK source: |- import { createClient } from '@spree/sdk' const client = createClient({ baseUrl: 'https://your-store.com', publishableKey: '', }) const addresses = await client.carts.addresses.list( 'cart_abc123', {}, { token: '', }, ) components: schemas: Address: type: object properties: id: type: string label: type: string nullable: true first_name: type: string nullable: true last_name: type: string nullable: true full_name: type: string address1: type: string nullable: true address2: type: string nullable: true postal_code: type: string nullable: true city: type: string nullable: true phone: type: string nullable: true company: type: string nullable: true country_name: type: string country_code: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GT - GU - GW - GY - HK - HN - HR - HT - HU - ID - IE - IL - IM - IN - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW state_text: type: string nullable: true state_code: type: string nullable: true quick_checkout: type: boolean is_default_billing: type: boolean is_default_shipping: type: boolean state_abbr: type: string nullable: true deprecated: true country_iso: type: string deprecated: true state_name: type: string nullable: true owner: allOf: - $ref: '#/components/schemas/AddressOwner' nullable: true required: - id - label - first_name - last_name - full_name - address1 - address2 - postal_code - city - phone - company - country_name - country_code - state_text - state_code - quick_checkout - is_default_billing - is_default_shipping - state_abbr - country_iso - state_name - owner x-typelizer: true PaginationMeta: type: object properties: page: type: integer example: 1 limit: type: integer example: 25 count: type: integer example: 100 description: Total number of records pages: type: integer example: 4 description: Total number of pages from: type: integer example: 1 description: Index of first record on this page to: type: integer example: 25 description: Index of last record on this page in: type: integer example: 25 description: Number of records on this page previous: type: integer nullable: true example: null description: Previous page number next: type: integer nullable: true example: 2 description: Next page number required: - page - limit - count - pages - from - to - in ErrorResponse: type: object properties: error: type: object properties: code: type: string example: record_not_found message: type: string example: Record not found details: type: object description: Field-specific validation errors nullable: true example: name: - is too short - is required email: - is invalid required: - code - message required: - error example: error: code: validation_error message: Validation failed details: name: - is too short email: - is invalid AddressOwner: type: object properties: id: type: string type: anyOf: - type: string enum: - customer - company - seller - type: string description: The values listed are the built-in ones; extensions may add more. name: type: string nullable: true required: - id - type - name x-typelizer: true securitySchemes: api_key: type: apiKey name: x-spree-api-key in: header description: Publishable API key for store access bearer_auth: type: http scheme: bearer bearerFormat: JWT description: JWT token for authenticated customers ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.