Order status definition

link GraphQL Schema definition

  • type OrderStatus implements IStatus {
  • # Internal status ID
  • id: ID!
  • # Status name
  • name: String!
  • # RGB color in hexa notation (e.g. #A45594)
  • color: Color
  • # text description of the meaning of the status
  • note: String
  • # change of order by customer is allowed for this status
  • order_change: Boolean!
  • # system preset to send notification email when setting this status
  • statusmail: Boolean!
  • # system preset to send notification SMS when setting this status
  • send_sms: Boolean!
  • # action in warehouse when setting this status
  • warehouse_action: WarehouseAction
  • }

link Require by

  • OrderOrder
  • 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).