Point of Sale (ClickCrate)

Work with ClickCrate Points of Sale

PreviousQuick Start NextProduct Listing

Last updated 7 months ago

Fetch ClickCrates owned by a user

post

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

Responses

200

application/json

500

application/json

post

POST /v1/clickcrate/owned-clickrates HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer API key
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

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

Responses

200

application/json

404

application/json

500

application/json

post

POST /v1/clickcrate/registered HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer API key
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

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

networkstringRequired

Responses

200

application/json

404

application/json

500

application/json

post

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

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

{
  "collection": null
}

Register a new ClickCrate

post

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

application/json

400

application/json

409

application/json

post

POST /v1/clickcrate/register HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer API key
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

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

application/json

400

application/json

404

application/json

put

PUT /v1/clickcrate/update HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer API key
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

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

Responses

200

application/json

404

application/json

post

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

{
  "clickcrateId": "text"
}

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

Deactivate a ClickCrate

post

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

Responses

200

application/json

404

application/json

post

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

{
  "clickcrateId": "text"
}

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

Make a purchase using a ClickCrate

post

Authorizations

Header parameters

authorizationstringRequiredExample: Bearer <YOUR_API_KEY>

Body

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

application/json

400

application/json

401

application/json

402

application/json

post

POST /v1/clickcrate/purchase HTTP/1.1
Host: api.clickcrate.xyz
Authorization: Bearer API key
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"
}