Skip to content

Latest commit

 

History

History
159 lines (137 loc) · 4.72 KB

item.md

File metadata and controls

159 lines (137 loc) · 4.72 KB
Raw

items

Create item

$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:

{
  "id": "item_7Oxp4hmm6T4SCn",
  "active": true,
  "name": "Book / English August",
  "description": "An indian story, Booker prize winner.",
  "amount": 20000,
  "currency": "INR"
}

Fetch all items

$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:

{
  "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

$api->Item->fetch($itemId);

Parameters

Name Type Description
itemId* string The id of the item to be fetched

Response:

{
  "id": "item_7Oxp4hmm6T4SCn",
  "active": true,
  "name": "Book / English August",
  "description": "An indian story, Booker prize winner.",
  "amount": 20000,
  "currency": "INR"
}

Update item

$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:

{
  "id": "item_7Oy8OMV6BdEAac",
  "active": true,
  "name": "Book / Ignited Minds - Updated name!",
  "description": "New descirption too. :)",
  "amount": 15000,
  "currency": "INR"
}

Delete item

$api->Item->fetch($itemId)->delete();

Parameters

Name Type Description
itemId* string The id of the item to be fetched

Response:

[]

PN: * indicates mandatory fields

For reference click here