Point of Sale (ClickCrate)

Work with ClickCrate Points of Sale

PreviousQuick Start NextProduct Listing

Last updated 6 months ago

Fetch ClickCrates owned by a user

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

ownerstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/owned-clickrates' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "owner": "text"
  }'

200

500

{
  "clickCrates": [
    {
      "clickcrateId": "text",
      "owner": "text",
      "manager": "text",
      "eligiblePlacementType": "digitalreplica",
      "eligibleProductCategory": "clothing",
      "product": "text",
      "isActive": true
    }
  ]
}

200

Fetch a specific registered ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/registered' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "clickcrateId": "text"
  }'

200

404

500

{
  "clickcrateId": "text",
  "owner": "text",
  "manager": "text",
  "eligiblePlacementType": "digitalreplica",
  "eligibleProductCategory": "clothing",
  "product": "text",
  "isActive": true
}

200

Fetch details of a specific ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

networkstringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/details' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "clickcrateId": "text",
    "network": "text"
  }'

200

404

500

{
  "collection": null
}

200

Register a new ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

eligiblePlacementTypestring · enumrequired

Available options:

eligibleProductCategorystring · enumrequired

Available options:

managerstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/register' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "clickcrateId": "text",
    "eligiblePlacementType": "digitalreplica",
    "eligibleProductCategory": "clothing",
    "manager": "text"
  }'

200

400

409

{
  "message": "text",
  "transaction": "text"
}

200

Update an existing ClickCrate

put

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

eligiblePlacementTypestring · enumrequired

Available options:

eligibleProductCategorystring · enumrequired

Available options:

managerstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/update' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "clickcrateId": "text",
    "eligiblePlacementType": "digitalreplica",
    "eligibleProductCategory": "clothing",
    "manager": "text"
  }'

200

400

404

{
  "message": "text",
  "transaction": "text"
}

200

Activate a ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/activate' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "clickcrateId": "text"
  }'

200

404

{
  "message": "text",
  "transaction": "text"
}

200

Deactivate a ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/deactivate' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "clickcrateId": "text"
  }'

200

404

{
  "message": "text",
  "transaction": "text"
}

200

Make a purchase using a ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

productIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

clickcrateIdstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

sizestring | nullableoptional

quantityintegerrequired

buyerstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

payerstringrequired

Pattern: ^[1-9A-HJ-NP-Za-km-z]{32,44}$

paymentProcessorstring · enumrequired

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/clickcrate/purchase' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text",
    "productId": "text",
    "clickcrateId": "text",
    "size": "text",
    "quantity": 1,
    "buyer": "text",
    "payer": "text",
    "paymentProcessor": "solana"
  }'

200

400

401

402

{
  "message": "text",
  "transaction": "text"
}

200