CustomerContact

PreviousCustomerConsent NextCustomerGroup

Was this helpful?

Get contact details for a customer

get

Get contact 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-_]+

customerContactUidstringrequired

Reference to a Customer contact.

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

Responses

application/json

objectoptional

CustomerContactResponseSchema

get

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

200

Example response

{
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "mobile": "text",
  "createdAt": "2025-04-18T01:45:13.549Z",
  "lastModifiedAt": "2025-04-18T01:45:13.549Z",
  "customerContactUid": "text",
  "extensions": [
    {
      "extensionCode": "TWO_INVOICE",
      "organizationUid": "text"
    }
  ],
  "displayName": "text"
}

Delete a contact for a customer

delete

Delete a contact 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-_]+

customerContactUidstringrequired

Reference to a Customer contact.

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

Responses

delete

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

204

No Content

List contacts for a customer

get

List contacts 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}/contacts HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "firstname": "text",
      "lastname": "text",
      "email": "text",
      "mobile": "text",
      "createdAt": "2025-04-18T01:45:13.549Z",
      "lastModifiedAt": "2025-04-18T01:45:13.549Z",
      "customerContactUid": "text",
      "extensions": [
        {
          "extensionCode": "TWO_INVOICE",
          "organizationUid": "text"
        }
      ],
      "displayName": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}

Add a contact for a customer

post

Add a contact 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-_]+

Body

CustomerContactCreateSchema

firstnamestringrequired

lastnamestringrequired

emailstringoptional

mobilestringoptional

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

Responses

application/json

objectoptional

CustomerContactResponseSchema

post

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

{
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "mobile": "text",
  "customerContactUid": "text"
}

200

Example response

{
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "mobile": "text",
  "createdAt": "2025-04-18T01:45:13.549Z",
  "lastModifiedAt": "2025-04-18T01:45:13.549Z",
  "customerContactUid": "text",
  "extensions": [
    {
      "extensionCode": "TWO_INVOICE",
      "organizationUid": "text"
    }
  ],
  "displayName": "text"
}

Update contact details for a customer

put

Update contact 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-_]+

customerContactUidstringrequired

Reference to a Customer contact.

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

Body

CustomerContactUpdateSchema

firstnamestringoptional

lastnamestringoptional

emailstringoptional

mobilestringoptional

Responses

application/json

objectoptional

CustomerContactResponseSchema

put

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

{
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "mobile": "text"
}

200

Example response

{
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "mobile": "text",
  "createdAt": "2025-04-18T01:45:13.549Z",
  "lastModifiedAt": "2025-04-18T01:45:13.549Z",
  "customerContactUid": "text",
  "extensions": [
    {
      "extensionCode": "TWO_INVOICE",
      "organizationUid": "text"
    }
  ],
  "displayName": "text"
}

Add extension to a customer contact

post

Add extension to a customer contact

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

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

tenantUidstringrequired

Reference to a tenant.

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

customerContactUidstringrequired

Reference to a Customer contact.

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

customerExtensionCodestring · enumrequired

ENUM	Description
TWO_INVOICE	The Two Invoice extension.

Available options:

Body

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

Responses

application/json

objectoptional

CustomerContactResponseSchema

post

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

{
  "storeUid": "text"
}

200

Example response

{
  "firstname": "text",
  "lastname": "text",
  "email": "text",
  "mobile": "text",
  "createdAt": "2025-04-18T01:45:13.549Z",
  "lastModifiedAt": "2025-04-18T01:45:13.549Z",
  "customerContactUid": "text",
  "extensions": [
    {
      "extensionCode": "TWO_INVOICE",
      "organizationUid": "text"
    }
  ],
  "displayName": "text"
}

Delete extension from a customer contact

delete

Delete extension from a customer contact

Authorizations

Path parameters

customerUidstringrequired

Reference to a Customer.

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

tenantUidstringrequired

Reference to a tenant.

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

customerContactUidstringrequired

Reference to a Customer contact.

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

customerExtensionCodestring · enumrequired

ENUM	Description
TWO_INVOICE	The Two Invoice extension.

Available options:

Body

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

Responses

delete

DELETE /v2/tenants/{tenantUid}/customers/{customerUid}/contacts/{customerContactUid}/extensions/{customerExtensionCode} HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "storeUid": "text"
}

204

No Content