Product Listing

Work with Product Listings

PreviousPoint of Sale (ClickCrate)NextOrders

Last updated 6 months ago

Fetch product listings 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/product-listing/owned-listings' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "owner": "text"
  }'

200

500

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

200

Fetch a specific registered product listing

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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/product-listing/registered' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text"
  }'

200

404

500

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

200

Fetch details of a specific product listing

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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/product-listing/details' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text",
    "network": "text"
  }'

200

404

500

{
  "collection": null
}

200

Register a new ProductListing

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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

originstring · enumrequired

Available options:

placementTypestring · enumrequired

Available options:

productCategorystring · enumrequired

Available options:

managerstringrequired

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

priceintegerrequired

orderManagerstring · enumrequired

Available options:

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.clickcrate.xyz/v1/product-listing/register' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text",
    "origin": "clickcrate",
    "placementType": "digitalreplica",
    "productCategory": "clothing",
    "manager": "text",
    "price": 1,
    "orderManager": "clickcrate"
  }'

200

400

409

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

200

Update an existing ProductListing

put

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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

placementTypestring · enumrequired

Available options:

productCategorystring · enumrequired

Available options:

managerstringrequired

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

priceintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.clickcrate.xyz/v1/product-listing/update' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text",
    "placementType": "digitalreplica",
    "productCategory": "clothing",
    "manager": "text",
    "price": 1
  }'

200

400

404

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

200

Activate a ProductListing

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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/product-listing/activate' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text"
  }'

200

404

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

200

Deactivate a ProductListing

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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/product-listing/deactivate' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text"
  }'

200

404

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

200

Place a ProductListing in a ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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

clickcrateIdstringrequired

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

pricenumberrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

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

200

400

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

200

Remove a ProductListing from a ClickCrate

post

Authorizations

Header parameters

authorizationstringrequired

Example: Bearer <YOUR_API_KEY>

Body

productListingIdstringrequired

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

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/product-listing/remove' \
  --header 'Authorization: Bearer API key' \
  --header 'authorization: text' \
  --header 'Content-Type: application/json' \
  --data '{
    "productListingId": "text",
    "clickcrateId": "text"
  }'

200

404

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

200