Shopfront Developers
Host
Object
HostChange
| Fields | Type | Description |
|---|---|---|
|
id |
The Shopfront ID of the host change |
|
|
clientId |
String! |
The ID of the host change provided by the host file |
|
applyTo |
String! |
The type of item to apply this change to |
|
match |
The item this change has matched to, if |
|
|
rawMatch |
The raw matching details for the host change |
|
|
change |
The details about how the change will be made |
|
|
applyAt |
The earliest period of time to apply the change |
|
|
receivedAt |
The time the change was received |
Object
HostChangesConnection
| Fields | Type | Description |
|---|---|---|
|
edges |
[GetHostChangesHostChangeTypeEdge] |
A list of changes on the host connection |
|
pageInfo |
Information about the current page of the connection |
Object
HostConnection
| Fields | Type | Description |
|---|---|---|
|
id |
The ID of the host connection |
|
|
type |
The type of host connection this is |
|
|
outlet |
The Outlet this host file is connected to |
|
|
priceSet |
The Price Set this host file is connected to |
|
|
metadata |
The metadata related to this host file |
|
|
settings |
The settings related to this host file |
|
|
credentials |
The credentials related to this host connection |
|
|
user |
The user this host connection is associated with |
Object
HostHistoryConnection
| Fields | Type | Description |
|---|---|---|
|
edges |
[GetHostChangesHostHistoryTypeEdge] |
A list of changes that have occurred from the host connection |
|
pageInfo |
Information about the current page of the connection |
Object
HostHistory
| Fields | Type | Description |
|---|---|---|
|
change |
The Host Connection change that occurred |
|
|
revisions |
The revisions that are related to the change |
|
|
appliedTo |
The item this change was applied to |
|
|
actionedAt |
The time the change was actioned |
Object
HostIdentifierChangesConnection
| Fields | Type | Description |
|---|---|---|
|
edges |
[GetPendingHostIdentifiersHostChangeTypeEdge] |
A list of changes on the host connection |
|
pageInfo |
Information about the current page of the connection |
Object
HostMappingItem
| Fields | Type | Description |
|---|---|---|
|
id |
String! |
The ID of the host item |
|
name |
String! |
The name of the item from the host file |
|
caseQuantity |
Float! |
The case quantity of the item from the host file |
Object
HostMappingProduct
| Fields | Type | Description |
|---|---|---|
|
product |
The Shopfront ID of the host change |
|
|
mapped |
The time the change was received |
Object
HostRelatedItemDetail
| Fields | Type | Description |
|---|---|---|
|
key |
String! |
The identifier for the detail, this can be publicly visible |
|
description |
String! |
The description for the detail, it can be a blank string |
|
type |
The type of data this is |
|
|
value |
The value of the detail (this is to be formatted according to the |
Object
HostRelatedItemSection
| Fields | Type | Description |
|---|---|---|
|
title |
String! |
The title for the section |
|
description |
String! |
A long description for the section, whilst this can't be null it can be an empty string |
|
details |
The details relating to this section |
Object
HostRelatedItem
| Fields | Type | Description |
|---|---|---|
|
id |
String! |
The ID of the item provided by the host connection |
|
name |
String! |
The name of the item according to the host file |
|
basicDetails |
Basic details about the item, this list is arbitrary and up to each host file to provide |
|
|
sections |
Different arbitrary sections returned from the host file describing the item |