Create shopping intent
- Print
- PDF
Create shopping intent
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Available in VPC
Create a profile of a shopping intent.
When you request to create a profile, the creation process will proceed according to the following sequence.
| Order | Creation status | Description |
|---|---|---|
| Step 1 | registered: registered | Status where the creation job is registered in the NCLUE system
|
| Step 2 | pending: pending | Status where the creation job is queued in the system |
| Step 3 | in_progress: creating | Status where the creation job is running on the server |
| Step 4 |
| Status where the creation task has been completed
|
Note
The duration of each job when creating a profile depends on the amount of data and service's available resources. To check the progress of the creation, call the Get shopping intent API and check the status field in the response body.
Request
This section describes the request format. The method and URI are as follows:
| Method | URI |
|---|---|
| POST | /profile/shopping-intents |
Request headers
For information about the headers common to all NCLUE APIs, see NCLUE request headers.
Request body
You can include the following data in the body of your request:
| Field | Type | Required | Description |
|---|---|---|---|
name | String | Required | Profile name
|
task_id | String | Required | Task ID to apply for profiling
|
Request example
The request example is as follows:
curl --location --request POST 'https://nclue.apigw.ntruss.com/api/v1/profile/shopping-intents' \
--header 'X-NCP-APIGW-TIMESTAMP: {Timestamp}' \
--header 'X-NCP-IAM-ACCESS-KEY: {Access Key}' \
--header 'X-NCP-APIGW-SIGNATURE-V2: {API Gateway Signature}' \
--data '{
"name": "YOUR_PROFILE_NAME",
"task_id": "3179664c-****-****-****-af6354344018"
}'
Response
This section describes the response format.
Response body
The response body includes the following data:
| Field | Type | Required | Description |
|---|---|---|---|
profile_id | String | - | Profile ID |
profile_name | String | - | Profile name |
task_id | String | - | Task ID to apply for profiling |
task_name | String | - | Task name to apply for profiling |
created_at | String | - | Profile creation request date and time (ISO 8601 format) |
Response status codes
For response status codes common to NCLUE, see NCLUE response status codes.
Response example
The response example is as follows:
{
"profile_id": "da523192-****-****-****-01fce3b4f90d",
"profile_name": "YOUR_PROFILE_NAME",
"task_id": "3179664c-****-****-****-af6354344018",
"task_name": "YOUR_TASK_NAME",
"created_at": "2024-11-26T16:47:27+09:00"
}
Was this article helpful?