Change Log

  • 19-Jun-2024 | v7.0.0 | All new article

Contributors:

Adam Wilson - Logo Pogo

Ecommerce Gift Vouchers API

Create, Retrieve, Update and Delete Ecommerce Gift Vouchers via the public API endpoint using "where" filtering.

GET Ecommerce Gift Vouchers List

Retrieves a list of Gift Vouchers as a JSON response based on your provided query parameters.

/api/v2/admin/gift-vouchers

Data / Response:

{
    "Where" : {},
    "Order_By" : "Id",
    "Offset" : 0,
    "Limit" : 100,
}

{
  "Items": [
    {
      "Id": 0,
      "Balance": 0,
      "Name": "string",
      "Amount": 0,
      "Enabled": true,
      "Currency": "string",
      "OrderId": 0,
      "Type": "string",
      "Recipient": {
        "Name": "string",
        "Email": "string",
        "Message": "string"
      }
    }
  ],
  "TotalItemsCount": 0
}

POST Ecommerce Gift Voucher Create

Creates a new Gift Voucher based on the provided data.

/api/v2/admin/gift-vouchers

Data / Response:

{
  "Name": "string",
  "Amount": 0,
  "Enabled": true,
  "Currency": "string",
  "OrderId": 0,
  "Type": "string",
  "Recipient": {
    "Name": "string",
    "Email": "string",
    "Message": "string"
  }
}

{
  "Id": 0,
  "Balance": 0,
  "Name": "string",
  "Amount": 0,
  "Enabled": true,
  "Currency": "string",
  "OrderId": 0,
  "Type": "string",
  "Recipient": {
    "Name": "string",
    "Email": "string",
    "Message": "string"
  }
}

GET Ecommerce Gift Voucher Item

Retrieves a single Gift Voucher based on the ID passed in the endpoint URL.

/api/v2/admin/gift-vouchers/{id}

Data / Response:

N/A

{
  "Id": 0,
  "Balance": 0,
  "Name": "string",
  "Amount": 0,
  "Enabled": true,
  "Currency": "string",
  "OrderId": 0,
  "Type": "string",
  "Recipient": {
    "Name": "string",
    "Email": "string",
    "Message": "string"
  }
}

PUT Ecommerce Gift Voucher Update

Updates a single Gift Voucher based on the ID passed in the endpoint URL and data provided.

/api/v2/admin/gift-vouchers/{id}

Data / Response:

{
  "Name": "string",
  "Amount": 0,
  "Enabled": true,
  "Currency": "string",
  "OrderId": 0,
  "Type": "string",
  "Recipient": {
    "Name": "string",
    "Email": "string",
    "Message": "string"
  }
}

{
  "Id": 0,
  "Balance": 0,
  "Name": "string",
  "Amount": 0,
  "Enabled": true,
  "Currency": "string",
  "OrderId": 0,
  "Type": "string",
  "Recipient": {
    "Name": "string",
    "Email": "string",
    "Message": "string"
  }
}

DELETE Ecommerce Gift Voucher Delete

Deletes a single Gift Voucher based on the ID passed in the endpoint URL.

/api/v2/admin/gift-vouchers/{id}

Data / Response:

N/A

Status 204