Skip to main content

ShipmentRecord

A day's shipped orders for a SKU, by sales channel.

type ShipmentRecord {
company: Company
companyId: ID!
id: ID!
note: String
period: ISO8601DateTime!
product: ShipmentProduct
quantityShipped: Int!
revenue: MonetaryValue
salesChannelHandle: String!
shipmentCount: Int
sku: String!
source: SourceEnum!
}

Fields

ShipmentRecord.company ● Company object companies

The company the shipments belong to.

ShipmentRecord.companyId ● ID! non-null scalar common

The company the shipments belong to.

ShipmentRecord.id ● ID! non-null scalar common

Unique identifier of the shipped orders record.

ShipmentRecord.note ● String scalar common

Free-text explanation for the entry, when provided.

ShipmentRecord.period ● ISO8601DateTime! non-null scalar common

The day the shipments correspond to (UTC).

ShipmentRecord.product ● ShipmentProduct object common

The product for this SKU, when it exists.

ShipmentRecord.quantityShipped ● Int! non-null scalar common

Units shipped.

ShipmentRecord.revenue ● MonetaryValue object common

Value of the shipped product as a Money object.

ShipmentRecord.salesChannelHandle ● String! non-null scalar common

The sales channel handle.

ShipmentRecord.shipmentCount ● Int scalar common

Number of distinct shipments.

ShipmentRecord.sku ● String! non-null scalar common

The SKU that shipped.

ShipmentRecord.source ● SourceEnum! non-null enum common

Where the row came from.

Returned By

echoCreateShipmentRecord mutation ● echoUpdateShipmentRecord mutation

Member Of

ShipmentRecordConnection object ● ShipmentRecordEdge object