Redeem

Redeem the coupon provided in the input. Returns an object indicating if a remaining usage for the coupon is foreseen by the platform.

Request


PUT https://api.domec.tools/v1.0/cp/{couponCode:string}?notes=<string>


Request Body


{
  "IssuerData": {
    "Name": "",
    "Address": "",
    "Telephone": "",
    "EMail": "",
    "VATNumber": ""
  },
  "IssueDate": "",
  "Products": [
    {
      "Code": "",
      "Name": "",
      "Price": 0.0,
      "Quantity": 0.0,
      "Mode": "",
      "Family": ""
    }
  ],
  "Payments": [
    {
      "Method": {},
      "CardCode": "",
      "Amount": 0.0
    }
  ],
  "Total": 0.0,
  "SenderData": {
    "Shop": "",
    "Terminal": "",
    "Type": 0,
    "Number": 0,
    "CashDrawer": 0,
    "Operator": ""
  },
  "UserData": ""
}

Parameters

The Redeem receive the following parameters in the input.

NameTypeData TypeMandatory
couponCodepathstring
receiptbodyShopReceipt
notesquerystring 

Responses

The following HTTP status codes may be returned, optionally with a response resource

Status codeDescriptionResponse body
200OK
Success
View body
400BadRequest
The input request contains errors which prevents executing the request
View body
404NotFound
Endpoint not found
View body