Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Elastic Path Customer Addresses API

The API to organize customer addresses.

Elastic Path Customer Addresses API is one of 100 APIs that Elastic Path publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Customer Addresses. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.1.0, at version 25.1126.6886238.

Requests are made against 2 base URLs: https://useast.api.elasticpath.com, https://euwest.api.elasticpath.com.

5 operations 2 paths 10 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
25.1126.6886238
Base URL
https://useast.api.elasticpath.com
Authentication
HTTP Bearer
License
Resource Areas
1

Authentication & Security 1

Elastic Path Customer Addresses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Customer Addresses 5

The API to organize customer addresses.

POST
/v2/customers/{customerID}/addresses
Create a Customer Address
post-v2-customer-address 1 param body → 200201400404
GET
/v2/customers/{customerID}/addresses
Get Customer Addresses
get-v2-customer-addresses 5 params → 200400404
GET
/v2/customers/{customerID}/addresses/{addressID}
Get an Customer Address
get-v2-customer-address 2 params → 200404
PUT
/v2/customers/{customerID}/addresses/{addressID}
Update an Customer Address
put-v2-customer-address 2 params body → 200400404
DELETE
/v2/customers/{customerID}/addresses/{addressID}
Delete a Customer Address
delete-v2-customer-address 2 params → 204404

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Address (14 properties), PaginationLinks (5 properties), PaginationPage (4 properties), Error (4 properties). Each schema is shown below with its type and property counts.

MetaTimestamps
object
1 property
ErrorResponse
object
1 property 1 required
Address
object
14 properties
Error
object
4 properties
AddressResponse
PaginationMeta
object
2 properties
PaginationLinks
object
5 properties
PaginationPage
object
4 properties
PaginationResults
object
2 properties
CustomerAddressResponse

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

elastic-path-customer-addresses-api-openapi.yml Raw ↑

Other APIs Elastic Path publishes across the network.

Elastic Path GraphQL API
Elastic Path Account Addresses API
Elastic Path Account Authentication Settings API
Elastic Path Account Cart Associations API
Elastic Path Account Management Authentication API
Elastic Path Account Members API
Elastic Path Account Membership API
Elastic Path Account Membership Settings API
Elastic Path Account Tags API
Elastic Path Accounts API
Elastic Path Administrator Latest Releases Catalog API API
Elastic Path Application Keys API