Order
(OBJECT)
Order
link GraphQL Schema definition
- type Order {
- # system's internal ID
- : ID!
- # order's evidence number
- : String!
- # order's optional external reference
- # This might be a reference to order from marketplace etc.
- : String
- # date and time of receiving the order
- : DateTime!
- # variable symbol (payment reference)
- : Int
- # Source of the order (eshop, e-mail, phone etc.). It may contain also custom
- # values.
- : String
- # flag that the order is awaiting administrator's intervention or review
- # Further processing of this order should be avoided until manually reviewed by
- # staff.
- # This may happen because of number of various reasons
- #
- #
- # the order number could not be issued due to system misconfiguration,
- #
- #
- # the customer's VAT ID could not have been verified,
- #
- #
- # or other business conditions were met (usage of alternate VAT ID for
- # invoicing company, order in the OSS regime etc.)
- #
: Boolean! # customer's note for the order : String # internal note to order (not visible to customer) : String : Customer! # reference to person/account creating the order - @see OrderCreator for details : OrderCreator! # invoice address : AddressData! # delivery address if specified or pickup point's address if applicable : AddressData # shipment reports : [ShipmentInfo!] # ordered items (products) : [OrderItem]! # non-product elements and fees : [OrderPriceElement]! # total order price - may be net or incl. tax # . This object may contain net price for tax-exempted orders. @see # href="price.doc.html" class="doclink">Price for further reference. : Price! # current order status : OrderStatus # assigned sales representative : Person # set of preinvoices (payment requests) related to this order : [Preinvoice] # set of invoices (final documents) related to this order : [Invoice] # VAT summary - contains multiple taxation objects corresponding to specific tax # rates contained within the order : [Taxation!] # order language : LanguageVersion! # date of last change : DateTime! # this order is in One-Stop-Shop EU VAT regime : Boolean # country code for OSS regime # VAT taxed on this order follows rates and is dedicated to this EU country " : CountryCodeAlpha2 } link Require by
- InvoiceInvoice
- Mutationset of methods and entities to create and/or modify entities with this API.
- OrderListpageable list of orders (cursor)
- OrderPriceElementNon-product element in order (possibly affecting a price). Order price elements represent most often a shipping or payment fee, applied discount or used gift certificates.
- PreinvoicePreinvoice - payment request document - not a final invoice
- Query Querying retrieves data (read access). Batching of multiple queries is not supported with this API. To modify data or perform operations @see Mutation defintion. As of GraphQL nature, for each query you need to specify fields returned. To make this simpler you may use predefined fragments of data (default datasets) which honor the _<ObjectName> convention. You may combine predefined fragments with specific field enumeration in your queries. @see fragments.graphql You may need to distinguish between cursors i.e. pageable lists of items (SomeobjectList objects) returned and simple sets of items (array of objects). General rule is that lists are used for 'content generated by public' and are retrieved by getObjectList queries, simple sets are used for 'items created/managed by administrator' and retrieved by listObjects calls. Please note for cursors you may not request more than 30 items at once (i.e. page size is limited to max. 30 items).