Product Listing

Work with Product Listings

Fetch product listings owned by a user

post

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

/v1/product-listing/owned-listings

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/product-listing/owned-listings

HTTPcURLJavaScriptPython

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

{
  "owner": "text"
}

{
  "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"
    }
  ]
}

Fetch a specific registered product listing

post

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

/v1/product-listing/registered

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}$

Responses

200

200

application/json

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

originstring · enumRequiredPossible values:

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

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

placementTypestring · enumRequiredPossible values:

productCategorystring · enumRequiredPossible values:

inStockstringRequired

soldstringRequired

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

isActivebooleanRequired

priceinteger · nullableRequired

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

orderManagerstring · enumRequiredPossible values:

404

404

application/json

500

500

application/json

post

/v1/product-listing/registered

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text"
}

{
  "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"
}

Fetch details of a specific product listing

post

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

/v1/product-listing/details

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}$

networkstringRequired

Responses

200

200

application/json

collectionany · nullableOptional

404

404

application/json

500

500

application/json

post

/v1/product-listing/details

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text",
  "network": "text"
}

{
  "collection": null
}

Register a new ProductListing

post

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

/v1/product-listing/register

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}$

originstring · enumRequiredPossible values:

placementTypestring · enumRequiredPossible values:

productCategorystring · enumRequiredPossible values:

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

priceintegerRequired

orderManagerstring · enumRequiredPossible values:

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

409

409

application/json

post

/v1/product-listing/register

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text",
  "origin": "clickcrate",
  "placementType": "digitalreplica",
  "productCategory": "clothing",
  "manager": "text",
  "price": 1,
  "orderManager": "clickcrate"
}

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

Update an existing ProductListing

put

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

/v1/product-listing/update

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}$

placementTypestring · enumRequiredPossible values:

productCategorystring · enumRequiredPossible values:

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

priceintegerRequired

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

400

400

application/json

404

404

application/json

put

/v1/product-listing/update

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text",
  "placementType": "digitalreplica",
  "productCategory": "clothing",
  "manager": "text",
  "price": 1
}

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

Activate a ProductListing

post

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

/v1/product-listing/activate

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}$

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/product-listing/activate

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text"
}

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

Deactivate a ProductListing

post

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

/v1/product-listing/deactivate

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}$

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/product-listing/deactivate

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text"
}

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

Place a ProductListing in a ClickCrate

post

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

/v1/product-listing/place

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}$

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

pricenumberRequired

Responses

200

200

application/json

messagestringRequired

transactionsstring[]Required

400

400

application/json

post

/v1/product-listing/place

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text",
  "clickcrateId": "text",
  "price": 1
}

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

Remove a ProductListing from a ClickCrate

post

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

/v1/product-listing/remove

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}$

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

Responses

200

200

application/json

messagestringRequired

transactionstringRequired

404

404

application/json

post

/v1/product-listing/remove

HTTPcURLJavaScriptPython

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

{
  "productListingId": "text",
  "clickcrateId": "text"
}

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