CustomerContact | Flow Retail Docs

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

Possible values:

Responses

200

Example response

application/json

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-07-30T17:19:18.781Z",
      "lastModifiedAt": "2025-07-30T17:19:18.781Z",
      "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

200

Example response

application/json

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-07-30T17:19:18.781Z",
  "lastModifiedAt": "2025-07-30T17:19:18.781Z",
  "customerContactUid": "text",
  "extensions": [
    {
      "extensionCode": "TWO_INVOICE",
      "organizationUid": "text"
    }
  ],
  "displayName": "text"
}

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

200

Example response

application/json

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-07-30T17:19:18.781Z",
  "lastModifiedAt": "2025-07-30T17:19:18.781Z",
  "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

200

Example response

application/json

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-07-30T17:19:18.781Z",
  "lastModifiedAt": "2025-07-30T17:19:18.781Z",
  "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

204

No Content

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

No content

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.

Possible values:

Body

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

Responses

200

Example response

application/json

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-07-30T17:19:18.781Z",
  "lastModifiedAt": "2025-07-30T17:19:18.781Z",
  "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.

Possible values:

Body

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

Responses

204

No Content

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

No content