D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
home
/
dateitor
/
public_html
/
vendor
/
razorpay
/
razorpay
/
documents
/
Filename :
item.md
back
Copy
## 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_JInaSLODeDUQiQ", "active": true, "name": "Book / English August", "description": "An indian story, Booker prize winner.", "amount": 20000, "unit_amount": 20000, "currency": "INR", "type": "invoice", "unit": null, "tax_inclusive": false, "hsn_code": null, "sac_code": null, "tax_rate": null, "tax_id": null, "tax_group_id": null, "created_at": 1649843796 } ``` ------------------------------------------------------------------------------------------------------- ### 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) | | active | boolean | Possible values is `0` or `1` | **Response:** ```json { "entity": "collection", "count": 2, "items": [ { "id": "item_JInaSLODeDUQiQ", "active": true, "name": "Book / English August", "description": "An indian story, Booker prize winner.", "amount": 20000, "unit_amount": 20000, "currency": "INR", "type": "invoice", "unit": null, "tax_inclusive": false, "hsn_code": null, "sac_code": null, "tax_rate": null, "tax_id": null, "tax_group_id": null, "created_at": 1649843796 }, { "id": "item_JIPSg5L06yhHie", "active": false, "name": "Book / Ignited Minds - Updated name!", "description": "New descirption too. :).", "amount": 20000, "unit_amount": 20000, "currency": "INR", "type": "invoice", "unit": null, "tax_inclusive": false, "hsn_code": null, "sac_code": null, "tax_rate": null, "tax_id": null, "tax_group_id": null, "created_at": 1649758835 } ] } ``` ------------------------------------------------------------------------------------------------------- ### 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_JInaSLODeDUQiQ", "active": true, "name": "Book / English August", "description": "An indian story, Booker prize winner.", "amount": 20000, "unit_amount": 20000, "currency": "INR", "type": "invoice", "unit": null, "tax_inclusive": false, "hsn_code": null, "sac_code": null, "tax_rate": null, "tax_id": null, "tax_group_id": null, "created_at": 1649843796 } ``` ------------------------------------------------------------------------------------------------------- ### 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_JInaSLODeDUQiQ", "active": true, "name": "Book / Ignited Minds - Updated name!", "description": "New descirption too. :).", "amount": 20000, "unit_amount": 20000, "currency": "INR", "type": "invoice", "unit": null, "tax_inclusive": false, "hsn_code": null, "sac_code": null, "tax_rate": null, "tax_id": null, "tax_group_id": null, "created_at": 1649843796 } ``` ------------------------------------------------------------------------------------------------------- ### 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)**