Staging APIProduction API

collectionBySlug

This query loads the information of collection based on slug.

General pattern

query{
	collectionBySlug(marketplaceID: "marketplace-id", slug: "String"){
  	field_1
    field_2 {
       nested_field_1
       ...
    }
  }
}

Sample query

query{
  collectionBySlug(marketplaceID: "d15b1b02-3c87-434d-a7fb-004b27415fbc", slug: "metaverso"){
    id
    marketplaceID
    name
    slug
    description
  }
}

Sample response

{
  "data": {
    "collectionBySlug": {
      "id": "f2cd1160-1c99-4a27-b948-d48a60ba2e11",
      "marketplaceID": "d15b1b02-3c87-434d-a7fb-004b27415fbc",
      "name": "metaverso",
      "slug": "metaverso",
      "description": "Test"
    }
  }
}

Arguments

NameTypeDescription
marketplaceIDUUIDThe marketplace ID.
slugStringDescription of the slug.

Fields

NameTypeDescription
MarketplaceCollectionObjectContains information from MarketplaceCollection such as marketplace ID, name, slug, description, status, active date, collection type, and items.

Example

Load the collection data using slug and marketplace ID: