allSellers

The allSellers query allows you to return a list of Sellers on the platform, including Sellers that have been deleted.

2 minute read

Key Information

Use-Case

allSellers can be used to return active and delete sellers on the platform. It would typically be used in a Connected Integration to sync Sellers from Marketplacer to an upstream system in the connected domain.

Can be used as an alternative to sellerSearch which only allows for the return of active sellers.

Availability

Operator API: Yes
Seller API: No

Example

query getAllSellers{
  allSellers( 
    includeDeleted: false 
    first:1000 after: null) {
      nodes {
        ... on Seller {
        __typename
        id
        businessName
        online
        isRetailer
      }
      ... on DeletedSeller {
        __typename
        id
      }
    }
  }
}

Arguments

Name	Type	Description
updatedSince	ISO8601DateTime	Return sellers updated since the provided time stamp
accountType	[AllSellersAccountTypeEnum!]	Filter on whether a Seller is a `RETAILER` (actively selling on Marketplacer) or `PROSPECTIVE` (a prospective seller not yet actively selling)
includeDeleted	Boolean	Include the “soft-deleted” Sellers in your result set
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 AllAdvertsConnection

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
200	Field ‘allSellers’ doesn’t exist on type ‘Query’	You will receive this message if you are not passing a valid Operator API Key