ClickCrate
WebsiteSupportTwitter
  • Introduction
  • Overview
  • Quick Start
  • API Reference
    • Point of Sale (ClickCrate)
    • Product Listing
    • Orders
    • Credentials
    • Blinks
  • resources
    • Glossary
    • Common Issues
    • Need Help?
Powered by GitBook
On this page
  1. API Reference

Blinks

Work with embedded blockchain links (Blinks) and sell products directly on socials (ie. Twitter, etc.)

PreviousCredentialsNextGlossary

Last updated 10 months ago

  • GETGet blink details for a ClickCrate
  • POSTInitiate a purchase using blink

Get blink details for a ClickCrate

get
Path parameters
clickcrateIdstringRequired
Responses
200
Successful response
application/json
400
Bad Request
application/json
404
ClickCrate not found
application/json
get
GET /blink/{clickcrateId} HTTP/1.1
Host: api.clickcrate.xyz
Accept: */*
{
  "icon": "https://example.com",
  "label": "text",
  "title": "text",
  "description": "text",
  "disabled": true,
  "links": {
    "actions": [
      {
        "href": "text",
        "label": "text",
        "parameters": [
          {
            "name": "text",
            "label": "text",
            "required": true,
            "type": "text"
          }
        ]
      }
    ]
  }
}

Initiate a purchase using blink

post
Body
accountstringRequired
clickcrateIdstringRequired
buyerNamestringRequired
shippingEmailstring ยท emailRequired
shippingPhonestringOptional
shippingAddressstringRequired
shippingCitystringRequired
shippingStateProvincestringRequired
shippingCountryRegionstringRequired
shippingZipCodestringRequired
toppingsstringOptional
dietaryRestrictionsstringOptional
Responses
200
Purchase initiated successfully
application/json
400
Bad request
application/json
404
Product not found
application/json
post
POST /blink/purchase HTTP/1.1
Host: api.clickcrate.xyz
Content-Type: application/json
Accept: */*
Content-Length: 296

{
  "account": "text",
  "clickcrateId": "text",
  "buyerName": "text",
  "shippingEmail": "name@gmail.com",
  "shippingPhone": "text",
  "shippingAddress": "text",
  "shippingCity": "text",
  "shippingStateProvince": "text",
  "shippingCountryRegion": "text",
  "shippingZipCode": "text",
  "toppings": "text",
  "dietaryRestrictions": "text"
}
{
  "transaction": "text",
  "message": "text"
}