snapcasterDevelopers

    API reference · Types

    StoreStatus

    Part of the response of GET /me and PATCH /me.

    Type: object

    Example

    Schema example: from the GET /me response
    {
  "sellerId": 42,
  "sellerCode": "sandbox-cards",
  "storeName": "Sandbox Cards",
  "currency": "CAD",
  "region": "CA",
  "subscription": "orders",
  "active": true,
  "vacation": false,
  "counts": {
    "total": 1,
    "matched": 1,
    "unmatched": 0,
    "browsable": 1
  },
  "readiness": {
    "browseEligible": true,
    "effectiveTermsVersion": "2026-10-27",
    "incompletePrerequisites": []
  }
}

    Fields

    sellerId integer required

    The seller's numeric id, the data.seller_id on every webhook event for this seller. Store it with sellerCode when you validate a key, so you can route events before the first sale.

    Example 42

    sellerCode string required

    Example sandbox-cards

    storeName string required

    Example Sandbox Cards

    currency string required

    The ISO 4217 currency code used for monetary amounts.

    Example CAD

    region string required

    The market region whose rules and currency apply.

    Example CA

    subscription string or null required

    Your platform's subscription, the event families it receives: orders, inventory or both. Snapcaster sets it during onboarding. The order operations answer an inventory subscription with 403 SUBSCRIPTION_EXCLUDES_ORDERS. null when the seller is linked to no platform.

    Constraints: allowed values: orders, inventory, both, null Example orders

    active boolean required

    False while the seller is suspended.

    Example true

    vacation boolean required

    Whether the seller has temporarily hidden all listings from browse.

    Example false

    counts object required

    Counts for the seller's listings.

    Show child fieldsHide child fields
    counts.total integer required

    The total number of records.

    Example 1

    counts.matched integer required

    The number of listings matched to the canonical catalog.

    Example 1

    counts.unmatched integer required

    The number of listings not yet matched to the canonical catalog.

    Example 0

    counts.browsable integer required

    Zero while suspended or on vacation.

    Example 1

    readiness object required

    The seller’s current browse-readiness assessment.

    Show child fieldsHide child fields
    readiness.browseEligible boolean required

    See Browse readiness in Core concepts.

    Example true

    readiness.effectiveTermsVersion string required

    Example 2026-10-27

    readiness.incompletePrerequisites array of object required

    See Browse readiness in Core concepts.

    Show child fieldsHide child fields
    readiness.incompletePrerequisites[].code string required

    The stable machine-readable code for this result.

    Constraints: allowed values: SELLER_ACTIVE, VACATION_DISABLED, SHIPPING_OPTION_CONFIGURED, CONNECTED_ACCOUNT_CANADIAN, PAYOUTS_READY, CURRENT_SELLER_TERMS_ACCEPTED, TAX_PROFILE_COMPLETE, CANADIAN_SHIPMENT_ORIGIN_CONFIRMED, AUTHENTICATOR_ENROLLED, AUTHENTICATOR_RECOVERY_VERIFIED, OPERATOR_REVIEW_APPROVED, SHOP_LINK_ACTIVE, BILLING_TERMS_ACCEPTED, BILLING_AGENT_ELECTION_REQUIRED, REPORTING_IDENTITY_REQUIRED

    readiness.incompletePrerequisites[].message string required

    A human-readable explanation of the result.

    readiness.incompletePrerequisites[].action object required

    The request that closes the prerequisite. VACATION_DISABLED's action is PATCH /api/v1/marketplace/me, which the marketplace API key can send with {"vacation": false}. Every other /api/ action is an account API request made with the seller's Snapcaster login, and a mailto: action is an email to Snapcaster.

    Show child fieldsHide child fields
    readiness.incompletePrerequisites[].action.type string required
    readiness.incompletePrerequisites[].action.method string required

    Constraints: allowed values: GET, POST, PATCH, PUT

    readiness.incompletePrerequisites[].action.href string required

    The relative API path for the corrective action.

    readiness.incompletePrerequisites[].review object

    Present on the OPERATOR_REVIEW_APPROVED entry only: where the seller readiness review stands. Never carries a reason.

    Show child fieldsHide child fields
    readiness.incompletePrerequisites[].review.status string required

    Constraints: allowed values: incomplete, follow_up_required, rejected

    Used by