brands

The brand is a key piece of information required to create a product. This query allows sellers to retrieve brand reference data from Marketplacer with a view to creating products.

less than a minute

Key Information

Use-Case

The brands query can return a list of brands (created by the marketplace operator) so that you can use that information to create and update products as described here.

Availability

Operator API: Yes
Seller API: Yes

query BrandsQuery {
  brands(first: 10, after: null) {
    totalCount
    pageInfo {
      hasNextPage
      endCursor
    }
    edges {
      node {
        id
        name
      }
    }
  }
}

Arguments

Name	Type	Description
showOnlineOnly	Boolean	Return brands that are related only to online Products
after	String	Pagination cursor for moving through result set - more on pagination here
before	String	Not in use - backwards pagination not supported
first	Int	Pagination page size - more on pagination here
last	Int	Not in use - backwards pagination not supported

Response

Returns BrandsConnection

Error Responses

HTTP Error	Error Message	Meaning
401	Unauthorized	You don’t have access to the endpoint, likely Basic Authentication credentials are missing
401	API Token has expired	You don’t have access to the endpoint, likely that you are either not supplying an API Key, or the key you are supplying is invalid