CustomerAddress

PreviousCustomer NextCustomerConsent

Was this helpful?

Get address details for a customer

get

Get address details for a customer.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

customerAddressUidstringrequired

Reference to a Customer address.

Pattern: ^[A-Za-z0-9-_]+

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/customers/{customerUid}/addresses/{customerAddressUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

CustomerAddressResponse

{
  "address": "text",
  "city": "text",
  "companyName": "text",
  "firstname": "text",
  "lastname": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "postalCode": "text",
  "type": "DELIVERY_ADDRESS",
  "customerAddressUid": "text",
  "displayName": "text"
}

Delete an address for a customer

delete

Delete an address for a customer.

Required permission: TENANT.BACKOFFICE

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

customerAddressUidstringrequired

Reference to a Customer address.

Pattern: ^[A-Za-z0-9-_]+

Responses

delete

DELETE /v2/tenants/{tenantUid}/customers/{customerUid}/addresses/{customerAddressUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

204

No Content

List addresses for a customer

get

List addresses for a customer.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegeroptional

Reference to a specific page in a result set.

pageSizeintegeroptional

The number of items per page in a result set.

sortBystringoptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumoptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Available options:

Responses

application/json

objectoptional

get

GET /v2/tenants/{tenantUid}/customers/{customerUid}/addresses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

CustomerAddressListResponse

{
  "items": [
    {
      "address": "text",
      "city": "text",
      "companyName": "text",
      "firstname": "text",
      "lastname": "text",
      "countryCode": "text",
      "email": "text",
      "phone": "text",
      "postalCode": "text",
      "type": "DELIVERY_ADDRESS",
      "customerAddressUid": "text",
      "displayName": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add an address for a customer

post

Add an address for a customer.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Body

addressstringoptional

citystringoptional

companyNamestringoptional

firstnamestringoptional

lastnamestringoptional

countryCodestringoptional

emailstringoptional

phonestringoptional

postalCodestringoptional

typestring · enumrequiredAvailable options:

customerAddressUidstringoptionalPattern: ^[A-Za-z0-9-_]+

Responses

application/json

objectoptional

post

POST /v2/tenants/{tenantUid}/customers/{customerUid}/addresses HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "address": "text",
  "city": "text",
  "companyName": "text",
  "firstname": "text",
  "lastname": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "postalCode": "text",
  "type": "DELIVERY_ADDRESS",
  "customerAddressUid": "text"
}

200

CustomerAddressResponse

{
  "address": "text",
  "city": "text",
  "companyName": "text",
  "firstname": "text",
  "lastname": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "postalCode": "text",
  "type": "DELIVERY_ADDRESS",
  "customerAddressUid": "text",
  "displayName": "text"
}

Update address details for a customer

put

Update details for a customer. Partial updates are allowed.

Required permission: TENANT.ACCESS

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

Pattern: ^[A-Za-z0-9-_]+

tenantUidstringrequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

customerAddressUidstringrequired

Reference to a Customer address.

Pattern: ^[A-Za-z0-9-_]+

Body

addressstringoptional

citystringoptional

companyNamestringoptional

countryCodestringoptional

firstnamestringoptional

lastnamestringoptional

emailstringoptional

phonestringoptional

postalCodestringoptional

typestring · enumoptionalAvailable options:

Responses

application/json

objectoptional

put

PUT /v2/tenants/{tenantUid}/customers/{customerUid}/addresses/{customerAddressUid} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "address": "text",
  "city": "text",
  "companyName": "text",
  "countryCode": "text",
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "phone": "text",
  "postalCode": "text",
  "type": "DELIVERY_ADDRESS"
}

200

CustomerAddressResponse

{
  "address": "text",
  "city": "text",
  "companyName": "text",
  "firstname": "text",
  "lastname": "text",
  "countryCode": "text",
  "email": "text",
  "phone": "text",
  "postalCode": "text",
  "type": "DELIVERY_ADDRESS",
  "customerAddressUid": "text",
  "displayName": "text"
}