Update a discount code

PUT

api

discounts

{shopId}

codes

{discountId}

Update a discount code

curl --request PUT \
  --url https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "targets": [
    "<string>"
  ],
  "value": 1.01,
  "expirationDate": "<string>",
  "maxUsage": 2,
  "minOrderValue": 1,
  "maxDiscountAmount": 1,
  "isActive": true
}
'

import requests

url = "https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}"

payload = {
    "description": "<string>",
    "targets": ["<string>"],
    "value": 1.01,
    "expirationDate": "<string>",
    "maxUsage": 2,
    "minOrderValue": 1,
    "maxDiscountAmount": 1,
    "isActive": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    targets: ['<string>'],
    value: 1.01,
    expirationDate: '<string>',
    maxUsage: 2,
    minOrderValue: 1,
    maxDiscountAmount: 1,
    isActive: true
  })
};

fetch('https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'targets' => [
        '<string>'
    ],
    'value' => 1.01,
    'expirationDate' => '<string>',
    'maxUsage' => 2,
    'minOrderValue' => 1,
    'maxDiscountAmount' => 1,
    'isActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"value\": 1.01,\n  \"expirationDate\": \"<string>\",\n  \"maxUsage\": 2,\n  \"minOrderValue\": 1,\n  \"maxDiscountAmount\": 1,\n  \"isActive\": true\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"value\": 1.01,\n  \"expirationDate\": \"<string>\",\n  \"maxUsage\": 2,\n  \"minOrderValue\": 1,\n  \"maxDiscountAmount\": 1,\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"value\": 1.01,\n  \"expirationDate\": \"<string>\",\n  \"maxUsage\": 2,\n  \"minOrderValue\": 1,\n  \"maxDiscountAmount\": 1,\n  \"isActive\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "code": "LATO10",
    "scope": "all",
    "type": "percentage",
    "value": 10,
    "maxUsage": 100,
    "usedTimes": 3,
    "expirationDate": "2023-11-07T05:31:56Z",
    "isActive": true
  },
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Authorizations

X-API-Key

string

header

required

Path Parameters

shopId

string

required

Shop ID (ObjectId)

discountId

string

required

Discount code ID (ObjectId)

Body

application/json

description

string

Description note

Maximum string length: 200

scope

enum<string>

Scope

Available options:

all,

server,

product

targets

string[]

Target IDs

type

enum<string>

Discount type

Available options:

percentage,

fixed

value

number

Value

Required range: x >= 0.01

expirationDate

string

Expiration date (ISO 8601)

maxUsage

number

Max usage count

Required range: x >= 1

minOrderValue

number

Minimum order value

Required range: x >= 0

maxDiscountAmount

number

Max discount amount cap

Required range: x >= 0

isActive

boolean

Active

Response

success

boolean

Example:

true

data

object

Show child attributes

message

string

Delete a discount code

Update a discount code

curl --request PUT \
  --url https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "description": "<string>",
  "targets": [
    "<string>"
  ],
  "value": 1.01,
  "expirationDate": "<string>",
  "maxUsage": 2,
  "minOrderValue": 1,
  "maxDiscountAmount": 1,
  "isActive": true
}
'

import requests

url = "https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}"

payload = {
    "description": "<string>",
    "targets": ["<string>"],
    "value": 1.01,
    "expirationDate": "<string>",
    "maxUsage": 2,
    "minOrderValue": 1,
    "maxDiscountAmount": 1,
    "isActive": True
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: '<string>',
    targets: ['<string>'],
    value: 1.01,
    expirationDate: '<string>',
    maxUsage: 2,
    minOrderValue: 1,
    maxDiscountAmount: 1,
    isActive: true
  })
};

fetch('https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => '<string>',
    'targets' => [
        '<string>'
    ],
    'value' => 1.01,
    'expirationDate' => '<string>',
    'maxUsage' => 2,
    'minOrderValue' => 1,
    'maxDiscountAmount' => 1,
    'isActive' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}"

	payload := strings.NewReader("{\n  \"description\": \"<string>\",\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"value\": 1.01,\n  \"expirationDate\": \"<string>\",\n  \"maxUsage\": 2,\n  \"minOrderValue\": 1,\n  \"maxDiscountAmount\": 1,\n  \"isActive\": true\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"<string>\",\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"value\": 1.01,\n  \"expirationDate\": \"<string>\",\n  \"maxUsage\": 2,\n  \"minOrderValue\": 1,\n  \"maxDiscountAmount\": 1,\n  \"isActive\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.itemshop.dev/api/v2/discounts/{shopId}/codes/{discountId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"<string>\",\n  \"targets\": [\n    \"<string>\"\n  ],\n  \"value\": 1.01,\n  \"expirationDate\": \"<string>\",\n  \"maxUsage\": 2,\n  \"minOrderValue\": 1,\n  \"maxDiscountAmount\": 1,\n  \"isActive\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "_id": "664f1a2b3c4d5e6f7a8b9c0d",
    "code": "LATO10",
    "scope": "all",
    "type": "percentage",
    "value": 10,
    "maxUsage": 100,
    "usedTimes": 3,
    "expirationDate": "2023-11-07T05:31:56Z",
    "isActive": true
  },
  "message": "<string>"
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

{
  "success": false,
  "statusCode": 400,
  "error": "Error message",
  "timestamp": "2023-11-07T05:31:56Z",
  "path": "/api/v2/..."
}

Getting started

Basics

Payments

Order fulfillment

Configuration

API Keys

Shops

Servers

Products

Payment Methods

Blacklist

Discounts

Vouchers

Stats

Storage

Orders

Payments

Components

Metrics

Authorizations

Path Parameters

Body

Response