StoreConfigWarehouseSalesChannel
Type: schema
Description
Sales channel on a warehouse as returned in StoreConfig.
TypeScript Definition
typescript
StoreConfigWarehouseSalesChannel: {components["schemas"]["StoreConfigSalesChannel"] & {
/** @description Observed values: `web`, `pos`, `internal`. */
channel_type?: string
}Component References
| Reference | Resolves To |
|---|---|
components["schemas"]["StoreConfigSalesChannel"] | StoreConfigSalesChannel |
OpenAPI Schema
json
{
"title": "StoreConfigWarehouseSalesChannel",
"description": "Sales channel on a warehouse as returned in `StoreConfig`.",
"allOf": [
{
"$ref": "#/components/schemas/StoreConfigSalesChannel"
},
{
"type": "object",
"properties": {
"channel_type": {
"description": "Observed values: `web`, `pos`, `internal`.",
"type": "string"
},
"is_default": {
"type": "boolean"
},
"domain": {
"type": [
"string",
"null"
]
},
"app_platform": {
"type": [
"string",
"null"
]
},
"external_id": {
"type": [
"string",
"null"
]
},
"pos_vendor": {
"type": [
"string",
"null"
]
},
"store_id": {
"type": "string"
},
"store_name": {
"type": "string"
},
"marketplace_id": {
"description": "Set only when `kind` is `marketplace`.",
"type": [
"string",
"null"
]
},
"marketplace": {
"description": "`null` unless `kind` is `marketplace`.",
"oneOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"marketplace_type": {
"type": "string"
},
"store_id": {
"description": "The marketplace operator's store.",
"type": "string"
},
"sync_products": {
"type": "boolean"
},
"sync_inventory": {
"type": "boolean"
},
"sync_orders": {
"type": "boolean"
},
"required_credentials_params": {
"type": [
"object",
"null"
]
},
"created_at": {
"type": "string",
"format": "date-time"
},
"modified_at": {
"type": "string",
"format": "date-time"
}
}
},
{
"type": "null"
}
]
},
"seller_account": {
"description": "This store's seller account on the marketplace. `null` unless `kind` is `marketplace`.",
"oneOf": [
{
"$ref": "#/components/schemas/StoreConfigWarehouseSellerAccount"
},
{
"type": "null"
}
]
}
}
}
],
"x-tags": [
"Store"
]
}Auto-generated from OpenAPI spec and TypeScript definitions