Product notes
Use these methods to obtain information about the notes added to products.
The notes can include additional information about trading accounts that clients can open based on a product. The clients can view the notes before opening trading accounts in the B2Core UI.
GET[host]/api/v2/my/products/{productId}/preferences |
|
GET[host]/api/v2/my/products/{productId}/preferences/{preferenceId} |
Get a list of product notes
Use this method to obtain a list of notes added to a specific product.
Request
Header parameters:
Authorization: Bearer <token>
Query parameters:
The following filter parameter is available for this method:
- title
The title specified for a product note.
The following sorting parameter is available for this method:
- createTime
The date and time when a note was added to a product.
Refer to the Query parameters section in the API Overview for details on applying filter and sorting parameters.
Path parameters:
- productId required
The product identifier.
GET[host]/api/v2/my/products/{productId}/preferences
curl --location -g 'https://host.name/api/v2/my/products/1/preferences?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[title]=title' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'
Response
A response includes an array of Product Note objects providing information about the notes matching the request parameters.
Get product note details
Use this method to obtain detailed information about a specific note added to a product.
Request
Header parameters:
Authorization: Bearer <access_token>
Path parameters:
- productId required
The product identifier.
- preferenceId required
The identifier of a product note.
GET[host]/api/v2/my/products/{productId}/preferences/{preferenceId}
curl --location 'https://host.name/api/v2/my/products/1/preferences/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'
Response
A response contains a Product Note object providing information about the specified note.