Skip to content
Pidgely Docs

API reference · Commerce (stores)

Disconnect a store

DELETEhttps://api.pidgely.com/commerce/stores/{id}
View as Markdown

Removes Pidgely's webhooks (and access, where the platform allows it) and deletes the synced data in the background.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Path parameters

Name Type Required Description
id string Yes Store id. UUID.

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X DELETE 'https://api.pidgely.com/commerce/stores/0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "commerce",
  "id": "0199d8a2-6f3c-7c51-9e2a-3b1f0c6d4e21",
  "deleted": true
}

Response fields

Name Type Required Description
object string Yes Object type.
id string Yes Unique id (UUID). UUID.
deleted boolean Yes —

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.