| Server IP : 66.29.137.217 / Your IP : 13.58.45.209 Web Server : LiteSpeed System : Linux premium294.web-hosting.com 4.18.0-513.11.1.lve.el8.x86_64 #1 SMP Thu Jan 18 16:21:02 UTC 2024 x86_64 User : gltevjme ( 1095) PHP Version : 7.0.33 Disable Function : NONE MySQL : OFF | cURL : ON | WGET : ON | Perl : ON | Python : ON | Sudo : OFF | Pkexec : OFF Directory : /home/gltevjme/./cbt.bofirm.com/vendor/razorpay/razorpay/documents/ |
Upload File : |
## items
### Create item
```php
$api->Item->create(array("name" => "Book / English August","description" => "An indian story, Booker prize winner.","amount" => 20000,"currency" => "INR"));
```
**Parameters:**
| Name | Type | Description |
|-----------------|---------|------------------------------------------------------------------------------|
| name* | string | Name of the item. |
| description | string | A brief description of the item. |
| amount | integer | Amount of the order to be paid |
| currency | string | Currency of the order. Currently only `INR` is supported. |
**Response:**
```json
{
"id": "item_7Oxp4hmm6T4SCn",
"active": true,
"name": "Book / English August",
"description": "An indian story, Booker prize winner.",
"amount": 20000,
"currency": "INR"
}
```
-------------------------------------------------------------------------------------------------------
### Fetch all items
```php
$api->Item->all($options);
```
**Parameters:**
| Name | Type | Description |
|-------|-----------|--------------------------------------------------|
| from | timestamp | timestamp after which the item were created |
| to | timestamp | timestamp before which the item were created |
| count | integer | number of item to fetch (default: 10) |
| skip | integer | number of item to be skipped (default: 0) |
| name | string | Name of the item. |
| description | string | A brief description of the item. |
| amount | integer | Amount of the order to be paid |
| currency | string | Currency of the order. Currently only `INR` is supported. |
| active | boolean | Possible values is `0` or `1` |
**Response:**
```json
{
"entity": "collection",
"count": 3,
"items": [
{
"id": "item_7Oy8OMV6BdEAac",
"active": true,
"name": "Book / Ignited Minds",
"description": null,
"amount": 15000,
"currency": "INR"
},
{
"id": "item_7Oxp4hmm6T4SCn",
"active": true,
"name": "Book / English August",
"description": "An indian story, Booker prize winner.",
"amount": 20000,
"currency": "INR"
},
{
"id": "item_7OxoGnoxCuUKbo",
"active": true,
"name": "Book / English August",
"description": null,
"amount": 20000,
"currency": "INR"
}
]
}
```
-------------------------------------------------------------------------------------------------------
### Fetch particular item
```php
$api->Item->fetch($itemId);
```
**Parameters**
| Name | Type | Description |
|----------|--------|-------------------------------------|
| itemId* | string | The id of the item to be fetched |
**Response:**
```json
{
"id": "item_7Oxp4hmm6T4SCn",
"active": true,
"name": "Book / English August",
"description": "An indian story, Booker prize winner.",
"amount": 20000,
"currency": "INR"
}
```
-------------------------------------------------------------------------------------------------------
### Update item
```php
$api->Item->fetch($itemId)->edit(array("name" => "Book / Ignited Minds - Updated name!","description" => "New descirption too. :).","amount" => 20000,"currency" => "INR","active" => true
));
```
**Parameters**
| Name | Type | Description |
|----------|--------|-------------------------------------|
| itemId* | string | The id of the item to be fetched |
| name | string | Name of the item. |
| description | string | A brief description of the item. |
| amount | integer | Amount of the order to be paid |
| currency | string | Currency of the order. Currently only `INR` is supported. |
| active | boolean | Possible values is `0` or `1` |
**Response:**
```json
{
"id": "item_7Oy8OMV6BdEAac",
"active": true,
"name": "Book / Ignited Minds - Updated name!",
"description": "New descirption too. :)",
"amount": 15000,
"currency": "INR"
}
```
-------------------------------------------------------------------------------------------------------
### Delete item
```php
$api->Item->fetch($itemId)->delete();
```
**Parameters**
| Name | Type | Description |
|----------|--------|-------------------------------------|
| itemId* | string | The id of the item to be fetched |
**Response:**
```json
[]
```
-------------------------------------------------------------------------------------------------------
**PN: * indicates mandatory fields**
<br>
<br>
**For reference click [here](https://razorpay.com/docs/api/items)**