allSellers

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

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

NameTypeDescription
updatedSinceISO8601DateTimeReturn 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)
includeDeletedBooleanInclude the “soft-deleted” Sellers in your result set
afterStringPagination cursor for moving through result set - more on pagination here
beforeStringNot in use - backwards pagination not supported
firstIntPagination page size - more on pagination here
lastIntNot in use - backwards pagination not supported

Response

Returns AllAdvertsConnection


Error Responses

HTTP ErrorError MessageMeaning
401UnauthorizedYou don’t have access to the endpoint, likely Basic Authentication credentials are missing
401API Token has expiredYou 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
200Field ‘allSellers’ doesn’t exist on type ‘Query’You will receive this message if you are not passing a valid Operator API Key

Further Reading