Skip to content

Sellers

Manage sellers, commissions, members, invitations, categories, and brands.

Fields

idstringUnique identifier of the resource.
namestring
currencyCodestringISO 4217 currency code, for example PEN.
statusenumactive · inactive · deleted
slugstringURL-friendly identifier.
countryCodestringISO 3166-1 alpha-2 country code, for example PE.
descriptionstring
phonestring
See all 24 fields
emailNotificationstring
deliveryPolicystring
privacyAndSecurityPolicystring
commissionPercentnumber
exchangeRatenumber
isInternalboolean
catalogSettingsobject
shippingSettingsobject
legalInfoobject
billingInfoobject
profileobject
fulfillmentobject
ratingobject
createdOnstringTimestamp when the resource was created, in ISO 8601.
updatedOnstringTimestamp when the resource was last modified, in ISO 8601.
storeIdstring

Operations

MethodEndpointOperation
POST/v1/sellersCreate seller
GET/v1/sellersList sellers
GET/v1/sellers/{id}Get seller by ID
GET/v1/sellers/summaryGet seller and product approval counts
PATCH/v1/sellers/{id}Update a seller
DELETE/v1/sellers/{id}Delete a seller
POST/v1/sellers/{id}/support-sessionsView the admin as a seller
PUT/v1/sellers/{id}/billing-infoUpdate a seller's bank account
PATCH/v1/sellers/{id}/statusUpdate seller status

Import & export

MethodEndpointOperation
POST/v1/sellers/exportsExport sellers
POST/v1/sellers/importsImport sellers

Commissions

MethodEndpointOperation
GET/v1/sellers/{sellerId}/commissionsList seller commissions
PUT/v1/sellers/{sellerId}/commissionsReplace seller commissions

Categories & brands

MethodEndpointOperation
GET/v1/sellers/{sellerId}/scopesList seller scopes
PUT/v1/sellers/{sellerId}/scopesReplace seller scopes

Spreadsheet

MethodEndpointOperation
POST/v1/sellers/spreadsheetCreate seller spreadsheet
GET/v1/sellers/spreadsheet/{id}Read seller spreadsheet

Last updated: