Update a seller requirement
Changes how a requirement is worded, what it asks for, where it sits in the checklist, and whether it blocks approval.
type is not accepted: a saved row’s kind never changes, because
anything a seller already submitted answered the old one.
Required scope: write_sellers (for API-key authentication).
Authorizations
Secret API key for admin access
JWT token for admin user authentication
Path Parameters
Body
What the seller sees. Required for kinds that can be added more than once, since the wording is the only thing telling them apart. Left blank on the others, the kind names itself.
"Business registration"
Instructions shown to the seller.
"A copy of your certificate of incorporation."
Place in the checklist.
1
true
Whether this blocks approval. Off means recommended.
true
Configuration for this kind, per its type's schema.
Custom field definitions this requirement asks the seller to fill in (required_custom_fields kind).
Response
seller requirement updated
Requirement kind. Built-in: accept_terms, complete_profile, billing_address, returns_address, delivery_method, package_type, minimum_products, payout_account, required_custom_fields, policy, attestation, operator_review, document. Extensions may register more.
Settings of a seller requirement, shaped by its type (see x-spree-preferences-by-type). A type an extension registers is a plain object, described by the schema its /types entry carries.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14

