Skip to content

Latest commit

 

History

History
197 lines (175 loc) · 5.43 KB

item.md

File metadata and controls

197 lines (175 loc) · 5.43 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_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

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

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

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

Parameters

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

Response:

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

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

$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