Create a package

Creates a new package.

post

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Body

application/jsontext/jsonapplication/*+json

This class is used to present the package command request data transfer object.

codestring · min: 1Required

The code of the package.

namestring · min: 1Required

The name of the package.

imageURLstring · uri | nullableOptional

The image URL of the package.

patternAvatarURLstring · uri | nullableOptional

The pattern avatar URL of the package.

stylesstring | nullableOptional

The styles of the package. This value is a JSON string.

descriptionstring | nullableOptional

The description of the package.

tagsstring | nullableOptional

The tags of the package.

zOrderinteger · int64Optional

The order of the package. By default, the value is 1.

isFreebooleanOptional

Flag to indicate if the package is free.

isDefaultbooleanOptional

Flag to indicate if the package is default. By default, the value is false.

Responses

201

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

403

The user's access was denied.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/packages HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 385

{
  "code": "BASIC001",
  "name": "Basic Package",
  "imageURL": "https://cdn.jframework.io/packages/basic-package.jpg",
  "patternAvatarURL": "https://cdn.jframework.io/packages/basic-pattern.png",
  "styles": "{\"color\":\"#007BFF\",\"layout\":\"grid\"}",
  "description": "This is a basic package suitable for individual users.",
  "tags": "starter,individual,basic",
  "zOrder": 1,
  "isFree": false,
  "isDefault": true
}

application/jsontext/jsonapplication/*+json

{
  "success": true,
  "statusCode": 201,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "code": "CODE",
    "name": "NAME",
    "imageURL": "IMAGE",
    "patternAvatarURL": "https://www.example.com/pattern.jpg",
    "styles": "{\"color\": \"red\"}",
    "description": "DESCRIPTION",
    "tags": "TAGS",
    "isFree": true,
    "zOrder": 1,
    "features": [
      {
        "title": "Feature Title",
        "unit": "Unit",
        "quantity": 10,
        "isUnlimited": false,
        "id": "sApKpllz4sAplsmzha",
        "parentBrandId": "Brand_ID",
        "eventId": "Event_ID",
        "type": "Function",
        "code": "Code",
        "name": "Feature Name",
        "image": "https://www.example.com/image.jpg",
        "styles": "{\"color\": \"red\"}",
        "description": "Feature Description",
        "tags": "#Tag1, #Tag2",
        "zOrder": 1,
        "status": "Active"
      }
    ],
    "prices": [
      {
        "id": "sApKpllz4sAplsmzha",
        "code": "Code",
        "name": "Name",
        "amount": 10,
        "currency": "USD",
        "description": "Description",
        "checkoutLink": "CheckoutLink",
        "tags": "Tags",
        "packageName": "PackageName",
        "packageId": "PackageId",
        "subscriptionName": "SubscriptionName",
        "subscriptionTypeId": "SubscriptionTypeId",
        "zOrder": 1
      }
    ],
    "isDefault": true
  },
  "errors": []
}