Skip to main content

CreateSalesOrderInput

Input to create a sales order.

input CreateSalesOrderInput {
  billingAddress: CreateSalesOrderAddressInput
  branchAddressId: String
  convertMissingCurrencyPrices: Boolean
  currency: String
  customerEmail: String
  customerId: String!
  customerMobile: String
  customerPoNumber: String
  deliveryInstructions: String
  deliveryOptionId: ID
  discountAmount: Float!
  discountSchemeId: String
  exchangeRate: Float
  idempotencyKey: String
  internalNotes: String
  items: [CreateSalesOrderItemInput!]!
  notes: String
  orderDate: String
  paymentMethod: String
  paymentTerms: String!
  promisedDate: DateTime
  reference: String
  shippingAddress: CreateSalesOrderAddressInput
  shippingAmount: Float!
  shippingMethod: String
  shippingTaxAmount: Float
  status: SalesOrderStatus
  taxCalculationMethod: String
  warehouseId: String
}

Fields​

CreateSalesOrderInput.billingAddress ● CreateSalesOrderAddressInput input​

Billing address for the order.

CreateSalesOrderInput.branchAddressId ● String scalar​

Branch attribution: the branch Address id this order was placed for. Written at create only.

CreateSalesOrderInput.convertMissingCurrencyPrices ● Boolean scalar​

Opt in to pricing a foreign-currency line with no price in the order currency by converting its base price at exchangeRate. Without it such a line is refused. A price in the order currency always wins.

CreateSalesOrderInput.currency ● String scalar​

ISO 4217 currency code of the order.

CreateSalesOrderInput.customerEmail ● String scalar​

Customer email shown on the order.

CreateSalesOrderInput.customerId ● String! non-null scalar​

The ID of the customer the order is for.

CreateSalesOrderInput.customerMobile ● String scalar​

Customer mobile number shown on the order.

CreateSalesOrderInput.customerPoNumber ● String scalar​

Buyer-supplied PO number, persisted to SalesOrder.customerPoNumber.

CreateSalesOrderInput.deliveryInstructions ● String scalar​

Delivery instructions for the order.

CreateSalesOrderInput.deliveryOptionId ● ID scalar​

A staff delivery option id from staffDeliveryOptions. The server sets shippingAmount (the quoted fee, no tax added), the ship-to address and the delivery choice from it; the client shippingAmount is ignored.

CreateSalesOrderInput.discountAmount ● Float! non-null scalar​

Additional order-level discount as an amount. Must not be negative.

CreateSalesOrderInput.discountSchemeId ● String scalar​

The ID of the discount scheme to apply to the order.

CreateSalesOrderInput.exchangeRate ● Float scalar​

Exchange rate between the order currency and the organization's base currency. Must be greater than zero.

CreateSalesOrderInput.idempotencyKey ● String scalar​

A unique key you generate. Retrying with the same key returns the original order instead of creating a duplicate.

CreateSalesOrderInput.internalNotes ● String scalar​

Notes for your team only, not shown to the customer.

CreateSalesOrderInput.items ● [CreateSalesOrderItemInput!]! non-null input​

The order lines.

CreateSalesOrderInput.notes ● String scalar​

Notes for the customer.

CreateSalesOrderInput.orderDate ● String scalar​

The order's date, as an ISO 8601 date. Empty means today. Any other date needs the backdate permission and is recorded in the audit trail.

CreateSalesOrderInput.paymentMethod ● String scalar​

The payment method the buyer chose at checkout (e.g. EFT, ON_ACCOUNT, GATEWAY, COD). Display attribution only — persisted to metadata.paymentMethod; paymentTerms stays the behavioural signal.

CreateSalesOrderInput.paymentTerms ● String! non-null scalar​

Payment terms code for the order.

CreateSalesOrderInput.promisedDate ● DateTime scalar​

Date the order is promised for delivery.

CreateSalesOrderInput.reference ● String scalar​

Reference shown on the order.

CreateSalesOrderInput.shippingAddress ● CreateSalesOrderAddressInput input​

Shipping address for the order.

CreateSalesOrderInput.shippingAmount ● Float! non-null scalar​

Shipping charge for the order.

CreateSalesOrderInput.shippingMethod ● String scalar​

Shipping method for the order.

CreateSalesOrderInput.shippingTaxAmount ● Float scalar​

Tax on the shipping/delivery fee, added to header taxAmount.

CreateSalesOrderInput.status ● SalesOrderStatus enum​

Initial status: DRAFT (no inventory reserved) or CONFIRMED (reserves inventory). Defaults to DRAFT.

CreateSalesOrderInput.taxCalculationMethod ● String scalar​

Whether prices include or exclude tax: INCLUSIVE or EXCLUSIVE.

CreateSalesOrderInput.warehouseId ● String scalar​

The ID of the default warehouse for the order.

Member Of​

createSalesOrder mutation