Admin APIApi keys
Manage Sales Channels of a Publishable API Key
Manage the sales channels of a publishable API key, either to associate them or remove them from the API key.
AuthorizationBearer <token>
In: header
Path Parameters
id*string
The API key's ID.
Query Parameters
fields?string
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Request Body
application/json
add?array<add>
The sales channels to add to the publishable API key.
remove?array<remove>
The sales channels to remove from the publishable API key.
Response Body
application/json
application/json
text/plain
application/json
application/json
application/json
application/json
curl -X POST "https://{tenant}.api.myxclade.com/admin/api-keys/string/sales-channels" \ -H "Content-Type: application/json" \ -d '{}'{
"api_key": {
"id": "string",
"token": "string",
"redacted": "sk_...123",
"title": "string",
"type": "secret",
"last_used_at": "2019-08-24T14:15:22Z",
"created_by": "string",
"created_at": "2019-08-24T14:15:22Z",
"revoked_by": "string",
"revoked_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"deleted_at": "2019-08-24T14:15:22Z"
}
}{
"message": "Discount must be set to dynamic",
"type": "not_allowed"
}"Unauthorized"{
"message": "Entity with id 1 was not found",
"type": "not_found"
}{
"code": "unknown_error",
"message": "The request conflicted with another request. You may retry the request with the provided Idempotency-Key.",
"type": "QueryRunnerAlreadyReleasedError"
}{
"code": "invalid_request_error",
"message": "Discount with code TEST already exists.",
"type": "duplicate_error"
}{
"code": "api_error",
"message": "An error occured while hashing password",
"type": "database_error"
}