SysRetireCatalogItem

Retire the specified catalog item on the server.

Service	Operation
itemCatalog	SYS_RETIRE_CATALOG_ITEM

Method Parameters

Parameter	Description
defId	Unique ID identifying catalog item.
version	Version of catalog item being edited.

Usage

http://localhost:3000

C#

// Cloud Code only. To view example, switch to the Cloud Code tab

C++

// Cloud Code only. To view example, switch to the Cloud Code tab

Objective-C

// Cloud Code only. To view example, switch to the Cloud Code tab

Java

// Cloud Code only. To view example, switch to the Cloud Code tab

JavaScript

// Cloud Code only. To view example, switch to the Cloud Code tab

Dart

// Cloud Code only. To view example, switch to the Cloud Code tab

Cloud Code

var defId = "sword001";
var version = 1;
var itemCatalogProxy = bridge.getItemCatalogServiceProxy();

var postResult = itemCatalogProxy.sysRetireCatalogItem(defId, version);
if (postResult.status == 200) {
    // Success!
}

Raw

{
    "service": "itemCatalog",
    "operation": "SYS_RETIRE_CATALOG_ITEM",
    "data": {
        "defId": "sword001",
        "version": 1
    }
}

JSON Response

{
  "data": {
    "defId": "sword001",
    "name": "Cherry Sword",
    "desc": "A crimson sword whose blade was forged in Cherry Kool-aid!",
    "type": "ITEM",
    "category": "sword",
    "tags": [
      "weapon",
      "pointy",
      "crimson",
      "cherry"
    ],
    "buyPrice": {
      "coins": 250
    },
    "sellPrice": {
      "coins": 180
    },
    "image": "//cherrySword.jpg",
    "resourceGroup": "equipment.asset",
    "resourceTag": "sword001",
    "meta": {
      "speed": 80,
      "damage": 10,
      "accuracy": 85,
      "range": 7
    },
    "initData": {
      "condition": 100,
      "bonus": 0
    },
    "pState": "RETIRED",
    "publishedAt": 1567192243524,
    "createdAt": 1567192113061,
    "updatedAt": 1567192275046,
    "version": 5,
    "stackable": false,
    "consumable": false,
    "uses": null,
    "coolDownSecs": 0,
    "recoverySecs": 0,
    "activatable": false,
    "statusName": null,
    "activeSecs": null,
    "tradable": false,
    "blockchain": false,
    "blockchainDefId": null
  },
  "status": 200
}