Skip to main content

CreateOrderInput

type CreateOrderInput {
  id: ID
  billingAddress: OrderAddressInput
  branchSessionId: String
  currencyCode: String
  customer: OrderCustomerInput
  host: String
  note: String
  orderAdjustments: [OrderAdjustmentInput!]
  orderedAt: Timestamp
  orderLineItems: [OrderLineItemInput!]!
  orderTagIds: [String!]
  priceListId: String
  salesChannelId: String
  shippingAddress: OrderAddressInput
  shippingLines: [OrderShippingLineInput!]
  shippingMethod: OrderShippingMethodEnum
  sourceId: String
  terminalId: String
}

Fields

idID
billingAddressOrderAddressInput

It is the address to which the order will be billing.

branchSessionIdString

It is the branch session id of the order. If the order is placed via ikasPos, this field can be sent as filled.

currencyCodeString

It is the currency code of the order.

It is the customer information in the order.

hostString

Host name of order source.

noteString

It is an order note.

orderAdjustments[OrderAdjustmentInput!]

A list of adjustment objects, each containing information about a adjustment in the order.

orderedAtTimestamp

The date the order was ordered.

orderLineItems[OrderLineItemInput!]!required

A list of line item objects, each containing information about an item in the order.

orderTagIds[String!]

It is the id list of the tags in the order.

  • Is the entered tag id list must be exist in ikas.
priceListIdString

It is the id of the price list that includes the prices of the products in the order.

  • Is the entered id must be exist in ikas.
salesChannelIdString

It is the sales channel id where the order was created.

  • Is the entered id must be exist in ikas.
shippingAddressOrderAddressInput

It is the address to which the order will be shipping.

A list of shipping line objects, each containing information about a shipping in the order.

It is the shipping method enum of the order

sourceIdString

It is the source id of the order. If the order came from the marketplace, it shows the order number in the marketplace.

terminalIdString

It is the terminal session id of the order. If the order is placed via ikasPos, this field can be sent as filled.