Pular para o conteúdo principal
GET
/
product
Get all products of a company
curl --request GET \
  --url https://api.cliquepay.app/product
[
  {
    "id": "0e02a425-32b4-493d-8db6-1a033457b5ee",
    "name": "Produto Bola",
    "description": "Produto muito bom",
    "price": 19.9,
    "sku": "ABCD",
    "displayId": "bolaABCD",
    "shopifyVariantId": "3439480320342",
    "imageUrl": "https://example.com/image.png",
    "companyId": "f96a489c-8a4d-4c7b-a1f6-347acbd832df",
    "status": "ACTIVE",
    "isSubscription": true,
    "defaultPeriod": "MONTHLY",
    "defaultTrialDays": 14,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
]

Query Parameters

​
isSubscription
string
Example:

true

​
name
string
Example:

"Produto Bola"

​
description
string
Example:

"Produto muito bom"

​
price
number
Example:

19.9

​
sku
string
Example:

"ABCD"

​
displayId
string
Example:

"bolaABCD"

​
id
string
Example:

"0e02a425-32b4-493d-8db6-1a033457b5ee"

​
status
string
Example:

"INACTIVE"

​
defaultPeriod
string
Example:

"MONTHLY"

​
defaultTrialDays
number
Example:

7

​
companyId
string
Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

Response

200 - application/json

All products of a company in App

​
id
string
required
Example:

"0e02a425-32b4-493d-8db6-1a033457b5ee"

​
name
string
required
Example:

"Produto Bola"

​
description
string
required
Example:

"Produto muito bom"

​
price
number
required
Example:

19.9

​
companyId
string
required
Example:

"f96a489c-8a4d-4c7b-a1f6-347acbd832df"

​
status
string
required
Example:

"ACTIVE"

​
isSubscription
boolean
required
Example:

true

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
sku
string
Example:

"ABCD"

​
displayId
string
Example:

"bolaABCD"

​
shopifyVariantId
string
Example:

"3439480320342"

​
imageUrl
string
Example:

"https://example.com/image.png"

​
defaultPeriod
string
Example:

"MONTHLY"

​
defaultTrialDays
number
Example:

14

⌘I