Skip to main content

Get Public Basic Product

GET /api/v1/products/{productId}/public/basic

Description​

Retrieve basic public information about a product.

Path Parameters​

NameTypeDescription
productIdstringThe ID of the product (path)

Query Parameters​

NameTypeDescription
fieldNamesstringAllowed fields separated by comma: name, code, status, user, business, tenant, sellingPrice, photos, countryCode, currencyCode, state, city, address, productUnitType, deliveryCapacity (query)

Example​

GET /api/v1/products/12345/public/basic?fieldNames=name,code,status

Response Code: 200 - OK​

Description

Successful retrieval of product information.

Response Fields​

The response contains the requested product fields.

Example​

{
  "name": "Product Name",
  "code": "PRD123",
  "status": "Available",
  "user": "User123",
  "business": "BusinessABC",
  "tenant": "TenantXYZ",
  "sellingPrice": 100.00,
  "photos": ["photo1.jpg", "photo2.jpg"],
  "countryCode": "US",
  "currencyCode": "USD",
  "state": "CA",
  "city": "San Francisco",
  "address": "123 Market Street",
  "productUnitType": "piece",
  "deliveryCapacity": 50
}

Method: GET​

>http://your-api-url/api/v1/products/{productId}/public/basic

Headers​

Content-TypeValue
apiKey{{apiKey}}

🔑 Authentication bearer​

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST

curl --request GET \ 
 --url  /api/v1/products/{productId}/public/basic \ 
 --header 'accept: application/json' \ 
 --header 'content-type: application/json'

RESPONSE

Click Try It! to start a request and see the response here!