Customer Group Relations
Manage shipping customer groups
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Resource successfully retrieved.
Unauthorized
Some server side error occurred.
GET /shipping/{tenant}/{site}/cgrelations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"customerId": "C001",
"groupId": "group1"
},
{
"customerId": "C002",
"groupId": "group2"
}
]Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Customer-group relation allows to assign user for specific group.
Customer's unique identifier.
Group's unique identifier.
Resource successfully created.
Request syntactically incorrect. Any details will be provided within the response payload.
Unauthorized
Given authorization scopes are not sufficient and do not match required scopes.
The requested resource does not exist.
Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.
Some server side error occurred.
POST /shipping/{tenant}/{site}/cgrelations HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"customerId": "C001",
"groupId": "group1"
}{
"id": "group1"
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Customer's unique identifier generated when the customer's account is created through the Customer Service.
Resource successfully retrieved.
Unauthorized
Some server side error occurred.
GET /shipping/{tenant}/{site}/cgrelations/{customerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"customerId": "C001",
"groupId": "group1"
}Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Customer's unique identifier generated when the customer's account is created through the Customer Service.
Customer-group relation allows to assign user for specific group.
Customer's unique identifier.
Group's unique identifier.
Resource successfully updated.
Unauthorized
Given authorization scopes are not sufficient and do not match required scopes.
Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.
Some server side error occurred.
PUT /shipping/{tenant}/{site}/cgrelations/{customerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40
{
"customerId": "C001",
"groupId": "group1"
}No content
Your Emporix tenant's name.
Note: The tenant should always be written in lowercase.
^[a-z][a-z0-9]+$Site’s unique identifier. A site is a specific shop.
If the tenant owns only one shop, the value should be set to main.
Customer's unique identifier generated when the customer's account is created through the Customer Service.
Resource successfully deleted.
Unauthorized
Given authorization scopes are not sufficient and do not match required scopes.
Some server side error occurred.
DELETE /shipping/{tenant}/{site}/cgrelations/{customerId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?