Attributes
13 routes. Paths are relative to https://api.intersink.com/v1.
- GET/attributesFetch attributes (can filter by group id in query)
- POST/attributesCreate a new attribute
- PATCH/attributes/{id}Update an attribute
- DELETE/attributes/{id}Delete an attribute
- GET/attributes/dataFetch attribute data assignments
- POST/attributes/dataAssign attribute data to a product/campaign
- PATCH/attributes/data/{id}Update an attribute data assignment
- DELETE/attributes/data/{id}Delete an attribute data assignment
- GET/attributes/groupsFetch all attribute groups
- POST/attributes/groupsCreate a new attribute group
- GET/attributes/groups/{id}Fetch a specific attribute group
- PATCH/attributes/groups/{id}Update an attribute group
- DELETE/attributes/groups/{id}Delete an attribute group
Fetch attributes (can filter by group id in query)
GET/attributes
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| channel_id | string, query | |
| attribute_group | number, query | Filter by attribute group id |
Response
200. data is object[].
Create a new attribute
POST/attributes
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| namerequired | string | |
| attribute_grouprequired | number | Attribute group id (same channel) |
| sort | number |
Response
201. The payload in data is of type object.
Update an attribute
PATCH/attributes/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| name | string | |
| attribute_group | number | Attribute group id (same channel) |
| sort | number |
Response
200. The payload in data is of type object.
Delete an attribute
DELETE/attributes/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Fetch attribute data assignments
GET/attributes/data
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| channel_id | string, query | |
| attribute_id | string, query | |
| product_id | string, query | |
| campaign_id | number, query |
Response
200. data is object[].
Assign attribute data to a product/campaign
POST/attributes/data
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| descriptionrequired | string | |
| attribute_idrequired | string | Attribute uuid (same channel) |
| product_id | string | Product uuid (same channel) |
| campaign_id | number | Campaign id (same channel) |
| sort | number |
Response
201. The payload in data is of type object.
Update an attribute data assignment
PATCH/attributes/data/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| description | string | |
| attribute_id | string | Attribute uuid (same channel) |
| product_id | string | Product uuid (same channel) |
| campaign_id | number | Campaign id (same channel) |
| sort | number |
Response
200. The payload in data is of type object.
Delete an attribute data assignment
DELETE/attributes/data/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.
Fetch all attribute groups
GET/attributes/groups
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| page | number, query | Minimum 1. |
| limit | number, query | Minimum 1, maximum 100. |
| channel_id | string, query |
Response
200. data is object[].
Create a new attribute group
POST/attributes/groups
Needs a signed-in user (Bearer token or access_token cookie).
Request body application/json
| Field | Type | Description |
|---|---|---|
| namerequired | string | |
| sort | number |
Response
201. The payload in data is of type object.
Fetch a specific attribute group
GET/attributes/groups/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is of type object.
Update an attribute group
PATCH/attributes/groups/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| name | string | |
| sort | number |
Response
200. The payload in data is of type object.
Delete an attribute group
DELETE/attributes/groups/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | number, path |
Response
200. The payload in data is not described in the spec yet.