StoreStatusResponse

Reusable StoreStatusResponse schema.

Type: object

Fields

Field	Type	Constraints	Meaning	Example
successrequired	boolean	allowed values: true	Whether the operation completed as requested.	true (generated)
datarequired	object	None	The operation or event payload.	{ "sellerCode": "string", "storeName": "string", "currency": "string", "region": "string", "active": true, "vacation": true, "counts": { "total": 0, "matched": 0, "unmatched": 0, "browsable": 0 }, "readiness": { "browseEligible": true, "effectiveTermsVersion": "string", "incompletePrerequisites": [ { "code": "SELLER_ACTIVE", "message": "string", "action": { "type": "string", "method": "GET", "href": "string" } } ] } } (generated)
data.sellerCoderequired	string	None	Seller Code for the surrounding data record.	string (generated)
data.storeNamerequired	string	None	Store Name for the surrounding data record.	string (generated)
data.currencyrequired	string	None	The ISO 4217 currency code used for monetary amounts.	string (generated)
data.regionrequired	string	None	The market region whose rules and currency apply.	string (generated)
data.activerequired	boolean	None	False while the Seller is suspended.	true (generated)
data.vacationrequired	boolean	None	Whether the Seller has temporarily hidden all Listings from Browse.	true (generated)
data.countsrequired	object	None	Aggregate counts for the Seller’s Listings.	{ "total": 0, "matched": 0, "unmatched": 0, "browsable": 0 } (generated)
data.counts.totalrequired	integer	None	The total number of records in the measured set.	0 (generated)
data.counts.matchedrequired	integer	None	The number of Listings matched to the canonical catalog.	0 (generated)
data.counts.unmatchedrequired	integer	None	The number of Listings not yet matched to the canonical catalog.	0 (generated)
data.counts.browsablerequired	integer	None	Zero while suspended or on vacation.	0 (generated)
data.readinessrequired	object	None	The Seller’s current Browse-readiness assessment.	{ "browseEligible": true, "effectiveTermsVersion": "string", "incompletePrerequisites": [ { "code": "SELLER_ACTIVE", "message": "string", "action": { "type": "string", "method": "GET", "href": "string" } } ] } (generated)
data.readiness.browseEligiblerequired	boolean	None	Browse Eligible for the surrounding readiness record.	true (generated)
data.readiness.effectiveTermsVersionrequired	string	None	Effective Terms Version for the surrounding readiness record.	string (generated)
data.readiness.incompletePrerequisitesrequired	array of object	None	Incomplete Prerequisites for the surrounding readiness record.	[ { "code": "SELLER_ACTIVE", "message": "string", "action": { "type": "string", "method": "GET", "href": "string" } } ] (generated)
data.readiness.incompletePrerequisites[].coderequired	string	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	The stable machine-readable code for this result.	SELLER_ACTIVE (generated)
data.readiness.incompletePrerequisites[].messagerequired	string	None	A human-readable explanation of the result.	string (generated)
data.readiness.incompletePrerequisites[].actionrequired	object	None	The corrective action available for this condition.	{ "type": "string", "method": "GET", "href": "string" } (generated)
data.readiness.incompletePrerequisites[].action.typerequired	string	None	The stable kind of the surrounding resource or action.	string (generated)
data.readiness.incompletePrerequisites[].action.methodrequired	string	allowed values: GET, POST, PATCH	The method used to carry out the surrounding action.	GET (generated)
data.readiness.incompletePrerequisites[].action.hrefrequired	string	None	The relative API path for the corrective action.	string (generated)

Examples

Generated Schema example: Generated StoreStatusResponse

{
  "success": true,
  "data": {
    "sellerCode": "string",
    "storeName": "string",
    "currency": "string",
    "region": "string",
    "active": true,
    "vacation": true,
    "counts": {
      "total": 0,
      "matched": 0,
      "unmatched": 0,
      "browsable": 0
    },
    "readiness": {
      "browseEligible": true,
      "effectiveTermsVersion": "string",
      "incompletePrerequisites": [
        {
          "code": "SELLER_ACTIVE",
          "message": "string",
          "action": {
            "type": "string",
            "method": "GET",
            "href": "string"
          }
        }
      ]
    }
  }
}