Creëer
Maakt een nieuwe productvraag aan en stuurt de aangemaakte productvraag terug.
Request
URL
Name | Value |
Method | POST |
Endpoint |
Body
Deze API-methode accepteert een JSON body in het verzoek. Het top-level JOSN object moet een "Productvraag" object zijn zoals beschreven in de volgende sectie.
Product question
Als "is_verified" eigenschap fout is, sturen we een verificatie e-mail naar de klant. Als de klant zijn e-mailadres via deze e-mail verifieert, of wanneer je "is_verified" op waar zet (bijvoorbeeld wanneer je het e-mailadres al hebt geverifieerd), is de vraag zichtbaar in je inbox.
De eigenschap "is_published" bepaalt of de vraag (en het antwoord) publiekelijk beschikbaar is op ons platform (bijvoorbeeld: in onze productwidget). Dit kan alleen waar zijn als er ook een antwoord wordt gegeven.
Property | Allowed values | Required |
text | (A non-empty string, max 1000 characters) | yes |
answer | (A non-empty string, max 1000 characters) | no |
is_published | true, false | yes |
is_verified | true, false | yes |
customer | (A "Customer" object) | yes |
product | (A "Product" object) | yes |
Product
Name | Allowed values | Required |
external_id | (A non-empty string, max 250 characters) | Yes |
name | (A non-empty string, max 250 characters) | Yes |
url | (A valid url, max 2000 characters) | Yes |
sku | (A non-empty string, max 250 characters) | No |
gtin | (A valid GTIN-13 code) | No |
image_url | (A valid url, max 2000 characters) | No |
Customer
Name | Allowed values | Required |
(A valid email address, max 250 characters) | Yes | |
fullname | (A non-empty string, max 250 characters) | No |
Voorbeeld
POST /api/v2/product-questions HTTP/1.1
Authorization: Bearer ...
{
"text": "Is this product washable?",
"answer": null,
"is_published": false,
"is_verified": true,
"product": {
"external_id": "tshirt055",
"name": "Pretty blue t-shirt (small)",
"url": "https://www.example.com/products/tshirt055",
"sku": "tshirt055"
},
"customer": {
"fullname": "Jane Applepie",
"email": "janeapplepie1995@example.com"
}
}
Response
Headers
Name | Value |
Status code | 201 |
Status message | Created |
Body
De gecreëerde productvraag.
Voorbeeld
HTTP/1.1 201 Created
{
"success": true,
"product_question": {
"id": 88,
"text": "Is this product washable?",
"answer": null,
"answered_at": null,
"is_published": false,
"published_at": null,
"created_at": "2018-09-09T09:09:09Z",
"updated_at": null,
"product_id": 1000105,
"customer_id": 3681500
}
}
List
Geeft een lijst met productvragen.
Request
URL
Name | Value |
Method | GET |
Endpoint |
Parameters
Name | Allowed values | Required |
page | (An integer greater than 0, default: 1) | No |
page_size | (An integer between 1 and 1000, default: 25) | No |
sort | (A valid sort value, see table below, default: "-created_at") | No |
Allowed sort values:
Value | Description |
created_at | Sorts on created datetime, ascending. |
-created_at | Sorts on created datetime, descending. |
product_name | Sorts on product name, ascending. |
-product_name | Sorts on product name, descending. |
Voorbeeld
GET /api/v2/product-questions?sort=-created_at&page=1 HTTP/1.1
Authorization: Bearer ...
Response
Headers
Name | Value |
Status code | 200 |
Status message | OK |
Voorbeeld
HTTP/1.1 200 OK
{
"meta": {
"count": 23
},
"success": true,
"product_questions": [{
"id": 88,
"text": "Is this product washable?",
"answer": null,
"answered_at": null,
"is_published": false,
"published_at": null,
"created_at": "2018-09-09T09:09:09Z",
"updated_at": null,
"product_id": 1000105,
"customer_id": 3681500
}, {
...
}]
}
Get
Geeft een productvraag terug.
Request
URL
URL
Het eindpunt voor deze API-methode bevat een <id> plaatshouder. Vervang deze door de waarde van een actuele productvraag id.
Name | Value |
Method | GET |
Endpoint |
Voorbeeld
GET /api/v2/product-questions/88 HTTP/1.1
Authorization: Bearer ...
Response
Headers
Name | Value |
Status code | 200 |
Status message | OK |
Voorbeeld
HTTP/1.1 200 OK
{
"success": true,
"product_question": {
"id": 88,
"text": "Is this product washable?",
"answer": null,
"answered_at": null,
"is_published": false,
"published_at": null,
"created_at": "2018-09-09T09:09:09Z",
"updated_at": null,
"product_id": 1000105,
"customer_id": 3681500
}
}
Update
Update een productvraag en retourneert de bijgewerkte versie.
Request
URL
Name | Value |
Method | PATCH |
Endpoint |
Body
Alleen de eigenschappen die u wilt updaten moeten worden aangeleverd, andere eigenschappen blijven onaangeroerd. De "is_published" eigenschap kan alleen op waar worden gezet als de vraag een antwoord heeft.
Property | Allowed values | Required |
text | (A non-empty string, max 1000 characters) | No |
answer | (A non-empty string, max 1000 characters) | No |
is_published | true, false | No |
Voorbeeld
PATCH /api/v2/product-questions/88 HTTP/1.1
Authorization: Bearer ...
{
"answer": "Yes you can!",
"is_published": true
}
Response
Headers
Name | Value |
Status code | 200 |
Status message | OK |
Voorbeeld
HTTP/1.1 200 OK
{
"success": true,
"product_question": {
"id": 88,
"text": "Is this product washable?",
"answer": "Yes you can!",
"answered_at": "2018-10-10T10:10:10Z",
"is_published": true,
"published_at": "2018-10-10T10:10:10Z",
"created_at": "2018-09-09T09:09:09Z",
"updated_at": "2018-10-10T10:10:10Z",
"product_id": 1000105,
"customer_id": 3681500
}
}
Delete
Deletes a product question.
Request
URL
Name | Value |
Method | DELETE |
Endpoint |
Voorbeeld
DELETE /api/v2/product-questions/88 HTTP/1.1
Authorization: Bearer ...
Response
Headers
Name | Value |
Status code | 200 |
Status message | OK |
Voorbeeld
HTTP/1.1 200 OK
{
"success": true
}