Objects / Orders — Shopfront Developer Documentation

Object

OrderActivityGeneralComment

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
comment	String!	The comment that was made

Object

OrderActivityLineComment

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
product	Product!	The product that was commented on
comment	String!	The comment that was made

Object

OrderActivityOrderDetailUpdate

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
detail	String!	The detail that was changed (in a human readable format)
old	String!	The value the detail was changed from
new	String!	The value the detail was changed to

Object

OrderActivityOrderLineUpdate

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
product	Product!	The product that was modified on the order
old	JSON	What the order line was before changes were applied, this is a partial view of the `OrderProduct` type
new	JSON	What the order line became after the changes were applied, this is a partial view of the `OrderProduct` type

Object

OrderActivityReviewAttachmentRemoved

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
attachment	String!	The file that have been removed from the order review

Object

OrderActivityReviewAttachmentsAdded

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
attachments	[String]	The list of file names that have been attached to the order review

Object

OrderActivityReviewStatusUpdate

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
status	OrderReviewStatusEnum!	The status that the review changed to

Object

OrderActivityReviewerStatusRemoved

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed

Object

OrderActivityReviewerStatusUpdate

Implements

List of interfaces this object implements

OrderActivityContentInterface

Fields	Type	Description
type	OrderActivityTypeEnum!	The type of activity that was performed
status	OrderReviewerStatusEnum!	The status applied to the review by the reviewer

Object

OrderActivity

Fields	Type	Description
user	User!	The user who performed the activity
content	OrderActivityContentInterface!	The content of the activity
processTime	DateTime!	The time the activity was performed

Object

OrderProduct

Fields	Type	Description
caseQuantity	Float!	The case quantity on the order
orderedQuantity	Float!	The quantity that was ordered
receivedQuantity	Float!	The quantity that was received
baseCost	Float!	The base cost for the product
orderedCost	Float	The base cost for when the product was ordered
fees	Float!	The fees assigned to the product
freight	Float!	The freight assigned to the product
paymentFees	Float!	The payment fees assigned to the product
rebate	Float!	The rebate assigned to the product
supplier	Supplier	The supplier for the product (used when there is no from supplier)
supplierCode	String!	The supplier code for the product
itemsPerWeek	Float	The number of items sold per week (only for generated orders)
item	Product!	The current product

Object

OrderReceiveResults

Fields	Type	Description
review	OrderReview	Returns a review if one was created instead of actioning the order
order	Order!	The order that was actioned

Object

OrderReview

Fields	Type	Description
id	ID!	The ID of the review
status	OrderReviewStatusEnum!	The status of the review
orderStatus	OrderReviewForStatusEnum!	The status of the order this review is for moving to
createdBy	User!	The user who created the review
createdAt	DateTime!	The time the review was created
reviewers	[OrderReviewer!]!	A list of users who are reviewing this order
attachments	[MediaAttachment!]!	The attachments on the order review
order	Order!	The order that this order review is attached to
activity	OrderReviewOrderActivityConnection	The activity which has occurred since the order entered the review phase

OrderReviewOrderActivityConnection

Object — ConnectionType of OrderActivity

Sortable Fields

Fields from OrderActivity that can be used to sort the connection items

timestamp

Arguments	Type	Description
types	[OrderActivityTypeEnum!]	Filters the type of activities returned

Object

OrderReviewer

Fields	Type	Description
user	User!	The user who is performing the review
status	OrderReviewerStatusEnum!	The status of who the reviewer views the current review

Object

OrderSendResults

Fields	Type	Description
review	OrderReview	Returns a review if one was created instead of actioning the order
orders	[Order!]!	The orders that were actioned

Object

Order

Implements

List of interfaces this object implements

InventoryLogEventInterface

Fields	Type	Description
id	ID!	The ID of the order
type	OrderTypeEnum!	The type of order
status	OrderStatusEnum!	The status of the order
completed	Boolean	Whether the order has been completed or not
undergoingReview	Boolean!	Whether the order is currently undergoing review
to	OrderAddressInterface	Who the order is to
from	OrderAddressInterface	Who the order is from
orderDate	Date!	The date for the order
dueDate	Date	The date the order is due to be received or for payment
enteredAs	DefaultOrderTaxEnum	How the costs should be displayed on the order page (Does not represent how the cost values are actually stored)
invoiceNumber	String!	The order number or invoice number for the order
reference	String!	The reference for the order
notes	String	Any public notes relating to the order
internalNotes	String!	Any internal notes relating to the order
includeFreight	Boolean!	Whether the total cost of the order includes freight
totalCost	Float	The total cost of the order
lineCount	Float	The total number of lines on the order
expectedTotal	Float	The expected total for the order
feePercentage	Float	The order fee percentage
createdAt	DateTime	The date and time the order was created
sentAt	DateTime	The date and time the order was sent
receivedAt	DateTime	The date and time the order was received
createdBy	User	The user who created the order
sentBy	User	The user who sent the order
receivedBy	User	The user who received the order
mergedInto	Order	Get the order that this is merged into
products Deprecated	[OrderProduct]	The products on the order products has been superseded by productConnection
productConnection	OrderOrderProductConnection	The list of products on the order
backorderedProducts	[ProductBackorder!]!	The products which were on backorder for this order
reviews	[OrderReview!]!	A list of reviews that have occurred for this order
review	OrderReview!	Retrieve details about a specific review for an order
attachments	[MediaAttachment!]!	The attachments on the order

OrderOrderProductConnection

Object — ConnectionType of OrderProduct

Sortable Fields

Fields from OrderProduct that can be used to sort the connection items

name
createdAt
updatedAt

Arguments	Type	Description
id	ID	The ID of the product to return (used for filtering the products)