Product API Documentation

As the name suggests, business are a core part of Pazh — the very reason Pazh exists is so you can have secure conversations with your business. On this page, we'll dive into the different contact endpoints you can use to manage business programmatically. We'll look at how to query, create, update, and delete business.

GET/v1/business

Properties

This endpoint allows you to retrieve a paginated list of all your business. By default, a maximum of ten business are shown per page.

Name
id
Type
string
Description
identifier for the product.
Name
publicId
Type
string
Description
Public identifier for the product.
Name
slug
Type
string
Description
identifier for the product.
Name
title
Type
object
Description
The name of the product.
Name
eng
Type
string
Description
The name of the product in English.
Name
per
Type
string
Description
The name of the product in Persian.
Name
arb
Type
string
Description
The name of the product in Arabic.
Name
description
Type
object
Description
The description of the product.
Name
eng
Type
string
Description
The description of the product in English.
Name
per
Type
string
Description
The description of the product in Persian.
Name
arb
Type
string
Description
The description of the product in Arabic.
Name
image
Type
string
Description
The url image for the product.
Name
category
Type
string
Description
The category for the product.
Name
tags
Type
array
Description
The tags of the product.
Name
media
Type
array
Description
The url media for the product.
Name
time
Type
string
Description
Time of the media.
Name
title
Type
string
Description
Title for the media.
Name
src
Type
string
Description
Address of the media.
Name
type
Type
string
Description
Type for the media.
Name
position
Type
string
Description
position for the media.
Name
attributes
Type
object
Description
details of the product.
Name
weight
Type
string
Description
Weight of the product.
Name
weight_unit
Type
string
Description
Weight unit of the product.
Name
variants
Type
array
Description
Variants of the product.
Name
id
Type
string
Description
Identifier for the product.
Name
productId
Type
string
Description
Identifier for the product.
Name
title
Type
string
Description
Title for the product.
Name
sku
Type
string
Description
Stock keeping unit for the product.
Name
barcode
Type
string
Description
Barcode for the product.
Name
position
Type
string
Description
Position for the product.
Name
option
Type
object
Description
Options for the product.
Name
color
Type
string
Description
Color of the product.
Name
ram
Type
string
Description
Ram of the product.
Name
contentId
Type
object
Description
The content identifier of the product.
Name
eng
Type
string
Description
The content identifier of the product in English.
Name
per
Type
string
Description
The content identifier of the product in Persian.
Name
arb
Type
string
Description
The content identifier of the product in Arabic.
Name
brandId
Type
string
Description
The brand identifier of the product
Name
claimed
Type
boolean
Description
Show if its verified by its owner.
Name
status
Type
string
Description
Situation of the product.
Name
date
Type
string
Description
Time updated.
Name
version
Type
string
Description
Version.
Name
author-id
Type
string
Description
Identifier for the author.

Response

{
"id": "XXXXXXXXXXXXXXXXXXXXXXX",
"publicId": "XXXXXXXXXXXXXXXXXXX",
"slug":"",
"title": {
  "eng": "Product Name",
  "per": "",
  "arb": ""
},
"description": {
  "eng": "Your perfect pack for everyday use and walks in the forest. Stash your laptop (up to 15 inches) in the padded sleeve, your everyday",      ,
  "per": "",
  "arb": ""
},
"image" : "https://srv.webstatic.net/photo.jpg",
"category": "",
"tags": [
  ""
],
"media": [
  {
    "time": "2018-01-08T12:34:47-05:00",
    "title": "Product Name",
    "src": "http://example.com/photo.jpg",
    "type": "image", //video //audio //image
    "position": 1
  }
],
"attributes": {
    "weight": 0.2,
    "weight_unit": "kg",
},
"variants": [
  {
    "id": 39072856,
    "productId": 632910392,
    "title": "Green",
    "sku": "IPOD2008GREEN",
    "barcode": "XXXXXXXXXXXXX",
    "position": 1,
    "option":{
      "color": "",
      "ram": ""
    }
  }
],
"contentId": {
  "eng": "XXXXXXXXXXXXXXXXXXXXXXX",
  "per": "XXXXXXXXXXXXXXXXXXXXXXX",
  "arb": "XXXXXXXXXXXXXXXXXXXXXXX"
},
"brandId": "",
"claimed": true,
"status": "deleted",
"date": "2023-02-15T12:50:30",
"version": "1",
"authorId": ""
}

GET/v1/product

List all products

This endpoint allows you to retrieve a paginated list of all your products. By default, a maximum of ten products are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of product returned.

Request

GET

/v1/product

curl -G https://api.contentapi.io/v1/product \
  -H "Authorization: Bearer {token}" \
  -d active=true \
  -d limit=10