CreateDraftOrderInput
Autogenerated input type of CreateDraftOrder
input CreateDraftOrderInput {
b2bData: V2OrderB2BDataInput
billToCompany: String
billToEmail: String
billToName: String
billToPhone: String
billingAddress: AddressInput
brandId: ID @deprecated
clientMutationId: String
customerId: ID
customerLocationId: ID
endShippingDate: ISO8601Date
expectedDeliveryDate: ISO8601Date
expectedShipDate: ISO8601Date
financialStatus: String
giftMessage: String
orderItems: [OrderItemInput!]
orderMetadata: JSON
orderNotes: [NoteInput!]
orderNumber: String
orderTags: [String!]
originalCarrierService: String
requestedCarrierServiceId: ID
requestedCarrierServiceName: String
responsibleId: ID
routingStrategy: [String!]
salesChannelId: ID
selectedCarrierId: ID
selectedCarrierServiceId: ID
shipToCompany: String
shipToEmail: String
shipToName: String
shipToPhone: String
shipToSameAsBillTo: Boolean
shippingAddress: AddressInput
shippingCarrierService: String
shippingCost: Decimal
startShippingDate: ISO8601Date
totalTax: Decimal
}
Fields
CreateDraftOrderInput.b2bData ● V2OrderB2BDataInput input orders
B2B data for the order.
CreateDraftOrderInput.billToCompany ● String scalar common
The company of the person who will receive the bill.
CreateDraftOrderInput.billToEmail ● String scalar common
The email of the person who will receive the bill.
CreateDraftOrderInput.billToName ● String scalar common
The name of the person who will receive the bill.
CreateDraftOrderInput.billToPhone ● String scalar common
The phone of the person who will receive the bill.
CreateDraftOrderInput.billingAddress ● AddressInput input common
The address where the bill will be sent to.
CreateDraftOrderInput.brandId ● ID deprecated scalar common
This argument 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.
CreateDraftOrderInput.clientMutationId ● String scalar common
A unique identifier for the client performing the mutation.
CreateDraftOrderInput.customerId ● ID scalar common
The customer ID to associate with the order.
CreateDraftOrderInput.customerLocationId ● ID scalar common
Copy one of the customer's saved locations into this new order. The location must belong to the order's customer, which is customer_id when given and the sales channel's default customer otherwise. Later location edits do not change this order.
CreateDraftOrderInput.endShippingDate ● ISO8601Date scalar common
End of the requested shipping window.
CreateDraftOrderInput.expectedDeliveryDate ● ISO8601Date scalar common
The expected delivery date for the order.
CreateDraftOrderInput.expectedShipDate ● ISO8601Date scalar common
The expected ship date for the order.
CreateDraftOrderInput.financialStatus ● String scalar common
The financial status of the order. Defaults to pending.
CreateDraftOrderInput.giftMessage ● String scalar common
A gift message for the order.
CreateDraftOrderInput.orderItems ● [OrderItemInput!] list input orders
The items that are part of the order. Items without a submitted price remain unpriced.
CreateDraftOrderInput.orderMetadata ● JSON scalar common
The metadata that is part of the order. This metadata can be used to store additional information about the order.
CreateDraftOrderInput.orderNotes ● [NoteInput!] list input common
The notes that are part of the order.
CreateDraftOrderInput.orderNumber ● String scalar common
The order number. This order number must be unique in the brand context. If not provided, the system will generate a unique order number.
CreateDraftOrderInput.orderTags ● [String!] list scalar common
The tags that are part of the order.
CreateDraftOrderInput.originalCarrierService ● String scalar common
The original carrier service name.
CreateDraftOrderInput.requestedCarrierServiceId ● ID scalar common
The requested carrier service ID.
CreateDraftOrderInput.requestedCarrierServiceName ● String scalar common
The requested carrier service name.
CreateDraftOrderInput.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.
CreateDraftOrderInput.routingStrategy ● [String!] list scalar common
The routing strategy for order fulfillment.
CreateDraftOrderInput.salesChannelId ● ID scalar common
The sales channel ID for the order. If not provided, the system may use a default channel.
CreateDraftOrderInput.selectedCarrierId ● ID scalar common
The selected carrier ID for shipping.
CreateDraftOrderInput.selectedCarrierServiceId ● ID scalar common
The selected carrier service ID for shipping.
CreateDraftOrderInput.shipToCompany ● String scalar common
The company of the person who will receive the order.
CreateDraftOrderInput.shipToEmail ● String scalar common
The email of the person who will receive the order.
CreateDraftOrderInput.shipToName ● String scalar common
The name of the person who will receive the order.
CreateDraftOrderInput.shipToPhone ● String scalar common
The phone of the person who will receive the order.
CreateDraftOrderInput.shipToSameAsBillTo ● Boolean scalar common
Indicates if the bill to address is the same as the ship to address.
CreateDraftOrderInput.shippingAddress ● AddressInput input common
The address where the order will be shipped to.
CreateDraftOrderInput.shippingCarrierService ● String scalar common
The shipping carrier service name.
CreateDraftOrderInput.shippingCost ● Decimal scalar common
The shipping cost for the order.
CreateDraftOrderInput.startShippingDate ● ISO8601Date scalar common
Start of the requested shipping window.
CreateDraftOrderInput.totalTax ● Decimal scalar common
The total tax amount for the order.
Member Of
createDraftOrder mutation