Order Management API

The Order Management API enables developers to build apps and integrations for managing your DecoNetwork orders.

The Order Management API service provides the following functionality:

• Search for orders in your DecoNetwork site based on specified criteria
• Update the production status of an order or a line item within an order
• Download order proofs. The Order Proof template is available in the API via the Order Proof download URL (order_proof_pdf_url).

The Order Management API app not only gives you access to the API. It also demonstrates the supported functionality through an API console to make it easier for developers to learn how to use the Order Management API. The console provides a GUI that enables a developer to interact with the API to see the response with live API calls. Using this API console, a developer can:

• See what information is required and what parameters are needed in their API queries
• Test queries and view results in the browser

Prerequisites

• You must be on the Enterprise plan to use this feature
  (some grandfathered legacy plans from 2014 and earlier may also have access)
• You must have the Order Management API app enabled
• You must have administrator access to enable and connect to the API
• You must have programming experience

In this article, you will learn how...

• To enable the Order Management API app in DecoNetwork
• To search for orders using the Order Management API console
• To update the status of an order or order line item

To enable the Order Management API app in DecoNetwork:

1. Log into your DecoNetwork website.
2. Browse to Admin and select the yellow + Apps Store button at the bottom of the Main Menu.
3. Scroll to the Order Configuration section.
4. Click Add now on the Data Management API app.

To search for orders using the Order Management API console:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Order Management Api.
3. Set your search criteria and enter your credentials.
   
   • Field: Specify the field you want to search by. Options are:
     • Date Ordered: the date the order was placed.
     • Date Production Files Ready: the date the production files were ready to download.
     • Order Number: the unique number of the order.
     • Order Status: the status of the order, i.e. Ready for Production, Ready for Shipping, Shipped.
     • Date Due: the date the order was due to be completed.
     • Date Invoiced: the date an invoice was created for the order.
     • Date Shipped: the date the order was marked as shipped.
     • Date Modified: the date the order was last modified.
   • Condition: the condition to filter the results by. Options are:
     • ==: equal to
     • !=: not equal to
     • <: less than
     • >: greater than
     • <=: less than or equal to
     • >=: greater than or equal to
     • Between: between the values of
   • Date 1: the date to filter results by. Used if the Field option selected is a date.
   • Date 2: the end date to filter results by. Used if the Field option selected is a date and the Condition selected is "Between".
   • String: the invoice number to filter results by. Used when the Field option selected is "Order Number"
   • Limit: limit the number of search results returned. The maximum limit is 100.
   • Offset: used to paginate results. (For example, if you want to retrieve records 50 through to 75, you would set Limit to 25 and set Offset to 50).
   • Sort By: the field to sort the search results by. Options are:
     • Date Ordered: the date the order was placed.
     • Date Production Files Ready: the date the production files were ready to download.
     • Order Number: the unique number of the order.
     • Order Status: the status of the order, i.e. Ready for Production, Ready for Shipping, Shipped.
     • Date Due: the date the order was due to be completed.
     • Date Invoiced: the date an invoice was created for the order.
     • Date Shipped: the date the order was marked as shipped.
     • Date Modified: the date the order was last modified.
   • Include WorkFlow information: tick this checkbox to include workflow information used to track items going through the production workflow in the search results.
   • Include Purchase Order Information: tick this checkbox to include purchase order information associated with the workflow information in the search results.
   • Include Shipments: tick this checkbox to include shipment information in the search results.
   • Include Production File Info: tick this checkbox to include production file information (i.e. format, offsets/cropping of the production file) in the search results.
   • Skip Login Token (on download links): tick this checkbox if you don't want to add the user login token to the download document URL. The user's password will be added instead.
   • Username: the username of the account to use when connecting to the API.
   • Password: the password of the account to use when connecting to the API.
4. Click Search.

   The search results will be returned in the Output container below the Search button.

   Some of the key data elements that will be retrieved for orders include:

   • Customer information, such as customer ID, user ID, email address
   • Billing and shipping addresses, including postcodes, phone numbers, company
   • Payment and shipping methods
   • Payment credits used, such as gift certificates, coupon codes, and store credits. Coupon code names, codes, and amounts are included in the results, as are gift certificate codes and amounts.
   • Store information, such as store ID, name, and domain
   • Assignee information, such as ID, login username, first and last name
   • Creator information such as ID, login username, first and last name
   • Order information such as order ID, status, order date, due date, shipping date
   • Tax information such as name and amount
   • Line item product information, such as ID, name, code, color, weight, and quantity
   • Product views and decoration areas
   • Decoration processes and production file URLs
   • Order source, identifying if an order is an Internet or a Business Hub order
   • Pricing information, including product costs, blank product price, decoration price, and transaction ID. The blank product price and decoration price are output for each line item. The product cost corresponds to the supplier's cost specified under Admin > Products > Edit Product > Supplier & Purchasing. These data points will allow you to gain deeper insights into order and customer profitability and identify payments that span across multiple orders.

   If teamnames are in use in an order, the API will output the following:

   • a teamnames element with information about the sizes and fields, i.e.

     teamnames: { 
       { 
         size: "M", 
         fields: [ 
           {
             text: "White Tiger",
             location: "Back-Back"
           }
         ]
       }
     }

   • a mapping CSV in the production zip file that maps the production files to the size/names.

     The size code is included in the production filename

To update the status of an order or order line item:

1. Log into your DecoNetwork website.
2. Browse to Admin > Reports > Order Management Api.
3. Specify the order/line item ID numbers and configure the update settings.
   
   • Order Id: the invoice number of the order.
   • Order Line Id: the line item number of the line item status to be updated. If not specified, the status of the whole order will be updated.
   • Workflow Item Id: the item number of the workflow item to be updated. If not specified, all workflow items for the order line will be modified.
   • Qty: the quantity of a workflow item that will be produced/shipped. If specified, the workflow item ID must be specified.
   • New Status: the status to change the order/line item to. Options are:
     • Produced
     • Shipped
   • Contact Customer: tick this checkbox if you want an email to be sent to the customer informing them of the status change.
   • Shipping Tracking: the Shipping Tracking Number to assign if marking as shipped.
   • Operator Id: the Id number of the operator making the change. If not specified, the operator with the username/password sent will be used.
   • Operator Login: the login username of the operator making the change. Can be used if the ID of the operator is unknown.
   • Username: the username of the account to use when connecting to the API.
   • Password: the password of the account to use when connecting to the API.
4. Click Update.