Search products

curl --request GET \
  --url https://apix.us.amity.co/api/v1/products/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/products/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v1/products/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v1/products/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/products/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": [
    {
      "_id": "64a1b2c3d4e5f6g7h8i9j0k1",
      "productId": "prod-12345",
      "networkId": "network-abc123",
      "productName": "Premium Headphones",
      "productUrl": "https://example.com/products/premium-headphones",
      "status": "active",
      "price": 99.99,
      "currency": "USD",
      "thumbnailUrl": "https://example.com/images/headphones-thumb.jpg",
      "thumbnailMode": "fit",
      "importSource": "manual",
      "createdBy": "user-xyz789",
      "updatedBy": "user-xyz789",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "isDeleted": false
    }
  ],
  "paging": {
    "next": "<string>",
    "previous": "<string>"
  }
}

{
  "status": "error",
  "code": 400300,
  "message": "Forbidden error."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

GET

api

products

Search products

curl --request GET \
  --url https://apix.us.amity.co/api/v1/products/search \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v1/products/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v1/products/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v1/products/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v1/products/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "data": [
    {
      "_id": "64a1b2c3d4e5f6g7h8i9j0k1",
      "productId": "prod-12345",
      "networkId": "network-abc123",
      "productName": "Premium Headphones",
      "productUrl": "https://example.com/products/premium-headphones",
      "status": "active",
      "price": 99.99,
      "currency": "USD",
      "thumbnailUrl": "https://example.com/images/headphones-thumb.jpg",
      "thumbnailMode": "fit",
      "importSource": "manual",
      "createdBy": "user-xyz789",
      "updatedBy": "user-xyz789",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z",
      "isDeleted": false
    }
  ],
  "paging": {
    "next": "<string>",
    "previous": "<string>"
  }
}

{
  "status": "error",
  "code": 400300,
  "message": "Forbidden error."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

keyword

string

Search keyword for product name

Maximum string length: 200

isActive

boolean

Filter by active status

isDeleted

boolean

Filter by deleted status

sortBy

enum<string>

Field to sort by

Available options:

createdAt,

updatedAt,

productName

sortOrder

enum<string>

Sort order

Available options:

asc,

desc

options[limit]

integer

default:20

Maximum number of items to return (1-100)

Required range: 1 <= x <= 100

options[token]

string

Pagination token for fetching next page

Maximum string length: 1000

Response

Successful response with list of products

status

string

Example:

"success"

data

object[]

Show child attributes

paging

object

Show child attributes

Update product Count products

⌘I