SellerCenter

Seller Details

Overview

The Seller Details API allows you to retrieve and manage seller account information. Sellers represent merchant accounts in the marketplace, each with unique identifiers, profile information, and account settings.

In SellerCenter, sellers can be managed through various endpoints:

  • Current seller operations: Get and update information for the currently authenticated seller
  • Seller listing: List and search sellers with filtering options
  • Seller lookup: Find sellers by ID or external source ID
  • Seller creation: Create new seller accounts (admin only)

Important: Note that changes in some fields in seller profile require approval. Endpoints return approved values. If a field requires QC (e.g., "Account Number") and was changed from approved value A to B but not yet approved by admins, the endpoint will return A as the value.

Get Current Seller Details

GET /v2/seller

Summary: Fetch currently logged in seller details

Description: Fetch current seller data. Note that changes in some fields in seller profile require approval. This endpoint returns approved values. In more details, it means the following: if there is a field that requires QC (e.g. "Account Number"), and it was changed from the approved value A to B and this change was not yet approved by admins, then this endpoint will return A as the value of this field.

A seller might be delisted due to multiple reasons. The following delist reasons are defined:

  • USER_DEFINED (id = 1)
  • HOLIDAY_MODE (id = 2)
  • DAILY_ORDER_LIMIT (id = 4)
  • PENDING_ORDER_LIMIT (id = 8)
  • PENDING_TO_SHIPPED_ORDER_LIMIT (id = 16)
GET
/v2/seller

Authorization

BearerAuth
AuthorizationBearer <token>

OAuth 2.0 Bearer token authentication

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v2/seller"
{
  "id": 32,
  "uuid": "093a9e34-xxxx-xxxx-xxxx-53766e338abf",
  "srcId": "131",
  "shortCode": "CI100AA",
  "status": "active",
  "name": "GFG eCommerce Technologies GmbH",
  "companyName": "GFG eCommerce Technologies GmbH",
  "email": "seller@example.com",
  "taxClass": "national",
  "createdAt": "2022-01-15T10:30:00Z",
  "updatedAt": "2022-01-20T14:45:00Z",
  "verified": true,
  "listed": true,
  "delistReasons": [],
  "profileFields": [
    {
      "name": "shop_name",
      "displayValue": "My Shop",
      "value": "My Shop"
    }
  ],
  "agreementsAccepted": true
}
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}
{
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found"
}
{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}
{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

Update Seller Details

PATCH /v2/seller

Summary: Update seller details

Description: Update seller details for the currently authenticated seller. This endpoint allows you to modify seller information such as email, company name, and other profile fields.

Note: Some fields may require QC approval before changes take effect. Use the profile diff endpoint to check which fields have pending changes.

PATCH
/v2/seller

Authorization

BearerAuth
AuthorizationBearer <token>

OAuth 2.0 Bearer token authentication

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Seller update data

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://loading/v2/seller" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}
{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The provided data failed validation"
}
{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}
{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

Get All Sellers

GET /v2/sellers

Summary: Get all sellers

Description: List and filter sellers. Note that changes in some fields in seller profile require approval. This endpoint returns approved values. In more details it means following: if there is field which requires QC, let's say "Account Number", and it was changed from approved value A to B and this change was not yet approved by admins, then this endpoint will return A as value of this field.

Parameters:

  • sellerSrcId (query, optional): External ID of the seller from Shop System
  • ids[] (query, optional): IDs of sellers to search
  • uuids[] (query, optional): UUIDs of sellers to search
  • shortCodes[] (query, optional): ShortCodes of sellers to search
  • name (query, optional): Name or part of the name of the seller
  • onlyActive (query, optional): When set to truthy value, only sellers that were ever synced with the shop system and with active account status will be returned. Temporary delisted sellers will be also returned. Sellers reached order limit will be also returned. Sellers with HolidayMode active will be also returned. Sellers who has not yet approved changes in their profile (but were approved and synced at some point previously) will be also returned. When not set or set to falsy value, all sellers will be returned (no filtering by active status will be applied)
  • limit (query, optional): The maximum number of items to return
  • offset (query, optional): The number of items to skip before starting to return results
GET
/v2/sellers

Authorization

BearerAuth
AuthorizationBearer <token>

OAuth 2.0 Bearer token authentication

In: header

Query Parameters

sellerSrcId?string

External ID of the seller from Shop System

ids[]?array<>

IDs of sellers to search

uuids[]?array<>

UUIDs of sellers to search

shortCodes[]?array<>

ShortCodes of sellers to search

name?string

Name or part of the name of the seller

onlyActive?boolean

Filter by active status

limit?integer

The maximum number of items to return

offset?integer

The number of items to skip before starting to return results

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v2/sellers"
{
  "items": [
    {
      "id": 32,
      "uuid": "093a9e34-xxxx-xxxx-xxxx-53766e338abf",
      "srcId": "131",
      "shortCode": "CI100AA",
      "status": "active",
      "name": "GFG eCommerce Technologies GmbH",
      "companyName": "GFG eCommerce Technologies GmbH",
      "email": "seller@example.com",
      "taxClass": "national",
      "verified": true,
      "listed": true
    }
  ],
  "pagination": {
    "limit": 50,
    "offset": 0
  }
}
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}
{
  "title": "Access Denied",
  "status": 403,
  "detail": "You do not have permission to access this resource"
}
{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}
{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

Create Seller

POST /v2/sellers

Summary: Create a new seller

Description: Create a new seller by providing the necessary information. This action requires admin privileges.

Note: This endpoint is restricted to users with admin permissions. Regular sellers cannot create new seller accounts.

POST
/v2/sellers

Authorization

BearerAuth
AuthorizationBearer <token>

OAuth 2.0 Bearer token authentication

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Seller creation data

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://loading/v2/sellers" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": 33,
  "uuid": "094b9f45-yyyy-yyyy-yyyy-64877f449bcg",
  "srcId": "132",
  "shortCode": "CI101AB",
  "status": "active",
  "name": "New Seller Company",
  "companyName": "New Seller Company",
  "email": "newseller@example.com"
}
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}
{
  "title": "Access Denied",
  "status": 403,
  "detail": "You do not have permission to access this resource"
}
{
  "title": "Unprocessable Entity",
  "status": 422,
  "detail": "The provided data failed validation"
}
{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}
{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

Get Seller By ID

GET /v2/sellers/{sellerId}

Summary: Get seller by ID

Description: Fetch a seller by a provided id. You need to either belong to the seller or have permission to see all sellers in order to get the data. Note that changes in some fields in seller profile require approval. This endpoint returns approved values. In more details it means following: if there is field which requires QC, let's say "Account Number", and it was changed from approved value A to B and this change was not yet approved by admins, then this endpoint will return A as value of this field.

Parameters:

  • sellerId (path, required): Numeric ID of the seller
GET
/v2/sellers/{sellerId}

Authorization

BearerAuth
AuthorizationBearer <token>

OAuth 2.0 Bearer token authentication

In: header

Path Parameters

sellerId*integer

Numeric ID of the seller

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v2/sellers/0"
{}
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}
{
  "title": "Access Denied",
  "status": 403,
  "detail": "You do not have permission to access this resource"
}
{
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found"
}
{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}
{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

Get Seller By External Source ID

GET /v2/sellers/external/{sellerSrcId}

Summary: Get seller by external source ID

Description: Fetch a seller by a provided src id. You need to either belong to the seller or have permission to see all sellers in order to get the data. Note that changes in some fields in seller profile require approval. This endpoint returns approved values. In more details it means following: if there is field which requires QC, let's say "Account Number", and it was changed from approved value A to B and this change was not yet approved by admins, then this endpoint will return A as value of this field.

Parameters:

  • sellerSrcId (path, required): External ID of the seller from Shop System

Note: This endpoint is useful when you have the external source ID from your shop system and need to find the corresponding seller in SellerCenter.

GET
/v2/sellers/external/{sellerSrcId}

Authorization

BearerAuth
AuthorizationBearer <token>

OAuth 2.0 Bearer token authentication

In: header

Path Parameters

sellerSrcId*string

External ID of the seller from Shop System

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/v2/sellers/external/string"
{
  "id": 32,
  "uuid": "093a9e34-xxxx-xxxx-xxxx-53766e338abf",
  "srcId": "131",
  "shortCode": "CI100AA",
  "status": "active",
  "name": "GFG eCommerce Technologies GmbH",
  "companyName": "GFG eCommerce Technologies GmbH",
  "email": "seller@example.com",
  "taxClass": "national",
  "verified": true,
  "listed": true,
  "profileFields": [
    {
      "name": "shop_name",
      "displayValue": "My Shop",
      "value": "My Shop"
    }
  ]
}
{
  "title": "Unauthorized",
  "status": 401,
  "detail": "Authentication credentials were not provided or are invalid"
}
{
  "title": "Access Denied",
  "status": 403,
  "detail": "You do not have permission to access this resource"
}
{
  "title": "Not Found",
  "status": 404,
  "detail": "The requested resource was not found"
}
{
  "title": "Service Unavailable",
  "status": 500,
  "detail": "The service is temporarily unavailable. Please try again later."
}
{
  "title": "Service Unavailable Due to Maintenance Mode",
  "status": 503,
  "detail": "The service is currently under maintenance. Please try again later."
}

On this page

OverviewGet Current Seller DetailsUpdate Seller DetailsGet All SellersCreate SellerGet Seller By IDGet Seller By External Source ID