Skip to main content

SaveDraftOrderInput

Autogenerated input type of SaveDraftOrder

input SaveDraftOrderInput {
  billToCompany: String
  billToEmail: String
  billToName: String
  billToPhone: String
  billingAddress: AddressInput
  brandId: ID @deprecated
  clientMutationId: String
  customerId: ID
  enrichmentData: OrderEnrichmentDataInput
  expectedDeliveryDate: ISO8601Date
  expectedShipDate: ISO8601Date
  financialStatus: String
  giftMessage: String
  orderId: ID!
  orderItems: [OrderItemInput!]
  orderMetadata: JSON
  orderNotes: [NoteInput!]
  orderNumber: String
  orderTags: [String!]
  orderType: OrderTypeEnum
  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
  totalTax: Decimal
}

Fields​

SaveDraftOrderInput.billToCompany ● String scalar common​

The company of the person who will receive the bill.

SaveDraftOrderInput.billToEmail ● String scalar common​

The email of the person who will receive the bill.

SaveDraftOrderInput.billToName ● String scalar common​

The name of the person who will receive the bill.

SaveDraftOrderInput.billToPhone ● String scalar common​

The phone of the person who will receive the bill.

SaveDraftOrderInput.billingAddress ● AddressInput input common​

The address where the bill will be sent to.

SaveDraftOrderInput.brandId ● ID deprecated scalar common​

DEPRECATED

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.

SaveDraftOrderInput.clientMutationId ● String scalar common​

A unique identifier for the client performing the mutation.

SaveDraftOrderInput.customerId ● ID scalar common​

The customer ID to associate with the order.

SaveDraftOrderInput.enrichmentData ● OrderEnrichmentDataInput input orders​

B2B order enrichment data including PO number, customer ref, ship window dates, etc.

SaveDraftOrderInput.expectedDeliveryDate ● ISO8601Date scalar common​

The expected delivery date for the order.

SaveDraftOrderInput.expectedShipDate ● ISO8601Date scalar common​

The expected ship date for the order.

SaveDraftOrderInput.financialStatus ● String scalar common​

The financial status of the order.

SaveDraftOrderInput.giftMessage ● String scalar common​

A gift message for the order.

SaveDraftOrderInput.orderId ● ID! non-null scalar common​

The ID of the draft order to save/update.

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

The items that are part of the order. If provided, replaces existing items.

SaveDraftOrderInput.orderMetadata ● JSON scalar common​

The metadata that is part of the order. This metadata can be used to store additional information about the order.

SaveDraftOrderInput.orderNotes ● [NoteInput!] list input common​

The notes that are part of the order. If provided, adds new notes.

SaveDraftOrderInput.orderNumber ● String scalar common​

The order number. This order number must be unique in the brand context. If not provided, the existing order number is retained.

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

The tags that are part of the order. If provided, adds new tags.

SaveDraftOrderInput.orderType ● OrderTypeEnum enum orders​

The type of the order. This can be either B2B for wholesale orders or DTC for regular orders.

SaveDraftOrderInput.originalCarrierService ● String scalar common​

The original carrier service name.

SaveDraftOrderInput.requestedCarrierServiceId ● ID scalar common​

The requested carrier service ID.

SaveDraftOrderInput.requestedCarrierServiceName ● String scalar common​

The requested carrier service name.

SaveDraftOrderInput.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.

SaveDraftOrderInput.routingStrategy ● [String!] list scalar common​

The routing strategy for order fulfillment.

SaveDraftOrderInput.salesChannelId ● ID scalar common​

The sales channel ID for the order.

SaveDraftOrderInput.selectedCarrierId ● ID scalar common​

The selected carrier ID for shipping.

SaveDraftOrderInput.selectedCarrierServiceId ● ID scalar common​

The selected carrier service ID for shipping.

SaveDraftOrderInput.shipToCompany ● String scalar common​

The company of the person who will receive the order.

SaveDraftOrderInput.shipToEmail ● String scalar common​

The email of the person who will receive the order.

SaveDraftOrderInput.shipToName ● String scalar common​

The name of the person who will receive the order.

SaveDraftOrderInput.shipToPhone ● String scalar common​

The phone of the person who will receive the order.

SaveDraftOrderInput.shipToSameAsBillTo ● Boolean scalar common​

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

SaveDraftOrderInput.shippingAddress ● AddressInput input common​

The address where the order will be shipped to.

SaveDraftOrderInput.shippingCarrierService ● String scalar common​

The shipping carrier service name.

SaveDraftOrderInput.shippingCost ● Decimal scalar common​

The shipping cost for the order.

SaveDraftOrderInput.totalTax ● Decimal scalar common​

The total tax amount for the order.

Member Of​

saveDraftOrder mutation