Skip to main content

CreateOrderInput

Autogenerated input type of CreateOrder

input CreateOrderInput {
  autoFulfill: Boolean
  autoFulfillSettings: JSON
  billToAddress: AddressInput
  billToCompany: String
  billToEmail: String
  billToName: String
  billToPhone: String
  brandId: ID @deprecated
  clientMutationId: String
  expectedDeliveryDate: ISO8601Date
  expectedShipDate: ISO8601Date
  financialStatus: OrderFinancialStatusEnum
  giftMessage: String
  orderItems: [OrderItemInput!]
  orderMetadata: JSON
  orderNotes: [NoteInput!]
  orderNumber: String
  orderTags: [String!]
  originOrderId: String
  originalCarrierService: String
  requestedCarrierServiceId: String
  requestedCarrierServiceName: 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
  sourceIntegrationId: ID
  status: NewOrderStatusEnum
  totalTax: Decimal
}

Fields​

CreateOrderInput.autoFulfill ● Boolean scalar common​

Enables or disables the auto-fulfill behaviour for the order.

CreateOrderInput.autoFulfillSettings ● JSON scalar common​

The information packet which stores the holding period of the order.

CreateOrderInput.billToAddress ● AddressInput input common​

The address where the bill will be sent to.

CreateOrderInput.billToCompany ● String scalar common​

The company of the person who will receive the bill.

CreateOrderInput.billToEmail ● String scalar common​

The email of the person who will receive the bill.

CreateOrderInput.billToName ● String scalar common​

The name of the person who will receive the bill.

CreateOrderInput.billToPhone ● String scalar common​

The phone of the person who will receive the bill.

CreateOrderInput.brandId ● ID deprecated scalar common​

DEPRECATED

This argument is deprecated and will be removed in the future. Brand is becoming a product-only attribute. Use company context instead.

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 common​

A unique identifier for the client performing the mutation.

CreateOrderInput.expectedDeliveryDate ● ISO8601Date scalar common​

The expected delivery date for the order.

CreateOrderInput.expectedShipDate ● ISO8601Date scalar common​

The expected ship date for the order.

CreateOrderInput.financialStatus ● OrderFinancialStatusEnum enum orders​

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

CreateOrderInput.giftMessage ● String scalar common​

The gift message that is part of the order.

CreateOrderInput.orderItems ● [OrderItemInput!] list input orders​

The items that are part of the order.

CreateOrderInput.orderMetadata ● JSON scalar common​

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 common​

The notes that are part of the order.

CreateOrderInput.orderNumber ● String scalar common​

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

CreateOrderInput.orderTags ● [String!] list scalar common​

The tags that are part of the order.

CreateOrderInput.originOrderId ● String scalar common​

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

CreateOrderInput.originalCarrierService ● String scalar common​

The string representation of the shipping carrier service.

CreateOrderInput.requestedCarrierServiceId ● String scalar common​

The requested shipping carrier service.

CreateOrderInput.requestedCarrierServiceName ● String scalar common​

The requested shipping carrier service.

CreateOrderInput.responsibleId ● ID scalar common​

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 common​

The sales channel ID for the order.

CreateOrderInput.selectedCarrierId ● ID scalar common​

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

CreateOrderInput.selectedCarrierServiceId ● ID scalar common​

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

CreateOrderInput.shipToCompany ● String scalar common​

The company of the person who will receive the order.

CreateOrderInput.shipToEmail ● String scalar common​

The email of the person who will receive the order.

CreateOrderInput.shipToName ● String scalar common​

The name of the person who will receive the order.

CreateOrderInput.shipToPhone ● String scalar common​

The phone of the person who will receive the order.

CreateOrderInput.shipToSameAsBillTo ● Boolean scalar common​

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

CreateOrderInput.shippingAddress ● AddressInput input common​

The address where the order will be shipped to.

CreateOrderInput.shippingCarrierService ● String scalar common​

The requested shipping carrier service.

CreateOrderInput.shippingCost ● Decimal scalar common​

The shipping cost paid by the customer.

CreateOrderInput.sourceIntegrationId ● ID scalar common​

The integration party id that originated this order. Required for orders attributed to upstream custom integrations so that Authority can claim ownership and prevent edits from the Endless UI.

CreateOrderInput.status ● NewOrderStatusEnum enum orders​

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 common​

The total tax for the order.

Member Of​

createOrder mutation