Gift card stats

GET

/api/v1/commerce/gift-cards/stats

curl --request GET \
  --url https://digize.com/api/v1/commerce/gift-cards/stats \
  --header 'x-api-key: <x-api-key>'

• Digize

The balance left on cards that can be spent, and what was issued and spent in the last 30 days.

Needs the commerce:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

outstanding

required

number

spendable

required

number

issued

required

object

count

required

number

value

required

number

redeemed

required

number

Example ^generated

{
  "outstanding": 1,
  "spendable": 1,
  "issued": {
    "count": 1,
    "value": 1
  },
  "redeemed": 1
}

400

What was sent isn’t valid (invalid).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

401

No key, or one that’s unknown, off or expired.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

403

The key doesn’t have the permission this needs.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

404

Nothing has that id (not_found).

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}

429

Over the rate limit; see retry-after.

Media typeapplication/json

object

error

required

object

code

required

string

Allowed values: invalid unauthorized forbidden not_found conflict too_large rate_limited unavailable internal

message

required

string

details

object

key

additional properties

any

Example

{
  "error": {
    "code": "invalid"
  }
}