Set vacation mode

PATCH/me

Toggle the Seller’s vacation flag. While on vacation, listings are not browsable.

When to use

Use this operation to set vacation mode.

Endpoint

PATCH /me

Environment	Base URL
Sandbox	https://api-sandbox.snapcaster.ca/api/v1/marketplace
Production	https://api.snapcaster.ca/api/v1/marketplace

Authentication

• marketplaceApiKey - http bearer. Seller-scoped Marketplace API key, presented as `Authorization: Bearer mp_{sellerCode}_{hex}`. The `mp_{sellerCode}_` prefix identifies the Seller; the trailing hex is the secret. Generated by the Seller and pasted into its Platform.

Request

No parameters.

Request body (application/json)

Field	Type	Constraints	Meaning	Example
vacationrequired	boolean	None	Whether the Seller has temporarily hidden all Listings from Browse.	true (generated)

Example

Sandbox is the default. These requests use the contract's canonical field examples.

Generated cURL request - Sandbox: Generated request

curl --request PATCH \
  --url 'https://api-sandbox.snapcaster.ca/api/v1/marketplace/me' \
  --header "Authorization: Bearer $MARKETPLACE_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "vacation": true
}'

Response

200

Updated store status.

Generated Response 200: Generated response 200

{
  "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"
          }
        }
      ]
    }
  }
}

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)

Errors

Status	Code	Meaning	Do this
400	INVALID_REQUEST	The request failed validation (`INVALID_REQUEST`).	Correct the fields named in the error details, then retry the request.
401	UNAUTHORIZED	Missing or invalid Marketplace API key (`UNAUTHORIZED`).	Send the Marketplace API key for this Seller as a Bearer token, then retry.

Related

Operations

• Get store status

Concepts

• Credentials and sandbox
• API versioning

Changelog

None.

Schema

Full schema details (34 fields)

Parameters

None.

Request

Field	Type	Constraints	Meaning	Example
vacationrequired	boolean	None	Whether the Seller has temporarily hidden all Listings from Browse.	true (generated)

Response 200 (application/json)

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)

Error 400 (application/json)

Field	Type	Constraints	Meaning	Example
successrequired	boolean	allowed values: false	Whether the operation completed as requested.	false (generated)
errorrequired	object	None	Structured error information returned when the request cannot be completed.	{ "code": "UNAUTHORIZED", "message": "string" } (generated)
error.coderequired	string	allowed values: UNAUTHORIZED, INVALID_REQUEST, UNSUPPORTED_API_VERSION, SELLER_SOURCE_EXCLUSIVE, BATCH_TOO_LARGE, RATE_LIMITED, ORDER_NOT_FOUND, SELLER_NOT_FOUND, INVALID_TRANSITION, CHECKOUT_IDEMPOTENCY_KEY_REUSED, CHECKOUT_MANUAL_SELLER_UNSUPPORTED, CHECKOUT_SELF_PURCHASE_NOT_ALLOWED, CHECKOUT_SELLER_UNAVAILABLE, CHECKOUT_NOT_FOUND, FEATURE_DISABLED	Stable public error code the Platform can branch on.	UNAUTHORIZED (generated)
error.messagerequired	string	None	A human-readable explanation of the result.	string (generated)
error.details	unknown	None	Additional structured context for diagnosing the result.	{} (generated)

Error 401 (application/json)

Field	Type	Constraints	Meaning	Example
successrequired	boolean	allowed values: false	Whether the operation completed as requested.	false (generated)
errorrequired	object	None	Structured error information returned when the request cannot be completed.	{ "code": "UNAUTHORIZED", "message": "string" } (generated)
error.coderequired	string	allowed values: UNAUTHORIZED, INVALID_REQUEST, UNSUPPORTED_API_VERSION, SELLER_SOURCE_EXCLUSIVE, BATCH_TOO_LARGE, RATE_LIMITED, ORDER_NOT_FOUND, SELLER_NOT_FOUND, INVALID_TRANSITION, CHECKOUT_IDEMPOTENCY_KEY_REUSED, CHECKOUT_MANUAL_SELLER_UNSUPPORTED, CHECKOUT_SELF_PURCHASE_NOT_ALLOWED, CHECKOUT_SELLER_UNAVAILABLE, CHECKOUT_NOT_FOUND, FEATURE_DISABLED	Stable public error code the Platform can branch on.	UNAUTHORIZED (generated)
error.messagerequired	string	None	A human-readable explanation of the result.	string (generated)
error.details	unknown	None	Additional structured context for diagnosing the result.	{} (generated)