OrderInput

(INPUT_OBJECT)

set of data needed to create a new order

link GraphQL Schema definition

  • input OrderInput {
  • # external order number. Used for matching records
  • ext_order_id: String
  • # customer data
  • customer: CustomerInput!
  • # invoice address
  • invoice_address: AddressDataInput!
  • # delivery address
  • delivery_address: AddressDataInput
  • # datetime when the order has been created in source environment
  • # This does not impact the internal 'pur_date' (creation timestamp), but
  • # is recorded to order's history for reference
  • external_pur_date: DateTime
  • # list of ordered items
  • items: [OrderItemInput!]!
  • # delivery, payment and other order elements
  • price_elements: [OrderPriceElementInput]
  • # initial order status - internal Id
  • status: Int!
  • note: String
  • # order source e.g. market place identificator - defaults to 'api'
  • source: String
  • # array of taxation inputs (base, rate, tax amount)
  • vat_summary: [TaxationInput]
  • # language version iinternal Id
  • lang_id: Int!
  • # currency internal Id (not currency code)
  • currency_id: Int!
  • # final price of order - subject to verification
  • # If omitted, it is calculated based on 'vat_summary' taxation and/or
  • # sum of ordered items and price elements.
  • # Inconsistencies may result into failed validation (reporting errors and not
  • # accepting the input).
  • sum: PriceInput
  • # additional information for shipping e.g. pickup point branch ID
  • shipments: [ShipmentInfoInput!]
  • # order in One Stop Shop (OSS) mode - defaults to FALSE
  • oss: Boolean
  • # code for country in OSS - defaults to NULL
  • oss_country: CountryCodeAlpha2
  • # order tax excluded - defaults to FALSE
  • tax_excl: Boolean
  • # reason for tax exemption
  • # You may use one of predefined constants
  • #
    • eu-deal - intracommunitary delivery of goods
    • #
    • export - export of goods outside of EU
    • #
    • eu-service - intracommunitary provision of service
    • #
    • export-service - provision of service outside of EU
    • #
  • # By using one of these constants the tax exemption reason will be replaced with
  • # system's default tax sentence
  • # translated to language of order's target language version.
  • # Also, you may provide any other custom text. This text will be used in invoice.
  • tax_excl_reason: String
  • # unique entity identificator - @see SubmissionID
  • order_submission_id: SubmissionID!
  • }