Product Listing

Work with Product Listings

Fetch product listings owned by a user

POSThttps://api.clickcrate.xyz/v1/product-listing/owned-listings

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

productListings*array of object

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/product-listing/owned-listings', {
    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

{
  "productListings": [
    {
      "productListingId": "text",
      "origin": "clickcrate",
      "owner": "text",
      "manager": "text",
      "placementType": "digitalreplica",
      "productCategory": "clothing",
      "inStock": "text",
      "sold": "text",
      "clickcratePos": "text",
      "isActive": false,
      "price": 0,
      "vault": "text",
      "orderManager": "clickcrate"
    }
  ]
}

Fetch a specific registered product listing

POSThttps://api.clickcrate.xyz/v1/product-listing/registered

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*string

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

Response

200404500

200

Body

application/json

productListingId*string

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

origin*enum

clickcrateshopifysquare

owner*string

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

manager*string

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

placementType*enum

digitalreplicarelatedpurchasetargetedplacement

productCategory*enum

clothingelectronicsbookshomebeautytoyssportsautomotivegroceryhealth

inStock*string

sold*string

clickcratePos*nullable string

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

isActive*boolean

price*nullable integer

vault*nullable string

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

orderManager*enum

clickcrateshopifysquare

Request

JavaScriptCurlPython

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

Response

200404500

{
  "productListingId": "text",
  "origin": "clickcrate",
  "owner": "text",
  "manager": "text",
  "placementType": "digitalreplica",
  "productCategory": "clothing",
  "inStock": "text",
  "sold": "text",
  "clickcratePos": "text",
  "isActive": false,
  "price": 0,
  "vault": "text",
  "orderManager": "clickcrate"
}

Fetch details of a specific product listing

POSThttps://api.clickcrate.xyz/v1/product-listing/details

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*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/product-listing/details', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productListingId": "text",
      "network": "text"
    }),
});
const data = await response.json();

Response

200404500

{}

Register a new ProductListing

POSThttps://api.clickcrate.xyz/v1/product-listing/register

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*string

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

origin*enum

clickcrateshopifysquare

placementType*enum

digitalreplicarelatedpurchasetargetedplacement

productCategory*enum

clothingelectronicsbookshomebeautytoyssportsautomotivegroceryhealth

manager*string

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

price*integer

orderManager*enum

clickcrateshopifysquare

Response

200400409

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.clickcrate.xyz/v1/product-listing/register', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productListingId": "text",
      "origin": "clickcrate",
      "placementType": "digitalreplica",
      "productCategory": "clothing",
      "manager": "text",
      "price": 0,
      "orderManager": "clickcrate"
    }),
});
const data = await response.json();

Response

200400409

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

Update an existing ProductListing

PUThttps://api.clickcrate.xyz/v1/product-listing/update

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*string

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

placementType*enum

digitalreplicarelatedpurchasetargetedplacement

productCategory*enum

clothingelectronicsbookshomebeautytoyssportsautomotivegroceryhealth

manager*string

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

price*integer

Response

200400404

200

Body

application/json

message*string

transaction*string

Request

JavaScriptCurlPython

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

Response

200400404

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

Activate a ProductListing

POSThttps://api.clickcrate.xyz/v1/product-listing/activate

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*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/product-listing/activate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productListingId": "text"
    }),
});
const data = await response.json();

Response

200404

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

Deactivate a ProductListing

POSThttps://api.clickcrate.xyz/v1/product-listing/deactivate

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*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/product-listing/deactivate', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productListingId": "text"
    }),
});
const data = await response.json();

Response

200404

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

Place a ProductListing in a ClickCrate

POSThttps://api.clickcrate.xyz/v1/product-listing/place

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*string

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

clickcrateId*string

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

price*number

Response

200400

200

Body

application/json

message*string

transactions*array of string

Request

JavaScriptCurlPython

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

Response

200400

{
  "message": "text",
  "transactions": [
    "text"
  ]
}

Remove a ProductListing from a ClickCrate

POSThttps://api.clickcrate.xyz/v1/product-listing/remove

Authorization

bearerAuth

Header parameters

Body

application/json

Body

productListingId*string

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

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/product-listing/remove', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API key",
      "authorization": "text",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "productListingId": "text",
      "clickcrateId": "text"
    }),
});
const data = await response.json();

Response

200404

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