StoreConfigServiceProvider
Type: schema
TypeScript Definition
typescript
StoreConfigServiceProvider: {components["schemas"]["OtherServiceProvider"] & {
/** @description Connected credential values. Keys match `required_credentials_params[].input_field_name`. Returned as `null`, or as an empty array `[]`, when the provider has no stored credentials. */
api_credentials?: $Read<{
[key: string]: unknown
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["OtherServiceProvider"] | OtherServiceProvider |
OpenAPI Schema
json
{
"title": "StoreConfigServiceProvider",
"allOf": [
{
"$ref": "#/components/schemas/OtherServiceProvider"
},
{
"type": "object",
"properties": {
"api_credentials": {
"description": "Connected credential values. Keys match `required_credentials_params[].input_field_name`. Returned as `null`, or as an empty array `[]`, when the provider has no stored credentials.",
"type": [
"object",
"array",
"null"
],
"additionalProperties": true,
"readOnly": true
},
"alias": {
"type": "string"
},
"logo": {
"description": "Primary logo URL. Same as `logo_light` for `auto` providers; `null` for `manual` methods.",
"type": [
"string",
"null"
],
"readOnly": true
},
"service_sub_type": {
"type": [
"string",
"null"
]
},
"used_in_credit_line": {
"description": "`true` when the option is linked in the store credit-line payment method configuration.",
"type": "boolean",
"readOnly": true
},
"used_in_payout": {
"description": "`true` when the option is linked in the store `payout` configuration.",
"type": "boolean",
"readOnly": true
},
"channels": {
"description": "Payment providers only. IDs of the sales channels the store offers this method on; an empty list offers it on every channel. Each must be one of the store's storefront channels. When read, IDs of deleted channels are left out, unless all of them were deleted: the method then keeps their IDs and is offered on no channel.",
"type": "array",
"items": {
"type": "string"
}
},
"warehouses": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"readOnly": true
},
"shipping_zone": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"readOnly": true
},
"fulfillment_type": {
"description": "Present on shipping providers.",
"type": "string",
"enum": [
"delivery"
],
"readOnly": true
},
"type": {
"description": "Present on shipping providers (`auto` fulfillment integrations).",
"type": "string",
"enum": [
"auto"
],
"readOnly": true
},
"is_forward_shipping": {
"type": "boolean",
"default": false,
"readOnly": true
},
"is_return_shipping": {
"type": "boolean",
"default": false,
"readOnly": true
}
}
}
],
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions