CreateOrderInput

Autogenerated input type of CreateOrder

input CreateOrderInput {
  billToAddress: AddressInput
  billToCompany: String
  billToEmail: String
  billToName: String
  billToPhone: String
  brandId: ID
  clientMutationId: String
  expectedDeliveryDate: ISO8601DateTime
  expectedShipDate: ISO8601DateTime
  financialStatus: OrderFinancialStatusEnum
  giftMessage: String
  orderItems: [OrderItemInput!]
  orderMetadata: JSON
  orderNotes: [NoteInput!]
  orderNumber: String
  orderTags: [String!]
  originOrderId: String
  responsibleId: ID
  salesChannelId: ID!
  selectedCarrierId: ID
  selectedCarrierServiceId: ID
  shipToCompany: String
  shipToEmail: String
  shipToName: String
  shipToPhone: String
  shipToSameAsBillTo: Boolean
  shippingAddress: AddressInput
  shippingCarrierService: String
  shippingCost: Decimal
  status: NewOrderStatusEnum
  totalTax: Decimal
}

Fields

CreateOrderInput.billToAddress ● AddressInput input

The address where the bill will be sent to.

CreateOrderInput.billToCompany ● String scalar

The company of the person who will receive the bill.

CreateOrderInput.billToEmail ● String scalar

The email of the person who will receive the bill.

CreateOrderInput.billToName ● String scalar

The name of the person who will receive the bill.

CreateOrderInput.billToPhone ● String scalar

The phone of the person who will receive the bill.

CreateOrderInput.brandId ● ID scalar

The brand ID. This parameter is optional, but if not provided, you should provide the header 'X-Brand-Id' with the brand ID.

CreateOrderInput.clientMutationId ● String scalar

A unique identifier for the client performing the mutation.

CreateOrderInput.expectedDeliveryDate ● ISO8601DateTime scalar

The expected delivery date for the order.

CreateOrderInput.expectedShipDate ● ISO8601DateTime scalar

The expected ship date for the order.

CreateOrderInput.financialStatus ● OrderFinancialStatusEnum enum

The financial status of the order. The default value is PAID.

CreateOrderInput.giftMessage ● String scalar

The gift message that is part of the order.

CreateOrderInput.orderItems ● [OrderItemInput!] list input

The items that are part of the order.

CreateOrderInput.orderMetadata ● JSON scalar

The metadata that is part of the order. This metadata can be used to store additional information about the order. For example, data received from an external system.

CreateOrderInput.orderNotes ● [NoteInput!] list input

The notes that are part of the order.

CreateOrderInput.orderNumber ● String scalar

The order number. This order number must be unique in the brand context. If not provided, the system will generate a unique order number.

CreateOrderInput.orderTags ● [String!] list scalar

The tags that are part of the order.

CreateOrderInput.originOrderId ● String scalar

The order ID from the external system. This parameter is optional, but if provided, it must be unique in the brand context.

CreateOrderInput.responsibleId ● ID scalar

The responsible ID for the order. This parameter is optional, but if provided, it should be a party id and the party must be a person.

CreateOrderInput.salesChannelId ● ID! non-null scalar

The sales channel ID for the order.

CreateOrderInput.selectedCarrierId ● ID scalar

The selected carrier ID for the order. This parameter is optional, but if provided, it should be a carrier id.

CreateOrderInput.selectedCarrierServiceId ● ID scalar

The selected service ID for the order. This parameter is optional, but if provided, it should be a service id.

CreateOrderInput.shipToCompany ● String scalar

The company of the person who will receive the order.

CreateOrderInput.shipToEmail ● String scalar

The email of the person who will receive the order.

CreateOrderInput.shipToName ● String scalar

The name of the person who will receive the order.

CreateOrderInput.shipToPhone ● String scalar

The phone of the person who will receive the order.

CreateOrderInput.shipToSameAsBillTo ● Boolean scalar

Indicates if the bill to address is the same as the ship to address.

CreateOrderInput.shippingAddress ● AddressInput input

The address where the order will be shipped to.

CreateOrderInput.shippingCarrierService ● String scalar

The requested shipping carrier service.

CreateOrderInput.shippingCost ● Decimal scalar

The shipping cost paid by the customer.

CreateOrderInput.status ● NewOrderStatusEnum enum

The status of the new order. The initial status is limited to draft or ordered. To change the status, you must process the order first.

CreateOrderInput.totalTax ● Decimal scalar

The total tax for the order.

Member Of

createOrder mutation