ChannelOrderCreateInput

Input.

Input for creating an order, including its line items and any known fulfillment tracking, in a single call.

Fields

amounts

•

ChannelOrderAmountsCreateInput!

Required

Money breakdown for the order, if available.

cancelledAt

•

DateTime

When the order was cancelled, if applicable.

channelConnectionId

•

The channel connection this order belongs to, if known.

channelOrderReference

•

String

The merchant-facing order reference (e.g. Shopify order name #1001).

currency

•

CurrencyCode!

Required

Transaction currency.

customerId

•

String

The customer's identifier on the external platform, if available. Used to recognize repeat customers.

destination

•

ChannelOrderPartyCreateInput

Ship-to address details, if available.

discountCodes

•

[String!]

Discount codes applied to the order, if any.

externalCreatedAt

•

DateTime

When the order was created on the external platform.

externalOrderId

•

String!

Required

The order's unique identifier on the external platform.

externalUpdatedAt

•

DateTime

When the order was last updated on the external platform.

fulfillmentStatus

•

String

The order's fulfillment status.

items

•

[ChannelOrderItemCreateInput!]!

Required

Line items on this order.

merchantNote

•

String

A private note about the order, not shown to the customer.

paymentMethod

•

String

The payment method used for the order.

paymentStatus

•

String

The order's payment status.

payor

•

ChannelOrderPartyCreateInput

Bill-to address details, if available.

presentmentCurrency

•

CurrencyCode

Presentment currency (may differ from transaction currency).

riskMessages

•

String

Additional detail about the order's risk assessment, if available.

riskRecommendation

•

String

A recommendation on how to handle the order based on its risk assessment, if available.

riskScore

•

Decimal

A risk score for the order, if available.

shippingProvider

•

String

The shipping provider selected for the order, if known.

sourceName

•

String

Where the order originated (e.g. online store, point of sale, mobile app).

Fields

Was this page helpful?