List a customer's addresses

GET

https://core.shopimind.com/v1/customers/{customer_id}/addresses

Returns a paginated list of addresses associated with the specified customer. Supports filters, order, limit, offset and fields to refine the response.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key.

Type

string

Required

Pattern

"^[a-zA-Z0-9-]{20,64}$"

Path Parameters

customer_id*

Customer identifier (as provided by the merchant shop).

Type

string

Required

Query Parameters

fields

Subset of address fields to return.

Type

array

Valid values

"address_id""customer_id""first_name""last_name""primary_phone""secondary_phone""company""address_line_1""address_line_2""postal_code""city""country""is_active"

limit

Maximum number of records to return

Type

number

Example10

offset

Number of records to skip

Type

number

Example0

order

Sorting criteria, array of objects with field and type properties

Type

array

Examples

{ "field": "created_at", "type": "desc" }

filters

Filter criteria, array of objects with field, operator and values properties.

Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN

Type

array

Examples

{ "field": "status", "operator": "EQUALS", "values": "active" }

Responses

Paginated listing response.

Content-Type

application/json

{

  

"statusCode": 200,

  

"data": [

  

  

{

  

  

  

"address_id": 1001,

  

  

  

"customer_id": "cust_001",

  

  

  

"first_name": "Marie",

  

  

  

"last_name": "Dupont",

  

  

  

"company": "string",

  

  

  

"address1": "12 rue de la Paix",

  

  

  

"address2": "string",

  

  

  

"postcode": "75002",

  

  

  

"city": "Paris",

  

  

  

"country": "FR",

  

  

  

"phone": "+33612345678"

  

  

}

  

],

  

"meta": {

  

  

"pagination": {

  

  

  

"total_items": 100,

  

  

  

"items_per_page": 10,

  

  

  

"total_pages": 10,

  

  

  

"current_page": 1,

  

  

  

"offset": 0,

  

  

  

"has_previous_page": false,

  

  

  

"has_next_page": true,

  

  

  

"next_page": 2,

  

  

  

"previous_page": 0

  

  

},

  

  

"generated_at": "2024-05-06T14:32:11.000Z"

  

}

}

GET

https://core.shopimind.com/v1/customers/{customer_id}/addresses

Playground

Headers

spm-api-key*

Variables

Key

Value

customer_id*

fields

limit

offset

order

filters

Samples

List a customer's addresses Returns a paginated list of addresses associated with the specified customer. Supports filters, order, limit, offset and fields to refine the response. GET /v1/customers/{customer_id}/addresses listCustomerAddresses Customers spm-api-key [Authentication] Required API key. customer_id Customer identifier (as provided by the merchant shop). fields Subset of address fields to return. limit Maximum number of records to return offset Number of records to skip order Sorting criteria, array of objects with field and type properties filters Filter criteria, array of objects with field, operator and values properties. Available operators: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, LESS_THAN, LESS_THAN_OR_EQUAL_TO, GREATER_THAN, GREATER_THAN_OR_EQUAL_TO, IN, NOT_IN, LIKE, BETWEEN, NOT_BETWEEN Paginated listing response. Client error - Invalid request or authentication issues Server error - Internal processing failure