Point of Sale (ClickCrate)

Work with ClickCrate Points of Sale

Fetch ClickCrates owned by a user

POSThttps://api.clickcrate.xyz/v1/clickcrate/owned-clickrates

Authorization

bearerAuth

Header parameters

Body

application/json

Body

owner*string

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

Response

200500

200

Body

application/json

clickCrates*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/owned-clickrates', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "owner": "text"
    }),
});
const data = await response.json();

Response

200500

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

Fetch a specific registered ClickCrate

POSThttps://api.clickcrate.xyz/v1/clickcrate/registered

Authorization

bearerAuth

Header parameters

Body

application/json

Body

clickcrateId*string

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

Response

200404500

200

Body

application/json

clickcrateId*string

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

owner*string

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

manager*string

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

eligiblePlacementType*enum

digitalreplicarelatedpurchasetargetedplacement

eligibleProductCategory*enum

clothingelectronicsbookshomebeautytoyssportsautomotivegroceryhealth

product*nullable string

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

isActive*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/registered', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clickcrateId": "text"
    }),
});
const data = await response.json();

Response

200404500

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

Fetch details of a specific ClickCrate

POSThttps://api.clickcrate.xyz/v1/clickcrate/details

Authorization

bearerAuth

Header parameters

Body

application/json

Body

clickcrateId*string

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

network*string

Response

200404500

200

Body

application/json

collectionnullable any

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/details', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clickcrateId": "text",
      "network": "text"
    }),
});
const data = await response.json();

Response

200404500

{}

Register a new ClickCrate

POSThttps://api.clickcrate.xyz/v1/clickcrate/register

Authorization

bearerAuth

Header parameters

Body

application/json

Body

clickcrateId*string

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

eligiblePlacementType*enum

digitalreplicarelatedpurchasetargetedplacement

eligibleProductCategory*enum

clothingelectronicsbookshomebeautytoyssportsautomotivegroceryhealth

manager*string

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

Response

200400409

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/register', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clickcrateId": "text",
      "eligiblePlacementType": "digitalreplica",
      "eligibleProductCategory": "clothing",
      "manager": "text"
    }),
});
const data = await response.json();

Response

200400409

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

Update an existing ClickCrate

PUThttps://api.clickcrate.xyz/v1/clickcrate/update

Authorization

bearerAuth

Header parameters

Body

application/json

Body

clickcrateId*string

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

eligiblePlacementType*enum

digitalreplicarelatedpurchasetargetedplacement

eligibleProductCategory*enum

clothingelectronicsbookshomebeautytoyssportsautomotivegroceryhealth

manager*string

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

Response

200400404

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/update', {
    method: 'PUT',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clickcrateId": "text",
      "eligiblePlacementType": "digitalreplica",
      "eligibleProductCategory": "clothing",
      "manager": "text"
    }),
});
const data = await response.json();

Response

200400404

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

Activate a ClickCrate

POSThttps://api.clickcrate.xyz/v1/clickcrate/activate

Authorization

bearerAuth

Header parameters

Body

application/json

Body

clickcrateId*string

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

Response

200404

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/activate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clickcrateId": "text"
    }),
});
const data = await response.json();

Response

200404

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

Deactivate a ClickCrate

POSThttps://api.clickcrate.xyz/v1/clickcrate/deactivate

Authorization

bearerAuth

Header parameters

Body

application/json

Body

clickcrateId*string

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

Response

200404

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/deactivate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "clickcrateId": "text"
    }),
});
const data = await response.json();

Response

200404

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

Make a purchase using a ClickCrate

POSThttps://api.clickcrate.xyz/v1/clickcrate/purchase

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*string

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

productId*string

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

clickcrateId*string

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

sizenullable string

quantity*integer

buyer*string

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

payer*string

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

paymentProcessor*enum

solanastripe

Response

200400401402

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/clickcrate/purchase', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productListingId": "text",
      "productId": "text",
      "clickcrateId": "text",
      "quantity": 0,
      "buyer": "text",
      "payer": "text",
      "paymentProcessor": "solana"
    }),
});
const data = await response.json();

Response

200400401402

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