Order Management API

The Order Management API enables developers to build apps and integrations that search, analyze, and update orders in your DecoNetwork site. The Order Management API app not only gives you access to the underlying API, it also includes an API console that demonstrates supported functionality with live calls. This article explains what the API can do, how to enable the app, and how to use the API console to test queries, retrieve order data, and update order statuses. It also explains the 100-record limit per request and how to retrieve more than 100 orders using the Offset parameter.

Prerequisites

Why use the Order Management API

The Order Management API app is designed for developers and advanced users who want more control over how order data is accessed and updated. It does two important things:

• Provides API access so you can integrate DecoNetwork orders with external systems.
• Demonstrates supported functionality via an API console, making it easier to learn how to use the Order Management API in your own code.

The API console gives you a graphical user interface (GUI) that interacts with the live Order Management API and shows real responses. Using this console, a developer can:

• See what information is required and which parameters are needed in their API queries.
• Test queries and view results in the browser before writing any code.

Beyond the console, the Order Management API itself lets you:

• Search orders by criteria such as dates, order status, or order number to power custom dashboards, reports, or exports.
• Update production status of orders or specific line items to sync status changes with external systems.
• Download order proofs via the order_proof_pdf_url, making it easy to share proofs or archive them externally.
• Retrieve rich order details including customer, shipping, tax, line item, workflow, production file, and pricing information for deeper analysis.

Step 1: Enable the Order Management API app

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.

Step 2: Open the Order Management API console

Use the Order Management API console in Admin to test order searches and see live API responses.

1. Log into your DecoNetwork website.

2. Go to Admin → Reports → Order Management API.

   On the console page, you will see a panel of search options and credentials.

   

   Order Management API console with search parameters

Step 3: Configure your order search

In the console, configure search criteria and credentials, then run a search to see the JSON result returned by the API.

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 include:
     • 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, (e.g. Ready for Production, Ready for Shipping, Shipped).
     • Date Due: the date the order is 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: how the selected field should be compared. Options include:
     • ==: equal to
     • !=: not equal to
     • <: less than
     • >: greater than
     • <=: less than or equal to
     • >=: greater than or equal to
     • Between: between two values
   • Date 1: the main date used to filter results. Used when Field is a date-type field.
   • Date 2: the end date used to filter results. Used when Field is a date-type field and the Condition selected is "Between".
   • String: A free-text value used when searching by Order Number.
   • Limit: limit the number of search results returned.
     • The maximum limit is 100 records per request.
     • If you need more than 100 orders, you must use the Offset parameter to paginate (explained in the next section).

   • Offset: used to paginate results. Skips a number of records before starting to return results.

     For example, if you want to retrieve records 50 through to 75, set Limit to 25 and Offset to 50.

   • Sort By: the field to sort the search results by. Options mirror many of the search fields:
     • Date Ordered
     • Date Production Files Ready
     • Order Number
     • Order Status
     • Date Due
     • Date Invoiced
     • Date Shipped
     • Date 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 to run the query.

5. Review the JSON response 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, order type, order status, payment status, on-hold reason, order date, due date, shipping date

     Payment status, on-hold reason, and order type are new data elements introduced in V8.610.
   • 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 entries for each size and its fields, for example:

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

   • A mapping CSV file in the production ZIP file that maps the production files to size/name combinations.

     The size code is included in the production filename

How Limit and Offset work together

• Limit controls how many records to return, up to 100.
• Offset controls where to start in the result set (how many records to skip).

Examples:

• Offset 0 with Limit 100 returns orders 1–100.
• Offset 100 with Limit 100 returns orders 101–200.

To retrieve more than 100 orders in your own code, you would typically:

1. Start with Limit = 100 and Offset = 0 to get the first page (orders 1–100).
2. Increase Offset by 100 for each subsequent request (e.g. 100, 200, 300, …) until no more results are returned.
3. Aggregate the results from each request in your own script, database, or reporting tool.

Step 5: Update order or line-item status

1. Log into your DecoNetwork website.
2. Browse to Admin → Reports → Order Management API.
3. Scroll to the Update Order Status section of the console.

4. Specify the order/line item ID numbers and configure the update settings.

   

   Update Order Status panel in the Order Management API console.

   • Order Id: the invoice number of the order whose status you want to change.
   • Order Line Id: the line item number within the order. If left blank, the status of the entire order will be updated.
   • Workflow Item Id: the item number of the workflow item to be updated. If left blank, all workflow items for the line item will be updated.
   • Qty: the quantity of the workflow item to mark as produced/shipped. If specified, the workflow item ID must be specified.
   • New Status: the status to change the order/line item to. Options include:
     • Produced
     • Shipped
   • Contact Customer: tick this checkbox if you want an email to be sent to the customer notifying them of the status change.
   • Shipping Tracking: the Shipping Tracking Number to assign when marking the order as shipped.
   • Operator Id: the Id number of the operator making the change. If left blank, the operator associated with the supplied credentials 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.
5. Click Update to send the status change to the API.

Troubleshooting

• “I only ever see 100 orders, even though I know there are more.”
  • Check the Limit value. The maximum per request is 100 records.
  • Use the Offset parameter to retrieve the next pages of results (e.g. offset 0, 100, 200, and so on).
• “My update query didn’t change the order status.”
  • Confirm that the Order Id, Order Line Id, and Workflow Item Id values are correct.
  • Check that your Username and Password have sufficient permissions.
  • Verify that you chose a valid New Status (Produced or Shipped).
• “The response is missing fields I expected.”
  • Make sure you have enabled options like Include Workflow Information, Include Purchase Order Information, Include Shipments, or Include Production File Info for the data you need.

FAQs

Can I retrieve more than 100 records in a single request?

No. The Order Management API is limited to 100 records per request. To work with more records, you must paginate using the Offset parameter (for example, Offset 0 for orders 1–100, Offset 100 for orders 101–200, etc.).

Can I search for orders based on customer email?

No. At this time there is no direct parameter to search orders by customer email address. You would typically:

• Search orders using supported fields (e.g. date ranges), and
• Filter the results by customer email in your own reporting or integration logic, if needed.

Do I have to use the Admin console to access the API?

No. The console is a convenience tool for learning and testing the API. Once you know which parameters you need, you can call the API directly from your own scripts, applications, or integration platforms using the same fields (including Limit and Offset).

Additional resources

• Order Management API Reference — full schema and technical details for developers.
• Purchase Order Management API
• Product Management API
• Inventory Management API