Get store settings

GET

/api/v1/commerce/settings

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

• Digize

How the store takes orders, charges, ships and taxes, and its Stripe account’s state.

Needs the commerce:read permission.

Authorizations

• apiKey
• bearer

Responses

200

Done

Media typeapplication/json

object

general

required

object

name

required

string

>= 1 characters <= 60 characters

contactEmail

required

Any of:

string

string

string

string format: email

<= 254 characters /^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/

phone

required

string

<= 40 characters

address

required

object

line1

required

string

<= 120 characters

city

required

string

<= 80 characters

region

required

string

<= 40 characters

postalCode

required

string

<= 20 characters

country

required

string

<= 60 characters

storefront

required

object

open

required

boolean

tagline

required

string

<= 160 characters

brandColor

required

string

/^#[0-9a-fA-F]{6}$/

logoImageId

required

Any of:

string

string

<= 120 characters

null

null

hostname

required

string

<= 253 characters

logoUrl

required

string | null

payments

required

object

methods

required

object

card

required

boolean

apple_pay

required

boolean

google_pay

required

boolean

link

required

boolean

cash_app

required

boolean

klarna

required

boolean

statementDescriptor

required

string

/^[A-Za-z0-9 .-]{5,22}$/

stripeAccountId

required

string

chargesEnabled

required

boolean

payoutsEnabled

required

boolean

shipping

required

Array<object>

<= 20 items

object

id

required

string

>= 1 characters <= 64 characters

zone

required

string

<= 80 characters

name

required

string

>= 1 characters <= 60 characters

price

required

integer

<= 9007199254740991

freeOver

required

Any of:

integer

integer

<= 9007199254740991

null

null

delivery

required

string

<= 80 characters

taxes

required

object

name

required

string

>= 1 characters <= 40 characters

rate

required

number

<= 50

pricesIncludeTax

required

boolean

taxShipping

required

boolean

checkout

required

object

requirePhone

required

boolean

orderNotes

required

boolean

reminderAfter

required

integer

<= 10080

shipsTo

required

Array<string>

default: US >= 1 items <= 50 items

policies

required

object

refund

required

string

<= 5000 characters

privacy

required

string

<= 5000 characters

terms

required

string

<= 5000 characters

inventory

required

object

trackByDefault

required

boolean

allowOverselling

required

boolean

lowStockThreshold

required

integer

<= 100000

Example

{
  "general": {
    "contactEmail": ""
  },
  "checkout": {
    "shipsTo": [
      "US"
    ]
  }
}

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"
  }
}