Customer group

Endpoints

Create new customer group

/companies/{companycode}/customer-groups

Description

Returns created customer group.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

Group

Responses

HTTP Code Description Schema

201

Successfully created

Group

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get entity list

/companies/{companycode}/customer-groups

Description

Returns entities.

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Query

page
optional

Page index

integer (int32)

Query

size
optional

Entity count per page

integer (int32)

Responses

HTTP Code Description Schema

200

Successfull

< Group > array

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Import entity list

/companies/{companycode}/customer-groups/import

Parameters

Type Name Description Schema Business Rules

Path

companyCode
required

Current context company code

string

2 characters max

Body

body
required

ImportCustomerGroupList

Responses

HTTP Code Description Schema

202

Accepted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Consumes

  • application/json

Produces

  • application/json

Get one customer group

/companies/{companycode}/customer-groups/{code}

operation.deprecated

Description

Returns retrieved customer group.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity code to retrieve

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Responses

HTTP Code Description Schema

200

Successful

Group

404

Entity not found

No Content

500

Internal server error

No Content

Produces

  • application/json

Delete customer group

/companies/{companycode}/customer-groups/{code}

Description

In fact disable this entity.

Parameters

Type Name Description Schema Business Rules

Path

code
required

Entity public uuid code to delete

string

10 characters max

Path

companyCode
required

Current context company code

string

2 characters max

Responses

HTTP Code Description Schema

204

Succefully deleted

No Content

400

Functionnal error

No Content

500

Internal server error

No Content

Produces

  • application/json

Data structure

Customer group

The data structure is composed with Group with a particular business rule for the code :
10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end

ImportCustomerGroupList

Name Value

callback
optional

string

data
optional

Group list with a particular business rule for the code :
10 characters max
All characters in uppercase accepted except characters \ ; | " < > µ and spaces at the beginning and at the end