Mutation

(OBJECT)
set of methods and entities to create and/or modify entities with this API.
GraphQL Schema definition

type Mutation {
#   creates a preinvoice (payment request) for an order 
# 
# Arguments
#   order_num: the order's reference number for which to create a 
#   preinvoice 
#   send_notification: allows customizing the default system 
#   behavior or sending multiple notifications. 
preinvoiceOrder(
order_num: String!,
send_notification: [NotificationRequest!]
): Preinvoice 
#   creates a final invoice for the specified preinvoice 
# 
# Arguments
#   preinvoice_num: the pre-invoice (payment request) reference 
#   number.r
#   send_notification: allows customizing the default system 
#   behavior or sending multiple notifications. 
finalizeInvoice(
preinvoice_num: String!,
send_notification: [NotificationRequest!]
): Invoice 
#   sets a new order status for an order 
# 
# Arguments
#   order_num: the order's reference number whose status should be 
#   changed.
#   status_id: the system's internal status ID 
#   send_notification: allows customizing the default system 
#   behavior or sending multiple notifications. 
changeOrderStatus(
order_num: String!,
status_id: Int!,
send_notification: [NotificationRequest!]
): Order 
#   updates the status or quantity of a warehouse item 
# 
# Arguments
#   warehouse_item: 
#   lang_id: required if multiple language versions exist in the 
#   system with currencies using the same ISO code.
#   send_notification: allows customizing the default system 
#   behavior or sending multiple notifications. 
updateWarehouseItem(
warehouse_item: WarehouseItemInput!,
lang_id: Int,
send_notification: [NotificationRequest!]
): WarehouseItem 
#   creates a new order 
# 
# Arguments
#   data: 
newOrder(data: OrderInput!): Order 
#   records a payment for an invoice or preinvoice and creates a receipt 
# 
# Arguments
#   payment_reference: the payment reference identifier 
#   reference_type: the reference type, e.g. preinvoice number, 
#   invoice number, or variable_symbol 
#   payment_type: the payment type identifier 
#   amount: the total amount of the payment 
#   pay_date: the date when the payment was made 
recordPayment(
payment_reference: String!,
reference_type: PaymentReferenceType!,
payment_type: PaymentType!,
amount: PriceInput!,
pay_date: Date!
): Receipt 
#   adds packaging information for a product 
# 
# Arguments
#   product_id: 
#   warehouse_number: 
#   package: 
addPackage(product_id: ID!, warehouse_number: ID, package: PackageInput): Package 
#   delete a product package 
# 
# Arguments
#   package_id: 
deletePackage(package_id: ID!): Boolean 
#   updates product package information 
# 
# Arguments
#   package_id: 
#   package: 
updatePackage(package_id: ID!, package: PackageInput): Package 
#   create a new post in 'News' block 
# 
# Arguments
#   block_id: 
#   post: 
addNewsPost(block_id: ID!, post: NewsPostInput): NewsPost 
#   deletes a post from 'News' block 
# 
# Arguments
#   post_id: 
deleteNewsPost(post_id: ID!): Boolean 
#   udpates post data in the 'News' block 
# 
# Arguments
#   post_id: 
#   post: 
updateNewsPost(post_id: ID!, post: NewsPostInput): NewsPost 
#   adds an external shipment link and tracking number to the order history. Note: 
#   Available only with a partner token 
# 
# Arguments
#   order_num: 
#   shipment_number: 
#   tracking_url: 
addTrackingUrlForOrder(
order_num: String!,
shipment_number: String!,
tracking_url: Url
): Boolean 
#   adds custom information to the order history. Note: Available only with a 
#   partner token 
# 
# Arguments
#   order_num: 
#   text: 
addCustomInfoForOrder(order_num: String!, text: String!): Boolean 
#   updates product data. Currently only title, short text and long text are 
#   supported. Note: Available only with a partner token. 
# 
# Arguments
#   product_id: 
#   lang_id: 
#   data: 
updateProduct(product_id: ID!, lang_id: ID!, data: ProductInput): Product 
#   created or udpates page content. The content will be added to the main content 
#   box. If the page already exists, the main content will be deleted and replaced 
#   with the new content from the 'blocks' parameter if specified. Note: Available 
#   only with a partner token.
# 
# Arguments
#   data: 
updateContent(data: WebPageContentInput!): ID 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
