AddDiscount - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

000000

Body Params application/json

id

string | null

optional

type

enum<string>

required

Allowed values:

percentageflat

value

number <double>

required

name

string

required

discountCode

string | null

optional

currency

optional

Any of

ICommonCurrency

number | null

name

string

required

symbol

string

required

sysgenerated

boolean | null

optional

amount

number <double> | null

optional

Example

{
    "id": "string",
    "type": "percentage",
    "value": 0,
    "name": "string",
    "discountCode": "string",
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "sysgenerated": true,
    "amount": 0
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.upbooks.io/api/v1/discount' \
--header 'ORGANIZATION-ID: 000000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": "string",
    "type": "percentage",
    "value": 0,
    "name": "string",
    "discountCode": "string",
    "currency": {
        "name": "string",
        "symbol": "string"
    },
    "sysgenerated": true,
    "amount": 0
}'

Responses

🟢200Ok

application/json

Body

data

object (IDiscountDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string

required

type

enum<string>

required

Allowed values:

percentageflat

value

number <double>

required

name

string

required

discountCode

string | null

optional

currency

optional

sysgenerated

boolean | null

optional

message

string

optional

Example

{
    "data": {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "__v": 0,
        "_id": "string",
        "organizationId": "string",
        "type": "percentage",
        "value": 0,
        "name": "string",
        "discountCode": "string",
        "currency": {
            "name": "string",
            "symbol": "string"
        },
        "sysgenerated": true
    },
    "message": "string"
}

🟢200Success