aid_discounts_did_put

curl --request PUT \
  --url https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

{
  "requirement": {
    "purchase_from": "2023-11-07T05:31:56Z",
    "purchase_to": "2023-11-07T05:31:56Z",
    "customer": {
      "addresses": [
        {
          "country": [
            "NO"
          ],
          "postal_code": [
            "0349"
          ],
          "postal_place": [
            "Oslo"
          ],
          "custom_type": [
            "offsite"
          ],
          "type": [
            "custom"
          ]
        }
      ],
      "company": {
        "bussiness_name": [
          "TKP tech AS"
        ],
        "department": [
          "production",
          "research"
        ],
        "industry": [
          "J62.0.1",
          "J62.0.2"
        ],
        "number_of_employees": [
          "20"
        ],
        "organization_number": [
          "123456789MVA"
        ],
        "website": [
          "https://dintero.com"
        ]
      },
      "date_of_birth": [
        "1990-09-20",
        "1990-05-10"
      ],
      "enrolled_by": {
        "type": [
          "url"
        ],
        "value": [
          "https://mypage.example.dintero.com"
        ]
      },
      "favorite_store": [
        "sc029"
      ],
      "first_name": [
        "John"
      ],
      "gender": [
        "male"
      ],
      "last_name": [
        "Doe"
      ],
      "marketing_consent": {
        "email": {
          "consent": [
            "true"
          ]
        },
        "sms": {
          "consent": [
            "true"
          ]
        }
      },
      "status": [
        "vip"
      ],
      "term": {
        "id": [
          "<string>"
        ]
      },
      "type": [
        "<string>"
      ],
      "attributes": {}
    },
    "item": {
      "quantity": 0,
      "mixes": [
        {
          "items": [
            {
              "id": "b714118"
            },
            {
              "group_id": "g4"
            }
          ],
          "quantity": 1,
          "reward_eligible": true
        }
      ],
      "items": [
        {
          "id": "b714118",
          "group_id": "B1"
        }
      ]
    },
    "store_ids": [
      "sc029"
    ],
    "gross_amount": 0,
    "net_amount": 0,
    "currencies": [
      {
        "anything-but": [
          "NOK"
        ]
      }
    ],
    "stamp": 5,
    "discount_code": "TACO",
    "store": {
      "id": [
        "sc029"
      ],
      "name": [
        "SC Oslo"
      ],
      "business_name": [
        "SC Oslo AS"
      ],
      "address": {
        "country": [
          "NO"
        ],
        "postal_code": [
          "0349"
        ],
        "postal_place": [
          "Oslo"
        ]
      },
      "chain": [
        "SuperChain"
      ],
      "email": [
        "contact@superchain.com"
      ],
      "gln": [
        "5790001398644"
      ],
      "organization_number": [
        "123456789MVA"
      ],
      "phone_number": [
        "+4738260107"
      ],
      "mcc": [
        5814
      ],
      "mcc_ranges": [
        {
          "start": 5814,
          "end": 5815
        }
      ],
      "bax": [
        "102603"
      ],
      "terminal_id": [
        "T0292"
      ]
    }
  },
  "reward": {
    "type": "discount_amount",
    "value": 10000,
    "values": [
      {
        "items": [
          {
            "id": "b714118",
            "group_id": "B1"
          }
        ],
        "value": 123
      }
    ],
    "base": "gross",
    "effect": "discount"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_at": "2023-11-07T05:31:56Z",
  "campaign_id": "<string>",
  "active": true,
  "private": false,
  "updated_by": "3d1e4824-5474-48e7-a369-4f603fa4c5b8",
  "type": "item",
  "name": "Spar 100,-",
  "receipt_text": "Mai Salg",
  "visible_from": "2023-11-07T05:31:56Z",
  "description": "Gjør et Stablestol kupp!",
  "limitation": {
    "dynamic_purchase_to_days": 2,
    "discount_activation": [
      {
        "type": "deactivate_if_discount_active",
        "value": "<string>"
      }
    ],
    "discount_hours": {
      "hours": [
        {
          "day": "mon",
          "start": "10:00",
          "end": "20:00"
        }
      ],
      "timezone": "Europe/Oslo"
    },
    "discount_reward_usage": 1,
    "discount_combination": -1,
    "discount_eligible": "item_eligible_for_discount",
    "discount_repeat_usage": -1,
    "stamp_expire_days": 100,
    "blacklist": [
      {
        "id": "b714118",
        "group_id": "B1"
      }
    ]
  },
  "metadata": {
    "campaign_id": "V101",
    "is_featured": true,
    "dintero:private_text:kind": "Gold"
  },
  "links": [
    {
      "href": "https://example.dintero.com/c/photos/2018/6_20_thumbnail_discount_image.png",
      "rel": "thumbnail_discount_image"
    },
    {
      "href": "https://example.dintero.com/c/photos/2018/6_20_medium_discount_image.png",
      "rel": "medium_discount_image"
    },
    {
      "href": "https://example.dintero.com/shop?utm_source=dintero&utm_medium=email&utm_campaign=spring-summer",
      "rel": "webshoop"
    },
    {
      "href": "https://example.dintero.com/newsletter/2018.pdf",
      "rel": "newletter",
      "type": "application/pdf"
    }
  ],
  "statistics": {
    "stamp": 123,
    "used": 28,
    "usage": 28,
    "amount": 280000,
    "debit_balance": 12350
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

Discount Rules

Update Discount

Update discount details.

Caution: Update of non-meta properties, properties that changes requirement or limitation can create conflict with the usage history of the discount.

Example is to change requirement.item.items, such change would mean that purchases before the change would not be correctly rewarded given the new version of the discount.

We recommend to limit the update of a discount to meta only properties if the discount has previously been used in a purchase.

Update on requirement purchase_to is only supported when the new value that is after current value.

purchase_from can not be updated. Changing purchase_to or limitation.dynamic_purchase_to_days also updates the customer discounts already given, and is only supported with mode=merge.

reward can be updated. The replace rules are described in the reward property of the request body.

requirement and limitation keys are merged with the current values. Use mode=replace to replace the rule, for example to remove a key.

The discount type (receipt/item) is derived from the updated requirement.item.

The reward of a discount_debit discount can not be changed, and a reward can not be changed to discount_debit. Only reward.base can be updated.

Update discount.active to toggle if an discount is active and available for purchase.

Update discount.private to toggle if an discount is included in public discount collection if given to all customers

scopes:

admin:discounts
write:discounts

PUT

https://api.dintero.com/v1

accounts

{aid}

discounts

rules

{did}

aid_discounts_did_put

curl --request PUT \
  --url https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://api.dintero.com/v1/accounts/{aid}/discounts/rules/{did}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

{
  "requirement": {
    "purchase_from": "2023-11-07T05:31:56Z",
    "purchase_to": "2023-11-07T05:31:56Z",
    "customer": {
      "addresses": [
        {
          "country": [
            "NO"
          ],
          "postal_code": [
            "0349"
          ],
          "postal_place": [
            "Oslo"
          ],
          "custom_type": [
            "offsite"
          ],
          "type": [
            "custom"
          ]
        }
      ],
      "company": {
        "bussiness_name": [
          "TKP tech AS"
        ],
        "department": [
          "production",
          "research"
        ],
        "industry": [
          "J62.0.1",
          "J62.0.2"
        ],
        "number_of_employees": [
          "20"
        ],
        "organization_number": [
          "123456789MVA"
        ],
        "website": [
          "https://dintero.com"
        ]
      },
      "date_of_birth": [
        "1990-09-20",
        "1990-05-10"
      ],
      "enrolled_by": {
        "type": [
          "url"
        ],
        "value": [
          "https://mypage.example.dintero.com"
        ]
      },
      "favorite_store": [
        "sc029"
      ],
      "first_name": [
        "John"
      ],
      "gender": [
        "male"
      ],
      "last_name": [
        "Doe"
      ],
      "marketing_consent": {
        "email": {
          "consent": [
            "true"
          ]
        },
        "sms": {
          "consent": [
            "true"
          ]
        }
      },
      "status": [
        "vip"
      ],
      "term": {
        "id": [
          "<string>"
        ]
      },
      "type": [
        "<string>"
      ],
      "attributes": {}
    },
    "item": {
      "quantity": 0,
      "mixes": [
        {
          "items": [
            {
              "id": "b714118"
            },
            {
              "group_id": "g4"
            }
          ],
          "quantity": 1,
          "reward_eligible": true
        }
      ],
      "items": [
        {
          "id": "b714118",
          "group_id": "B1"
        }
      ]
    },
    "store_ids": [
      "sc029"
    ],
    "gross_amount": 0,
    "net_amount": 0,
    "currencies": [
      {
        "anything-but": [
          "NOK"
        ]
      }
    ],
    "stamp": 5,
    "discount_code": "TACO",
    "store": {
      "id": [
        "sc029"
      ],
      "name": [
        "SC Oslo"
      ],
      "business_name": [
        "SC Oslo AS"
      ],
      "address": {
        "country": [
          "NO"
        ],
        "postal_code": [
          "0349"
        ],
        "postal_place": [
          "Oslo"
        ]
      },
      "chain": [
        "SuperChain"
      ],
      "email": [
        "contact@superchain.com"
      ],
      "gln": [
        "5790001398644"
      ],
      "organization_number": [
        "123456789MVA"
      ],
      "phone_number": [
        "+4738260107"
      ],
      "mcc": [
        5814
      ],
      "mcc_ranges": [
        {
          "start": 5814,
          "end": 5815
        }
      ],
      "bax": [
        "102603"
      ],
      "terminal_id": [
        "T0292"
      ]
    }
  },
  "reward": {
    "type": "discount_amount",
    "value": 10000,
    "values": [
      {
        "items": [
          {
            "id": "b714118",
            "group_id": "B1"
          }
        ],
        "value": 123
      }
    ],
    "base": "gross",
    "effect": "discount"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "updated_at": "2023-11-07T05:31:56Z",
  "deleted_by": "1c92f7e1-2897-4d46-bdcc-c127a914fb4e",
  "deleted_at": "2023-11-07T05:31:56Z",
  "campaign_id": "<string>",
  "active": true,
  "private": false,
  "updated_by": "3d1e4824-5474-48e7-a369-4f603fa4c5b8",
  "type": "item",
  "name": "Spar 100,-",
  "receipt_text": "Mai Salg",
  "visible_from": "2023-11-07T05:31:56Z",
  "description": "Gjør et Stablestol kupp!",
  "limitation": {
    "dynamic_purchase_to_days": 2,
    "discount_activation": [
      {
        "type": "deactivate_if_discount_active",
        "value": "<string>"
      }
    ],
    "discount_hours": {
      "hours": [
        {
          "day": "mon",
          "start": "10:00",
          "end": "20:00"
        }
      ],
      "timezone": "Europe/Oslo"
    },
    "discount_reward_usage": 1,
    "discount_combination": -1,
    "discount_eligible": "item_eligible_for_discount",
    "discount_repeat_usage": -1,
    "stamp_expire_days": 100,
    "blacklist": [
      {
        "id": "b714118",
        "group_id": "B1"
      }
    ]
  },
  "metadata": {
    "campaign_id": "V101",
    "is_featured": true,
    "dintero:private_text:kind": "Gold"
  },
  "links": [
    {
      "href": "https://example.dintero.com/c/photos/2018/6_20_thumbnail_discount_image.png",
      "rel": "thumbnail_discount_image"
    },
    {
      "href": "https://example.dintero.com/c/photos/2018/6_20_medium_discount_image.png",
      "rel": "medium_discount_image"
    },
    {
      "href": "https://example.dintero.com/shop?utm_source=dintero&utm_medium=email&utm_campaign=spring-summer",
      "rel": "webshoop"
    },
    {
      "href": "https://example.dintero.com/newsletter/2018.pdf",
      "rel": "newletter",
      "type": "application/pdf"
    }
  ],
  "statistics": {
    "stamp": 123,
    "used": 28,
    "usage": 28,
    "amount": 280000,
    "debit_balance": 12350
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "errors": [
      {}
    ]
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication (token authentication) should be used for accessing the API.

Use Get Token to get an access token for client credentials. Pass the token in the request header:

Authorization: Bearer {access_token}

where the access_token is JSON Web Tokens (JWT).

Path Parameters

aid

string<^[PT]{1}\d{8}$>

required

An id that uniquely identifies the account.

Required string length: 9

did

string<uuid>

required

An UUID that uniquely identifies the discount

Query Parameters

mode

enum<string>

default:merge

How the request body is applied to the rule.

merge: properties in the body are updated, other properties keep their current value. Keys in requirement and limitation are merged with the current values.
replace: the body replaces the rule. requirement and reward (with type and value) are required. Properties that are left out are removed or reset to their default, as when the rule is created, campaign_id included. requirement.purchase_from, requirement.purchase_to and limitation.dynamic_purchase_to_days can not be changed; purchase_from and purchase_to can be left out.

Available options:

merge,

replace

Body

application/json

Discount properties to update

campaign_id

string | null

The campaign the rule belongs to, use null to remove the rule from the campaign.

active

boolean

default:true

the discount is active and can be available for purchase

private

boolean

the discount is private and will not be included in public discount collection

Example:

false

links

object[]

Links to resources related to the discount

Show child attributes

Example:

[
  {
    "href": "https://example.dintero.com/c/photos/2018/6_20_thumbnail_discount_image.png",
    "rel": "thumbnail_discount_image"
  },
  {
    "href": "https://example.dintero.com/c/photos/2018/6_20_medium_discount_image.png",
    "rel": "medium_discount_image"
  },
  {
    "href": "https://example.dintero.com/shop?utm_source=dintero&utm_medium=email&utm_campaign=spring-summer",
    "rel": "webshoop"
  },
  {
    "href": "https://example.dintero.com/newsletter/2018.pdf",
    "rel": "newletter",
    "type": "application/pdf"
  }
]

limitation

object

Show child attributes

requirement

object

Discount base requirement

Show child attributes

reward

object

Reward properties to update.

When type is included the reward is replaced: type, value and values are replaced, base and effect keep their current value unless included. value is required when type is included. type is required when anything other than base is included.

When only base is included, only base is updated.

With mode=replace the reward is replaced as when the rule is created.

Show child attributes

description

string

Example:

"Gjør et Stablestol kupp!"

metadata

object

Additional metadata about the discount

Example:

{
  "campaign_id": "V101",
  "is_featured": true
}

name

string

Example:

"Spar 100,-"

receipt_text

string

Text that should be used when displaying the discount, e.g. on receipt

Example:

"Mai Salg"

Response

Discount Updated

requirement

object

required

Discount base requirement

Show child attributes

reward

object

required

Show child attributes

string<uuid>

read-only

An UUID that uniquely identifies the resource

created_at

string<date-time>

read-only

The date-time when the resource was created

created_by

string

read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

updated_at

string<date-time>

read-only

The date-time when the resource was last updated

deleted_by

string

read-only

The ID of the user/client created the resource

Example:

"1c92f7e1-2897-4d46-bdcc-c127a914fb4e"

deleted_at

string<date-time>

read-only

campaign_id

string

The campaign the rule belongs to

active

boolean

default:true

the discount is active and can be available for purchase (if given to any or all customers)

private

boolean

default:false

the discount will be excluded from public discount collection (GET /discounts/public/rules).

updated_by

string

read-only

The ID of the user/client that last updated the resource

Example:

"3d1e4824-5474-48e7-a369-4f603fa4c5b8"

type

enum<string>

read-only

The discount base type * receipt discount is given on receipt * item discount is given to items

Available options:

item,

receipt

name

string

Example:

"Spar 100,-"

receipt_text

string

Text that should be used when displaying the discount, e.g. on receipt

Example:

"Mai Salg"

visible_from

string<date-time>

Make the discount visible to the customer from given date. Default behavior is to only return discount to the customer where the current time is between purchase_from and purchase_to

description

string

Example:

"Gjør et Stablestol kupp!"

limitation

object

Show child attributes

metadata

object

Additional metadata about the discount

Metadata prefixed with dintero:exclude:public: will be excluded when listing the rules from the public endpoint

GET /v1/accounts/{aid}/discounts/public/rules

and included in all other endpoints that returns discount rules

Example:

{
  "campaign_id": "V101",
  "is_featured": true,
  "dintero:private_text:kind": "Gold"
}

links

object[]

Links to resources related to the discount

Show child attributes

Example:

[
  {
    "href": "https://example.dintero.com/c/photos/2018/6_20_thumbnail_discount_image.png",
    "rel": "thumbnail_discount_image"
  },
  {
    "href": "https://example.dintero.com/c/photos/2018/6_20_medium_discount_image.png",
    "rel": "medium_discount_image"
  },
  {
    "href": "https://example.dintero.com/shop?utm_source=dintero&utm_medium=email&utm_campaign=spring-summer",
    "rel": "webshoop"
  },
  {
    "href": "https://example.dintero.com/newsletter/2018.pdf",
    "rel": "newletter",
    "type": "application/pdf"
  }
]

statistics

object

Show child attributes

API Clients

Client Grants

Customer Users

Customer Authentication

Customer Communication

Customer Tags

Customer Tokens

Customer Terms

Customer Settings

Company

Locations

Address & Organization Lookup

Discount Rules

Discount Usage

Discount Customers

Campaigns

Automations

Receipts

Wallets

Update Discount

Authorizations

Path Parameters

Query Parameters

Body

Response