Pular para o conteúdo principal
POST
/
product
Create a Product
curl --request POST \
  --url https://api.cliquepay.app/product \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Produto Bola",
  "description": "Produto muito bom",
  "price": 19.9,
  "sku": "ABCD",
  "displayId": "bolaABCD",
  "isSubscription": true,
  "defaultPeriod": "MONTHLY",
  "defaultTrialDays": 14,
  "status": "ACTIVE"
}'
{
  "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"
}

Body

application/json
​
name
string
required
Example:

"Produto Bola"

​
description
string
required
Example:

"Produto muito bom"

​
price
number
required
Example:

19.9

​
sku
string
required
Example:

"ABCD"

​
displayId
string
required
Example:

"bolaABCD"

​
isSubscription
boolean
Example:

true

​
defaultPeriod
string
Example:

"MONTHLY"

​
defaultTrialDays
number
Example:

14

​
status
enum<string>
Available options:
ACTIVE,
INACTIVE
Example:

"ACTIVE"

Response

201 - application/json

Product created

​
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