Zid Docs

Create Question

POST

v1/products/{product_id}/questions

Questions & Answers

Create a new question for a specified product.

🔑Scopes

products.read_write - Products Read & Write

Request

Path Params

product_id

string

required

Header Params

Authorization

string

required

The Authorization token is a unique key given to the third-party application (Partner) by Zid. It is used to authenticate the API requests made by the Partner application. The token verifies the partner's identity and ensures they have permission to access Zid's API but does not provide any specific user or store information. It should be included in the header of API requests when the partner application needs to access Zid's API.

Example:

Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y

Store-Id

number

required

Example:

37213

Role

enum<string>

required

Role of the user.

Allowed values:

ManagerCustomer

Example:

Manager

Content-Type

enum<string>

required

The Media Type of the body of the request. This is used to describe the structure of the data in the body.

Allowed values:

application/jsonmultipart/form-dataapplication/x-www-form-urlencoded

Default:

application/json

User-Agent

string

optional

The User-Agent header contains information about the user agent (browser or app) making the request. It allows the server to provide a tailored response depending on the user agent's capabilities and preferences.

Example:

Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36

Body Params application/json

name

string

optional

The name of the customer asking the question.

Example:

"anonymous customer"

string

optional

The email address of the customer.

Example:

"anon_customer@email.com"

question

string

optional

The content of the question.

Example:

"What about another question?"

Example

{
  "name": "\"anonymous customer\"",
  "email": "\"anon_customer@email.com\"",
  "question": "\"What about another question?\""
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.zid.sa/v1/products//questions' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxMTciLCJqdGkiOiJhMTg5ZTg3MmYxMzhkMWVhYjU5MjVkMDkyMGE5NmI0YjliNjg0Y2E2ZTdmM2M2MjljZWYxNmQ4NDJjMmJlYmVhMjI4YTdmMTA0ZWQ4NWE5NCIsImlhdCI6MTY3OTU3Njk5OS41NjY4NzcsIm5iZiI6MTY3OTU3Njk5OS41NjY4OCwiZXhwIjoxNzExMTk5Mzk5LjQ4NjE1Mywic3ViIjoiMTgyNDc1Iiwic2NvcGVzIjpbInRoaXJkLXBhcnRpZXMtYXBpcyJdfQ.i07ef09nVNXGZF-g-QXpNoS2vlFQK_zntAqAMS4Az2XD2EyMLhxLZZRL-QlR11zUPqMmXjMAl_4ooKa3M3zkfZQ6Ga6qStvamk8RnC_39VUx0lfN2A4k65ERZpqwrMy6-t3dE99zay3aicIdNvbgi0zeuMSE5Tn99u-2AtSRa8ffbfAcYPPXacHrhdmlYzdiZS_x_skovFEow1E-nDjdL1WHqO92XdZ7RfNLkiYFTjZlZmM_UruvioaR3q6TXJbqRK_ZrziivezL8ohIQ2SBosUp58I29rlKzvlw_R2j0rKKYZbdxYDaxAHOISmOFKAlO66k7dNevAHI3s4uGIjoGA6ZXHknccWPLLLiaAQ0r64HV8GowW5dg2rhZNurJGDTnLlBQ6F-ql42ptHzSAfzzi576CEoN3gMVpgXcbntUY3reETkFsTBPUjeSuMpANMioXAA0GRp3Ut-84fTnrWxqsCW1WVUIx33HvmfCGPXIdkaCCWoA6G6KXo04MtFbKXQmXkK9esQWI-rqdVnMD3zSR3g3yFHZSL1U-mZeNja03706Rav1ordsRNOtRwtLuoRRbk9KasbUpEwqq4Ao9lqZZwRIjdEw-pQtnUT8V53fhmuuRIefCLFO7eGEtGUnh9o6Uh_pgi6AB6uSlnN9GEMGgI1alqvMmTjxvC-HHt0V-Y' \
--header 'Store-Id;' \
--header 'Role;' \
--header 'User-Agent;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "\"anonymous customer\"",
    "email": "\"anon_customer@email.com\"",
    "question": "\"What about another question?\""
}'

Responses

🟢200Question created successfully.

application/json

Body

string

optional

The unique identifier of the created question.

Example:

"cf2fc926-d179-4330-8fff-330853416aea",

store

string

optional

The unique identifier of the store.

Example:

"3dfc16e6-ad19-4126-9c2a-5e4a7fb73051"

product

string

optional

The unique identifier of the product.

Example:

"678c40b4-3989-4623-b4c2-61d29066e6ab"

product_name

string

optional

The name of the product.

Example:

"i phone"

customer

null

optional

Information about the customer (if available).

name

string

optional

The name of the customer asking the question.

Example:

"anonymous customer"

string

optional

The email address of the customer.

Example:

"anon_customer@email.com"

is_anonymous

boolean

optional

Indicates if the question is asked anonymously.

Default:

true

is_owner

boolean

optional

Indicates if the question is created by the store owner.

Default:

false

is_published

boolean

optional

Indicates if the question is published.

Default:

false

is_sent

boolean

optional

Indicates if the question is sent for approval.

Default:

false

is_new

boolean

optional

Indicates if the question is new.

Default:

true

question

string

optional

Example:

"What is ZID?"

created_at

string

optional

The timestamp of when the question was created.

Example:

"2024-07-12T06:28:34.765167Z"

answers

array [object]

optional

A list of answers associated with the question.

Example

{
  "id": "\"cf2fc926-d179-4330-8fff-330853416aea\",",
  "store": "\"3dfc16e6-ad19-4126-9c2a-5e4a7fb73051\"",
  "product": "\"678c40b4-3989-4623-b4c2-61d29066e6ab\"",
  "product_name": "\"i phone\"",
  "customer": null,
  "name": "\"anonymous customer\"",
  "email": "\"anon_customer@email.com\"",
  "is_anonymous": true,
  "is_owner": false,
  "is_published": false,
  "is_sent": false,
  "is_new": true,
  "question": "\"What is ZID?\"",
  "created_at": "\"2024-07-12T06:28:34.765167Z\"",
  "answers": [
    {}
  ]
}

Modified at 2025-01-23 08:12:03

List Question Answers

Create Answer