Create a product

POST /api/v2/products/{shopId}

Create a product

cURL

curl --request POST \
  --url https://api.itemshop.dev/api/v2/products/{shopId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Ranga VIP",
  "serverId": "664f1a2b3c4d5e6f7a8b9c0e",
  "price": 19.99,
  "commands": [
    "lp user {PLAYER} parent set vip"
  ],
  "description": "<string>",
  "shortDescription": "<string>",
  "translations": {},
  "images": [
    "<string>"
  ],
  "compareAtPrice": 29.99,
  "sku": "<string>",
  "requirements": {
    "requirePlayerOnline": true,
    "minecraftVersion": "<string>",
    "permissions": [
      "<string>"
    ]
  },
  "inventory": {
    "trackQuantity": true,
    "quantity": 100,
    "allowBackorder": true
  },
  "isActive": true,
  "isFeatured": true,
  "sortOrder": 123,
  "minQuantity": 1,
  "maxQuantity": 64,
  "stepQuantity": 1,
  "variants": [
    {
      "name": "VIP 30 dni",
      "price": 19.99,
      "commands": [
        "<string>"
      ],
      "description": "<string>",
      "image": "<string>",
      "paymentMethods": [
        {
          "name": "imojeTransfer",
          "priceOverride": 12.99
        }
      ]
    }
  ],
  "packageSuggestions": [
    {
      "quantity": 50,
      "bonus": 5
    }
  ],
  "paymentMethods": [
    {
      "name": "imojeTransfer",
      "priceOverride": 12.99
    }
  ]
}
'

201

{
  "success": true,
  "data": {
    "_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "name": "Ranga VIP",
    "slug": "ranga-vip",
    "price": 19.99,
    "serverId": "664f1a2b3c4d5e6f7a8b9c0d",
    "shopId": "664f1a2b3c4d5e6f7a8b9c0d",
    "commands": [
      "lp user {PLAYER} parent set vip"
    ],
    "isActive": true
  },
  "message": "<string>"
}

Authorizations

apiKeyAuthbearerAuth

X-API-Key · string · header · required

Path Parameters

shopId · string · required

Shop ID (ObjectId)

Body

application/json

name · string · required

Product name

Required string length: 1 - 200

Example:

"Ranga VIP"

serverId · string · required

Server ID (ObjectId)

Example:

"664f1a2b3c4d5e6f7a8b9c0e"

price · number · required

Price

Required range: x >= 0

Example:

19.99

commands · string[] · required

Commands to run (with placeholders)

Minimum array length: 1

Example:

["lp user {PLAYER} parent set vip"]

description · string

Description (HTML/markdown)

Maximum string length: 5000

shortDescription · string

Short description

Maximum string length: 500

translations · object

Per-language translations (key = ISO code)

images · string[]

Direct image links

compareAtPrice · number

Compare-at price

Required range: x >= 0

Example:

29.99

sku · string

SKU

Maximum string length: 100

requirements · object

Requirements

Show child attributes

inventory · object

Inventory

Show child attributes

isActive · boolean

Active

isFeatured · boolean

Featured

sortOrder · number

Sort order

pricingMode · enum<string>

Pricing mode: variants or quantity (slider)

Available options: variants, quantity

minQuantity · number

Minimum quantity (slider)

Required range: x >= 1

Example:

1

maxQuantity · number

Maximum quantity (slider)

Required range: x >= 1

Example:

64

stepQuantity · number

Quantity slider step

Required range: x >= 1

Example:

1

variants · object[]

Selectable variants

Show child attributes

packageSuggestions · object[]

Package suggestion tiles

Show child attributes

paymentMethods · object[]

Assigned payment methods

Show child attributes

Response

201

application/json

OK

success · boolean

Example:

true

data · object

Show child attributes

message · string