Set vacation mode

200

Updated store status.

Response body: StoreStatusResponse

success boolean required

Whether the operation completed as requested.

Constraints: allowed values: true

data StoreStatus required

The operation or event payload.

Show child fieldsHide child fields

data.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.

data.sellerCode string required

data.storeName string required

data.currency string required

The ISO 4217 currency code used for monetary amounts.

data.region string required

The market region whose rules and currency apply.

data.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

data.active boolean required

False while the seller is suspended.

data.vacation boolean required

Whether the seller has temporarily hidden all listings from browse.

data.counts object required

Counts for the seller's listings.

Show child fieldsHide child fields

data.counts.total integer required

The total number of records.

data.counts.matched integer required

The number of listings matched to the canonical catalog.

data.counts.unmatched integer required

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

data.counts.browsable integer required

Zero while suspended or on vacation.

data.readiness object required

The seller’s current browse-readiness assessment.

Show child fieldsHide child fields

data.readiness.browseEligible boolean required

See Browse readiness in Core concepts.

data.readiness.effectiveTermsVersion string required

data.readiness.incompletePrerequisites array of object required

See Browse readiness in Core concepts.

Show child fieldsHide child fields

data.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

data.readiness.incompletePrerequisites[].message string required

A human-readable explanation of the result.

data.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

data.readiness.incompletePrerequisites[].action.type string required

data.readiness.incompletePrerequisites[].action.method string required

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

data.readiness.incompletePrerequisites[].action.href string required

The relative API path for the corrective action.

data.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

data.readiness.incompletePrerequisites[].review.status string required

Constraints: allowed values: incomplete, follow_up_required, rejected