Create a QR design

Save a QR code design, to keep codes consistent across locations. You'll need a name, a location (store_id) and the design type (template_type); the design options are optional. Each design counts towards the location's plan allowance for QR codes: when the plan doesn't include QR codes or the allowance is used up, the call returns 402. Returns the template with its id.

Prerequisites: a bearer token for the account, and a location id (store_id).

Authentication: Account token. store_id must be inside your own account tree (otherwise 422). QR designs belong to the account that created them and every QR endpoint matches on that account exactly, so a Partner token sees nothing.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
Defaults to Standard A6 Template

The design's name, up to 255 characters. Must be unique for the location.

integer
required
Defaults to 3007

The location the design is for. Must be inside your account tree.

string
enum
required
Defaults to standard

standard, hangtag or custom.

Allowed:
string
Defaults to <div class="qr-card">Scan to review</div>

Markup for the front of the design.

design_settings
object

Settings for the front of the design, as an object or a JSON string (invalid JSON is saved as an empty list).

string
Defaults to <div class="qr-card-back">Thank you</div>

Markup for the back of the design.

design_settings_back
object

Settings for the back of the design, sent like design_settings.

integer
Defaults to 2963

The QR code the design is for (id in List QR codes). Must be one of your account's QR codes.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json