Skip to main content

OrderImportInput

No description

input OrderImportInput {
  billing: OrderImportBillingInput!
  channelCode: String!
  createdAt: ISO8601DateTime!
  currency: String!
  deliveryId: String!
  documentationLanguage: String
  invoiceRequired: Boolean
  lines: [OrderImportLineInput!]!
  note: String
  number: String!
  paymentMethod: String
  shippings: [OrderImportShippingInput!]!
  totalGrossAmount: Float!
  totalNetAmount: Float!
  totalPaidAmount: Float!
  totalVatAmount: Float!
}

Fields​

OrderImportInput.billing ● OrderImportBillingInput! non-null input​

The billing address and fiscal data. Must identify a recipient: provide either companyName, or both firstName and lastName.

OrderImportInput.channelCode ● String! non-null scalar​

The code of the sales channel to import the order into. Channel codes are provided by Calicantus.

OrderImportInput.createdAt ● ISO8601DateTime! non-null scalar​

When the order was created on the channel.

OrderImportInput.currency ● String! non-null scalar​

The order currency, as an ISO 4217 code.

OrderImportInput.deliveryId ● String! non-null scalar​

The order identifier as the customer sees it in the e-shop — in almost all cases the same value as number. Required, and returned as submitted in the mutation response.

OrderImportInput.documentationLanguage ● String scalar​

The language of the order's documents, as an ISO 639-1 code (de, en, es, fr or it, case-insensitive, stored uppercase). Any other value is rejected. Defaults to en when omitted.

OrderImportInput.invoiceRequired ● Boolean scalar​

Whether an invoice is required for the order. Forced to true when billing.vatNumber is populated.

OrderImportInput.lines ● [OrderImportLineInput!]! non-null input​

The order lines. At least one line is required.

OrderImportInput.note ● String scalar​

The note written by the buyer when placing the order. Stored as submitted, and readable back through Order.note.

OrderImportInput.number ● String! non-null scalar​

The order number, unique within the channel: a duplicate is rejected with error code DUPLICATED_ORDER, and a number that still has a pending import submission is rejected as well. It is the identifier assigned by the integration (or hub) submitting the order — in almost all cases the same value the customer sees in the e-shop (deliveryId).

OrderImportInput.paymentMethod ● String scalar​

The payment method name, stored as submitted.

OrderImportInput.shippings ● [OrderImportShippingInput!]! non-null input​

The shipping destinations. At least one shipping is required.

OrderImportInput.totalGrossAmount ● Float! non-null scalar​

The order gross total (net plus VAT). Recomputed from the line prices during acquisition: send a value consistent with the lines.

OrderImportInput.totalNetAmount ● Float! non-null scalar​

The order net total. Recomputed from the line prices during acquisition: send a value consistent with the lines.

OrderImportInput.totalPaidAmount ● Float! non-null scalar​

The total amount paid by the customer. Stored exactly as provided, never recomputed.

OrderImportInput.totalVatAmount ● Float! non-null scalar​

The order VAT total. Recomputed from the line prices during acquisition: send a value consistent with the lines.

Member Of​

orderImport mutation