seller topic object description.
a seller object description
No Additional PropertiesList of the seller's applicable taxes
No Additional ItemsTax code
Tax label
Average time for a seller to accept or refuse an order (in seconds)
Rate of accepted orders
List of the channel codes associated to the seller
No Additional ItemsThe start date of the closing of the seller
The end date of the closing of the seller
Contact information
City of the contact
Civility of the contact (Mr, Mrs, Miss or Neutral)
Code ISO 3166-1 alpha-3 of the contact's country
Fax, max length: 20 characters.
First name of the contact
Last name of the contact
Phone
Secondary phone
State (address) of the contact
First line of the address of the contact
Second line of the address of the contact
Website of the seller
Zip code of the contact
The currency of the seller (iso format)
Creation date of the seller
The description of the seller, max length: 3000 characters.
Seller domains
No Additional ItemsNumber of evaluations for the seller
Whether or not this seller offers free shipping to customers
Global grade of the seller
Date until when the seller is immunized against suspension
Whether or not the seller is professional
KYC information (only supported when KYC feature is enabled)
KYC refusal reason
KYC status
The date of the last modification of the seller
Url of the seller's logo image
Total count of active offers of the seller
Opco internal id for the seller. (operator internal id in mirakl)
Average time for a seller to answer to an order message (in seconds)
Total count of debited orders (or if Pay on Delivery, accepted) of the seller
Payment details
Paid balance
Is the subscription to the marketplace charged to the seller
Payable balance
Is the payment blocked by the operator
Pending balance
Subscription is free from this date
Subscription is free until this date
Payment information
Bank Account Number
Must match regular expression:[0-9]+
Must be at least 3 characters long
Must be at most 17 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Bank account BIC code (aka Swift Code)
Routing Number of the bank, (aka ABA code)
Must match regular expression:[0-9]+
"ABA"
Bank account number
Must be at least 6 characters long
Must be at most 10 characters long
Bank state branch code
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
"AUBSB"
Account number
Must match regular expression:[0-9]+
Must be at least 10 characters long
Must be at most 11 characters long
Account type
- C: Checking account
- P: Savings account
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank code
Must match regular expression:[0-9]+
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Branch code
Must match regular expression:[0-9]+
"BRAZILIAN"
Bank account number
Must match regular expression:[0-9]+
Must be at least 5 characters long
Must be at most 12 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Bank institution number
Must match regular expression:[0-9]+
Bank account swift code
Bank transit number
Must match regular expression:[0-9]+
"CANADIAN"
Account number
Must match regular expression:[0-9]+
Account type
- C: Checking account
- P: Savings account
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
"COLOMBIAN"
Bank account number
Must match regular expression:[0-9]+
Must be at least 9 characters long
Must be at most 12 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Bank account swift code
"HK"
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Bank account BIC code
Bank account IBAN
"IBAN"
Account number
Must match regular expression:[0-9a-zA-Z]+
Must be at least 6 characters long
Must be at most 20 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Indian financial system code
Bank account swift code
"INDIAN"
Bank account number
Must match regular expression:[0-9]+
Must be at least 1 characters long
Must be at most 9 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank code
Must match regular expression:[0-9]+
Must be at least 1 characters long
Must be at most 4 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Branch name
"ISRAELI"
Bank account number
Must be at least 6 characters long
Must be at most 8 characters long
Account type
- C: Current account
- P: Savings account
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank code
Must match regular expression:[0-9]+
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Branch code
Must match regular expression:[0-9]+
Branch name
Bank account swift code
"JAPANESE"
Bank account number
Must match regular expression:[0-9]+
Must be at least 5 characters long
Must be at most 20 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Clave Bancaria Estandarizada
"MEXICAN"
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
The bank account NUBAN code
Must be at least 10 characters long
Must be at most 255 characters long
"NUBAN"
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Bank Account Number
Must be at least 10 characters long
Must be at most 10 characters long
Bank State Branch code.
"NZBSB"
Bank Account Number
Must match regular expression:[0-9]+
Must be at least 9 characters long
Must be at most 12 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank Key
Must match regular expression:[0-9]+
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Name of the owner of the payment information
Must be at least 3 characters long
Must be at most 100 characters long
Bank account swift code
"SG"
Account number
Must match regular expression:[0-9]+
Must be at least 8 characters long
Must be at most 14 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank code
Must match regular expression:[0-9a-zA-Z]+
Must be at least 2 characters long
Must be at most 3 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Branch code
Must match regular expression:[0-9a-zA-Z]+
Must be at least 3 characters long
Must be at most 4 characters long
"TAIWANESE"
Account number
Must match regular expression:[0-9]+
Must be at least 10 characters long
Must be at most 12 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
"THAI"
Bank Account Number
Must match regular expression:[0-9]+
Must be at least 6 characters long
Must be at most 11 characters long
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank Sort Code (Size must be 6 digits)
Must match regular expression:[0-9]+
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Bank account swift code
"UK"
Account number
Must match regular expression:[0-9]+
Must be at least 5 characters long
Must be at most 20 characters long
Account type
- C: Checking account
- P: Savings account
Bank city
Must be at least 3 characters long
Must be at most 100 characters long
Bank name
Must be at least 0 characters long
Must be at most 255 characters long
Bank street name
Must be at least 3 characters long
Must be at most 100 characters long
Bank zip code
Must be at least 0 characters long
Must be at most 255 characters long
Branch code
Must match regular expression:[0-9]+
Must be at least 1 characters long
Must be at most 10 characters long
"URUGUAYAN"
Name of the owner of the payment information
Must be at least 3 characters long
Must be at most 100 characters long
Professional details
Corporate name
Identification number of the seller. For France it would be the SIRET
Tax identification number
List of seller’s producer identifiers per Extended Producer Responsibility (EPR) categories. Only available if the operator setting Activate data collection related to circular economy regulations is enabled.
No Additional ItemsExtended Producer Responsibility (EPR) category code.
Must be at least 0 characters long
Must be at most 255 characters long
Seller producer identifier.
Must be at least 0 characters long
Must be at most 255 characters long
Recycling policy - only available if the operator setting Activate data collection related to circular economy regulations has been enabled.
Must be at most 5000 characters long
Terms of restitution, max length: 5000 characters.
Code ISO 3166-1 alpha-3 of the shipping country
All the pair shipping zone / shipping type accepted by the seller
No Additional ItemsList of custom shipping fields for this shipping zone and shipping method
No Additional ItemsAdditional field's value
"BOOLEAN"
Additional field's value
"DATE"
Additional field's value
"LINK"
Additional field's value
"LIST"
Values of the additional field
No Additional Items"MULTIPLE_VALUESLIST"
Additional field's value
"NUMERIC"
Additional field's value
"REGEX"
Additional field's value
"STRING"
Additional field's value
"TEXTAREA"
Additional field's code
Additional field's type
Minimal amount for free shipping
The code of the shipping type
The label of the shipping type
The code of the shipping zone
The label of the shipping zone
List of additional fields
No Additional ItemsAdditional field's value
"BOOLEAN"
Additional field's value
"DATE"
Additional field's value
"LINK"
Additional field's value
"LIST"
Values of the additional field
No Additional Items"MULTIPLE_VALUESLIST"
Additional field's value
"NUMERIC"
Additional field's value
"REGEX"
Additional field's value
"STRING"
Additional field's value
"TEXTAREA"
Additional field's code
Additional field's type
The identifier of the seller
The name of the seller
Seller state : OPEN or CLOSE
Seller suspension type, current possible values:
- MANUAL: Seller account has been manually suspended in the back-office
- PENDING_APPROVAL: Seller account has been suspended at creation
- AUTOMATIC_SUSPENSION: Seller account has been suspended by Mirakl Quality Control
- INCOMPLETE_PROFILE: Seller account is suspended because some mandatory fields are missing in its profile
Action defines if the seller has to be added/updated or deleted
Specific value:"UPSERT"
Action defines if the seller has to be added/updated or deleted
Specific value:"DELETE"
The identifier of the seller