Point of Sale (ClickCrate)

Work with ClickCrate Points of Sale

Fetch ClickCrates owned by a user

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/owned-clickrates

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

Responses

200

200

application/json

500

500

application/json

post

/v1/clickcrate/owned-clickrates

HTTPcURLJavaScriptPython

POST /v1/clickcrate/owned-clickrates HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "owner": "text"
}

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

Fetch a specific registered ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/registered

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

Responses

200

200

application/json

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

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

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

eligiblePlacementTypestring · enumRequiredPossible values:

eligibleProductCategorystring · enumRequiredPossible values:

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

isActivebooleanRequired

404

404

application/json

500

500

application/json

post

/v1/clickcrate/registered

HTTPcURLJavaScriptPython

POST /v1/clickcrate/registered HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "clickcrateId": "text"
}

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

Fetch details of a specific ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/details

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

networkstringRequired

Responses

200

200

application/json

collectionany · nullableOptional

404

404

application/json

500

500

application/json

post

/v1/clickcrate/details

HTTPcURLJavaScriptPython

POST /v1/clickcrate/details HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "clickcrateId": "text",
  "network": "text"
}

{
  "collection": null
}

Register a new ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/register

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

eligiblePlacementTypestring · enumRequiredPossible values:

eligibleProductCategorystring · enumRequiredPossible values:

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

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

409

409

application/json

post

/v1/clickcrate/register

HTTPcURLJavaScriptPython

POST /v1/clickcrate/register HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "clickcrateId": "text",
  "eligiblePlacementType": "digitalreplica",
  "eligibleProductCategory": "clothing",
  "manager": "text"
}

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

Update an existing ClickCrate

put

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/update

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

eligiblePlacementTypestring · enumRequiredPossible values:

eligibleProductCategorystring · enumRequiredPossible values:

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

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

404

404

application/json

put

/v1/clickcrate/update

HTTPcURLJavaScriptPython

PUT /v1/clickcrate/update HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "clickcrateId": "text",
  "eligiblePlacementType": "digitalreplica",
  "eligibleProductCategory": "clothing",
  "manager": "text"
}

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

Activate a ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/activate

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/clickcrate/activate

HTTPcURLJavaScriptPython

POST /v1/clickcrate/activate HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "clickcrateId": "text"
}

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

Deactivate a ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/deactivate

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/clickcrate/deactivate

HTTPcURLJavaScriptPython

POST /v1/clickcrate/deactivate HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 23

{
  "clickcrateId": "text"
}

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

Make a purchase using a ClickCrate

post

https://api.clickcrate.xyzhttp://localhost:8080

/v1/clickcrate/purchase

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

application/json

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

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

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

sizestring · nullableOptional

quantityintegerRequired

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

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

paymentProcessorstring · enumRequiredPossible values:

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

401

401

application/json

402

402

application/json

post

/v1/clickcrate/purchase

HTTPcURLJavaScriptPython

POST /v1/clickcrate/purchase HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer YOUR_SECRET_TOKEN
authorization: text
Content-Type: application/json
Accept: */*
Content-Length: 153

{
  "productListingId": "text",
  "productId": "text",
  "clickcrateId": "text",
  "size": "text",
  "quantity": 1,
  "buyer": "text",
  "payer": "text",
  "paymentProcessor": "solana"
}

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