Order Management

API Endpoint

The Order Management API is a simple API that allows you to search for orders or update the status of an order.

Orders

GET /api/json/manage_orders/find
RequestsFind orders ready for production since 1st February 2016
Body
field=2
condition=4
date1=2016-02-01T00:00:00
username=fred123
password=password123
Responses200
Headers
Content-Type: application/json
Body
{
  "response_status": {
    "code": 10001,
    "severity": "SUCCESS",
    "description": "."
  },
  "orders": [
    {
      "order_id": "INV1234",
      "item_amount": 22.5,
      "shipping_amount": 10.2,
      "tax_amount": 5.5,
      "tax_names": "Tax name",
      "taxes": [
        {
          "id": 6345,
          "name": "GST",
          "amount": 12.65
        }
      ],
      "discount_amount": 0,
      "coupon_discount_amount": 2.2,
      "gift_certificate_amount": 20.2,
      "credit_used": 5,
      "billable_amount": 12,
      "outstanding_balance": 12,
      "total_weight": 2.8,
      "quote_pdf_url": "https://abc.secure-decortion.com/manage/orders/download_quote/234234?",
      "production_pdf_url": "https://abc.secure-decortion.com/orders/print_freight/234234?",
      "job_name": "Internet Order",
      "customer_id": 2678321,
      "customer_po_number": "PO123",
      "order_status": 1,
      "date_started": "2016-02-01T00:00:00",
      "date_ordered": "2016-02-01T00:00:00",
      "date_production_files_ready": "2016-02-01T00:00:00",
      "date_produced": "2016-02-01T00:00:00",
      "date_shipped": "2016-02-01T00:00:00",
      "date_invoiced": "2016-02-01T00:00:00",
      "date_modified": "2016-02-01T00:00:00",
      "date_due": "2016-02-15T00:00:00",
      "rush_order_fee": "Rush Order Fee",
      "rush_order_fee_amount": 1.2,
      "account_terms": "C.O.D.",
      "shipping_method": {
        "id": 34857623,
        "name": "Overnight"
      },
      "shipments": [
        {
          "id": 45334,
          "date": "2016-02-01T00:00:00",
          "tracking_number": "TRK5363",
          "shipping_method": {
            "id": 34857623,
            "name": "Overnight"
          },
          "packages": [
            {
              "id": 6345,
              "weight": 224,
              "length": 10,
              "width": 3,
              "height": 0.6
            }
          ],
          "workflow_items": [
            {
              "workflow_item_id": 5463456,
              "qty": 224
            }
          ]
        }
      ],
      "billing_details": {
        "user_id": 2143423,
        "email": "fred@acme.co",
        "firstname": "Fred",
        "lastname": "Smith",
        "country_code": "US",
        "state": "California",
        "city": "Huntington Beach",
        "street": "219 Cimmaron Road",
        "postcode": "92647",
        "company": "Acme Co",
        "salutation": "Mr",
        "ph_number": "714",
        "custom_fields": [
          {
            "caption": "Student Name",
            "value": "Fred"
          }
        ]
      },
      "shipping_details": {
        "firstname": "Fred",
        "lastname": "Smith",
        "country_code": "US",
        "state": "California",
        "city": "Huntington Beach",
        "street": "219 Cimmaron Road",
        "postcode": "92647",
        "company": "Acme Co",
        "salutation": "Mr",
        "ph_number": "714",
        "custom_fields": [
          {
            "caption": "Student Name",
            "value": "Fred"
          }
        ]
      },
      "payment_details": {
        "payment_type_id": 0,
        "payment_type_name": "Credit Card",
        "card_number": "*********1234"
      },
      "payments": [
        {
          "id": 24586623,
          "date_paid": "2016-02-03T00:00:00",
          "payment_method": "Credit Card",
          "billable_amount": 22.5,
          "refunded_amount": 0,
          "paid_amount": 22.5
        }
      ],
      "order_lines": [
        {
          "id": 345554635463,
          "product_id": 2353534534,
          "product_code": "G2000",
          "product_name": "Gilden 2000",
          "decorated_product_name": "Racing Special Shirt",
          "product_color": {
            "id": 35345,
            "name": "White",
            "colors": [
              {
                "id": 35345,
                "type": "rgb",
                "r": 255,
                "g": 255,
                "b": 255,
                "c": 100,
                "m": 100,
                "y": 100,
                "k": 100,
                "name": "cyan"
              }
            ]
          },
          "sku": "ACC234523",
          "fields": [
            {
              "field_id": 35345,
              "field_name": "Size",
              "field_type": 0,
              "options": [
                {
                  "option_id": 35345,
                  "qty": 2,
                  "name": "Large",
                  "code": "L",
                  "sku": "AAA234234",
                  "dn_sku_id": "123423513",
                  "vendor_sku": "AAA234234",
                  "sub_options": [
                    {
                      "sub_option_id": 35345,
                      "qty": 2,
                      "name": "Long",
                      "code": "L",
                      "sku": "AAA234234",
                      "dn_sku_id": "123234",
                      "vendor_sku": "AAA234234"
                    }
                  ]
                }
              ],
              "string_value": "ABC",
              "date_value": "2016-02-01T00:00:00",
              "file_value_url": "/configured_product_field/s/213/2323/123/file.pdf"
            }
          ],
          "views": [
            {
              "view_id": 35345,
              "view_name": "Front",
              "thumbnail": "/configured_product_views/s/image/234/453/546/large_thumb.png",
              "areas": [
                {
                  "area_id": 35345,
                  "area_name": "Body",
                  "processes": [
                    {
                      "process": "DTG",
                      "production_file_url": "https://abc.secure-decoration.com/orders/get_design/1232132",
                      "edit_file_url": "https://abc.secure-decoration.com/orders/get_edit_file/1232132"
                    }
                  ],
                  "proof_url: `https://abc.secure-decoration.com/orders/get_area_proof/12321`": "Hello, world!"
                }
              ],
              "production_files_ready": true
            }
          ],
          "qty": 5,
          "total_price": 150.5,
          "unit_price": 30.1,
          "discount": 0,
          "tax": 10.5,
          "tax_names": "Tax name",
          "store_commission": 3,
          "parent_store_commission": 0.2,
          "commission_transaction_fee": 0.6,
          "production_status": 2,
          "processed_date": "2016-02-01T00:00:00",
          "processed_by": {
            "id": 35345,
            "login": "Bob123",
            "firstname": "Bob",
            "lastname": "Smith"
          },
          "production_assigned_to": {
            "id": 35345,
            "login": "Bob123",
            "firstname": "Bob",
            "lastname": "Smith"
          },
          "shipped_date": "2016-02-01T00:00:00",
          "shipped_by": {
            "id": 35345,
            "login": "Bob123",
            "firstname": "Bob",
            "lastname": "Smith"
          },
          "length": 6,
          "width": 5,
          "height": 1.25,
          "unit_weight": 0.56,
          "workflow_items": [
            {
              "id": 5463456,
              "option_id": 35345,
              "sub_option_id": 35345,
              "vendor_sku": "AAA234234",
              "dn_sku_id": "123234",
              "qty_to_fulfill": 3,
              "qty_required": 4,
              "qty_allocated": 4,
              "qty_on_order": 4,
              "qty_produced": 4,
              "qty_wasted": 1,
              "qty_shipped": 3,
              "qty_skip_po": 0,
              "qty_skip_inv": 0,
              "procurement_status": 60,
              "production_status": 80,
              "shipping_status": 80,
              "purchase_order_lines": [
                {
                  "po_line_id": 9633543,
                  "po_number PO": "Hello, world!",
                  "qty_ordered": 2,
                  "qty_received": 1
                }
              ]
            }
          ]
        }
      ],
      "notes": [
        {
          "note_type": "to customer",
          "content": "Please hurry",
          "created_at": "2016-02-01T00:00:00",
          "from": {
            "user_id": 2143423,
            "email": "fred@acme.co",
            "firstname": "Fred",
            "lastname": "Smith",
            "country_code": "US",
            "state": "California",
            "city": "Huntington Beach",
            "street": "219 Cimmaron Road",
            "postcode": "92647",
            "company": "Acme Co",
            "salutation": "Mr",
            "ph_number": "714",
            "custom_fields": [
              {
                "caption": "Student Name",
                "value": "Fred"
              }
            ]
          }
        }
      ],
      "assigned_to": {
        "id": 35345,
        "login": "Bob123",
        "firstname": "Bob",
        "lastname": "Smith"
      },
      "is_priority": false,
      "store": {
        "id": 11424233,
        "name": "Bobs Store",
        "domain": "www.bobs.com",
        "owner": {
          "user_id": 2143423,
          "email": "fred@acme.co",
          "firstname": "Fred",
          "lastname": "Smith",
          "country_code": "US",
          "state": "California",
          "city": "Huntington Beach",
          "street": "219 Cimmaron Road",
          "postcode": "92647",
          "company": "Acme Co",
          "salutation": "Mr",
          "ph_number": "714",
          "custom_fields": [
            {
              "caption": "Student Name",
              "value": "Fred"
            }
          ]
        }
      }
    }
  ],
  "total": 1
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "response_status": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "the status code."
        },
        "severity": {
          "type": "string",
          "description": "either SUCCESS or ERROR"
        },
        "description": {
          "type": "string",
          "description": "A description of the error. Blank when SUCCESS."
        }
      },
      "required": [
        "code"
      ]
    },
    "orders": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "order_id": {
            "type": "string",
            "enum": [
              "INV1234"
            ],
            "description": "The invoice Id."
          },
          "item_amount": {
            "type": "number",
            "enum": [
              22.5
            ],
            "description": "The total of the line items."
          },
          "shipping_amount": {
            "type": "number",
            "enum": [
              10.2
            ],
            "description": "The total of the shipping."
          },
          "tax_amount": {
            "type": "number",
            "enum": [
              5.5
            ],
            "description": "The total of the tax."
          },
          "tax_names": {
            "type": "string",
            "enum": [
              "Tax name"
            ],
            "description": "The names of the taxes applied to the order."
          },
          "taxes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    6345
                  ],
                  "description": "The id of the tax."
                },
                "name": {
                  "type": "string",
                  "enum": [
                    "GST"
                  ],
                  "description": "The name of the tax."
                },
                "amount": {
                  "type": "number",
                  "enum": [
                    12.65
                  ],
                  "description": "The amount of tax charged."
                }
              },
              "required": [
                "id",
                "name",
                "amount"
              ],
              "additionalProperties": false
            },
            "description": "List of taxes for this order with the amounts."
          },
          "discount_amount": {
            "type": "number",
            "enum": [
              0
            ],
            "description": "The total discount given directly against the order."
          },
          "coupon_discount_amount": {
            "type": "number",
            "enum": [
              2.2
            ],
            "description": "The discount a coupon has given to the order."
          },
          "gift_certificate_amount": {
            "type": "number",
            "enum": [
              20.2
            ],
            "description": "The amount paid by a gift certificate."
          },
          "credit_used": {
            "type": "number",
            "enum": [
              5
            ],
            "description": "The amount paid by users credit."
          },
          "billable_amount": {
            "type": "number",
            "enum": [
              12
            ],
            "description": "The amount billable to the user after discounts, coupons and gift certificates."
          },
          "outstanding_balance": {
            "type": "number",
            "enum": [
              12
            ],
            "description": "The unpaid amount of the order."
          },
          "total_weight": {
            "type": "number",
            "enum": [
              2.8
            ],
            "description": "The total weight of the order."
          },
          "quote_pdf_url": {
            "type": "string",
            "enum": [
              "https://abc.secure-decortion.com/manage/orders/download_quote/234234?"
            ],
            "description": "A URL to download the quote/invoice pdf."
          },
          "production_pdf_url": {
            "type": "string",
            "enum": [
              "https://abc.secure-decortion.com/orders/print_freight/234234?"
            ],
            "description": "A URL to download the production file pdf."
          },
          "job_name": {
            "type": "string",
            "enum": [
              "Internet Order"
            ],
            "description": "An optional name for the order."
          },
          "customer_id": {
            "type": "number",
            "enum": [
              2678321
            ],
            "description": "Id of customer."
          },
          "customer_po_number": {
            "type": "string",
            "enum": [
              "PO123"
            ],
            "description": "An optional customer PO number for the order."
          },
          "order_status": {
            "type": "number",
            "enum": [
              1
            ],
            "description": "The order status 1: ready for production, 2: ready for shipping, 3: shipped."
          },
          "date_started": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order was started."
          },
          "date_ordered": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order was ordered."
          },
          "date_production_files_ready": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order production files were ready for download."
          },
          "date_produced": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order was marked as produced."
          },
          "date_shipped": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order was marked as shipped."
          },
          "date_invoiced": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order was marked as invoiced."
          },
          "date_modified": {
            "type": "string",
            "enum": [
              "2016-02-01T00:00:00"
            ],
            "description": "The date (ISO-8601 date format) the order was last modified."
          },
          "date_due": {
            "type": "string",
            "enum": [
              "2016-02-15T00:00:00"
            ],
            "description": "The due date (ISO-8601 date format) for the order."
          },
          "rush_order_fee": {
            "type": "string",
            "enum": [
              "Rush Order Fee"
            ],
            "description": "The rush order fee name applied against the order."
          },
          "rush_order_fee_amount": {
            "type": "number",
            "enum": [
              1.2
            ],
            "description": "The rush order fee amount applied against the order."
          },
          "account_terms": {
            "type": "string",
            "enum": [
              "C.O.D."
            ],
            "description": "The terms and conditions applied against the order."
          },
          "shipping_method": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "enum": [
                  34857623
                ],
                "description": "Id of shipping method"
              },
              "name": {
                "type": "string",
                "enum": [
                  "Overnight"
                ],
                "description": "Name of shipping method"
              }
            },
            "required": [
              "id",
              "name"
            ],
            "additionalProperties": false,
            "description": "The shipping method chosen."
          },
          "shipments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    45334
                  ],
                  "description": "The id of the shipment."
                },
                "date": {
                  "type": "string",
                  "enum": [
                    "2016-02-01T00:00:00"
                  ],
                  "description": "The date (ISO-8601 date format) the order was shipment was sent."
                },
                "tracking_number": {
                  "type": "string",
                  "enum": [
                    "TRK5363"
                  ],
                  "description": "The tracking number of the shipment."
                },
                "shipping_method": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number",
                      "enum": [
                        34857623
                      ],
                      "description": "Id of shipping method"
                    },
                    "name": {
                      "type": "string",
                      "enum": [
                        "Overnight"
                      ],
                      "description": "Name of shipping method"
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false,
                  "description": "The shipping method chosen."
                },
                "packages": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          6345
                        ],
                        "description": "The id of the ShipmentPackage."
                      },
                      "weight": {
                        "type": "number",
                        "enum": [
                          224
                        ],
                        "description": "The weight of the package."
                      },
                      "length": {
                        "type": "number",
                        "enum": [
                          10
                        ],
                        "description": "The length of the package."
                      },
                      "width": {
                        "type": "number",
                        "enum": [
                          3
                        ],
                        "description": "The width of the package."
                      },
                      "height": {
                        "type": "number",
                        "enum": [
                          0.6
                        ],
                        "description": "The height of the package."
                      }
                    },
                    "required": [
                      "id",
                      "weight",
                      "length",
                      "width",
                      "height"
                    ],
                    "additionalProperties": false
                  },
                  "description": "The packages sent in this shipment"
                },
                "workflow_items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "workflow_item_id": {
                        "type": "number",
                        "enum": [
                          5463456
                        ],
                        "description": "The id of the workflow item."
                      },
                      "qty": {
                        "type": "number",
                        "enum": [
                          224
                        ],
                        "description": "The qty shipped."
                      }
                    },
                    "required": [
                      "workflow_item_id",
                      "qty"
                    ],
                    "additionalProperties": false
                  },
                  "description": "The workflow items included in the package if include workflow data parameter is set to 1."
                }
              },
              "required": [
                "id",
                "shipping_method",
                "packages",
                "workflow_items"
              ],
              "additionalProperties": false
            },
            "description": "An array of shipments if include shipments parameter is '1'."
          },
          "billing_details": {
            "type": "object",
            "properties": {
              "user_id": {
                "type": "number",
                "enum": [
                  2143423
                ],
                "description": "Id of user"
              },
              "email": {
                "type": "string",
                "enum": [
                  "fred@acme.co"
                ],
                "description": "Email address of user"
              },
              "firstname": {
                "type": "string",
                "enum": [
                  "Fred"
                ],
                "description": "First name of user"
              },
              "lastname": {
                "type": "string",
                "enum": [
                  "Smith"
                ],
                "description": "Last name of user"
              },
              "country_code": {
                "type": "string",
                "enum": [
                  "US"
                ],
                "description": "2 letter country code"
              },
              "state": {
                "type": "string",
                "enum": [
                  "California"
                ],
                "description": "Name of state"
              },
              "city": {
                "type": "string",
                "enum": [
                  "Huntington Beach"
                ],
                "description": "Name of city"
              },
              "street": {
                "type": "string",
                "enum": [
                  "219 Cimmaron Road"
                ],
                "description": "Name of street"
              },
              "postcode": {
                "type": "string",
                "enum": [
                  "92647"
                ],
                "description": "zip/post code"
              },
              "company": {
                "type": "string",
                "enum": [
                  "Acme Co"
                ],
                "description": "company name"
              },
              "salutation": {
                "type": "string",
                "enum": [
                  "Mr"
                ]
              },
              "ph_number": {
                "type": "string",
                "enum": [
                  "714"
                ],
                "description": "596-6776 (string, optional) - Phone number"
              },
              "custom_fields": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "caption": {
                      "type": "string",
                      "enum": [
                        "Student Name"
                      ],
                      "description": "The caption of the field"
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "Fred"
                      ],
                      "description": "The value of the field"
                    }
                  },
                  "required": [
                    "caption"
                  ],
                  "additionalProperties": false
                },
                "description": "An array of custom fields"
              }
            },
            "required": [
              "user_id",
              "ph_number"
            ],
            "additionalProperties": false,
            "description": "The billing details."
          },
          "shipping_details": {
            "type": "object",
            "properties": {
              "firstname": {
                "type": "string",
                "enum": [
                  "Fred"
                ],
                "description": "First name of user"
              },
              "lastname": {
                "type": "string",
                "enum": [
                  "Smith"
                ],
                "description": "Last name of user"
              },
              "country_code": {
                "type": "string",
                "enum": [
                  "US"
                ],
                "description": "2 letter country code"
              },
              "state": {
                "type": "string",
                "enum": [
                  "California"
                ],
                "description": "Name of state"
              },
              "city": {
                "type": "string",
                "enum": [
                  "Huntington Beach"
                ],
                "description": "Name of city"
              },
              "street": {
                "type": "string",
                "enum": [
                  "219 Cimmaron Road"
                ],
                "description": "Name of street"
              },
              "postcode": {
                "type": "string",
                "enum": [
                  "92647"
                ],
                "description": "zip/post code"
              },
              "company": {
                "type": "string",
                "enum": [
                  "Acme Co"
                ],
                "description": "company name"
              },
              "salutation": {
                "type": "string",
                "enum": [
                  "Mr"
                ]
              },
              "ph_number": {
                "type": "string",
                "enum": [
                  "714"
                ],
                "description": "596-6776 (string, optional) - Phone number"
              },
              "custom_fields": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "caption": {
                      "type": "string",
                      "enum": [
                        "Student Name"
                      ],
                      "description": "The caption of the field"
                    },
                    "value": {
                      "type": "string",
                      "enum": [
                        "Fred"
                      ],
                      "description": "The value of the field"
                    }
                  },
                  "required": [
                    "caption"
                  ],
                  "additionalProperties": false
                },
                "description": "An array of custom fields"
              }
            },
            "required": [
              "ph_number"
            ],
            "additionalProperties": false,
            "description": "This shipping details. If blank the billing details are used."
          },
          "payment_details": {
            "type": "object",
            "properties": {
              "payment_type_id": {
                "type": "number",
                "enum": [
                  0
                ],
                "description": "The id of the type of payment. 0: credit card, -1: Paypal Express, -2: COD, -3: Gift Certificate, -5: Account, -6: Credit, -8: System, >0: Manual Payment Method"
              },
              "payment_type_name": {
                "type": "string",
                "enum": [
                  "Credit Card"
                ],
                "description": "The name of the type of payment"
              },
              "card_number": {
                "type": "string",
                "enum": [
                  "*********1234"
                ],
                "description": "If credit card is used, the last 4 digits."
              }
            },
            "required": [
              "payment_type_id",
              "payment_type_name"
            ],
            "additionalProperties": false,
            "description": "Deprecated. Use the payments array instead."
          },
          "payments": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    24586623
                  ],
                  "description": "Payment Id"
                },
                "date_paid": {
                  "type": "string",
                  "enum": [
                    "2016-02-03T00:00:00"
                  ],
                  "description": "The date (ISO-8601 date format) the payment was paid."
                },
                "payment_method": {
                  "type": "string",
                  "enum": [
                    "Credit Card"
                  ],
                  "description": "The name of the payment method used."
                },
                "billable_amount": {
                  "type": "number",
                  "enum": [
                    22.5
                  ],
                  "description": "The amount billable."
                },
                "refunded_amount": {
                  "type": "number",
                  "enum": [
                    0
                  ],
                  "description": "The amount refunded."
                },
                "paid_amount": {
                  "type": "number",
                  "enum": [
                    22.5
                  ],
                  "description": "The amount paid."
                }
              },
              "required": [
                "id",
                "date_paid",
                "payment_method",
                "billable_amount",
                "refunded_amount",
                "paid_amount"
              ],
              "additionalProperties": false
            },
            "description": "An array of payments."
          },
          "order_lines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "number",
                  "enum": [
                    345554635463
                  ],
                  "description": "Order Line Id"
                },
                "product_id": {
                  "type": "number",
                  "enum": [
                    2353534534
                  ],
                  "description": "Id of the product"
                },
                "product_code": {
                  "type": "string",
                  "enum": [
                    "G2000"
                  ],
                  "description": "Product code of the product"
                },
                "product_name": {
                  "type": "string",
                  "enum": [
                    "Gilden 2000"
                  ],
                  "description": "Name of blank product"
                },
                "decorated_product_name": {
                  "type": "string",
                  "enum": [
                    "Racing Special Shirt"
                  ]
                },
                "product_color": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number",
                      "enum": [
                        35345
                      ],
                      "description": "The id of the product color"
                    },
                    "name": {
                      "type": "string",
                      "enum": [
                        "White"
                      ],
                      "description": "The name of the product Color"
                    },
                    "colors": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "id": {
                            "type": "number",
                            "enum": [
                              35345
                            ],
                            "description": "The id of the color"
                          },
                          "type": {
                            "type": "string",
                            "enum": [
                              "rgb"
                            ],
                            "description": "The type of color rgb/cmyk"
                          },
                          "r": {
                            "type": "number",
                            "enum": [
                              255
                            ]
                          },
                          "g": {
                            "type": "number",
                            "enum": [
                              255
                            ]
                          },
                          "b": {
                            "type": "number",
                            "enum": [
                              255
                            ]
                          },
                          "c": {
                            "type": "number",
                            "enum": [
                              100
                            ]
                          },
                          "m": {
                            "type": "number",
                            "enum": [
                              100
                            ]
                          },
                          "y": {
                            "type": "number",
                            "enum": [
                              100
                            ]
                          },
                          "k": {
                            "type": "number",
                            "enum": [
                              100
                            ]
                          },
                          "name": {
                            "type": "string",
                            "enum": [
                              "cyan"
                            ],
                            "description": "When a spot color"
                          }
                        },
                        "required": [
                          "id",
                          "type"
                        ],
                        "additionalProperties": false
                      },
                      "description": "The definition of the product colors"
                    }
                  },
                  "required": [
                    "id",
                    "name",
                    "colors"
                  ],
                  "additionalProperties": false,
                  "description": "The blank products's color"
                },
                "sku": {
                  "type": "string",
                  "enum": [
                    "ACC234523"
                  ],
                  "description": "The SKU code of the blank product ordered"
                },
                "fields": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "field_id": {
                        "type": "number",
                        "enum": [
                          35345
                        ],
                        "description": "The id of the field"
                      },
                      "field_name": {
                        "type": "string",
                        "enum": [
                          "Size"
                        ],
                        "description": "The name of the field"
                      },
                      "field_type": {
                        "type": "number",
                        "enum": [
                          0
                        ],
                        "description": "The type of field. 0: size, 2: dropdown list, 3: checkboxes, 4: radio buttons, 5: multi select list, 7: textbox, 8: text area, 9: file, 10: image, 11: date, 12: datetime, 13: time"
                      },
                      "options": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "option_id": {
                              "type": "number",
                              "enum": [
                                35345
                              ],
                              "description": "The id of the option"
                            },
                            "qty": {
                              "type": "number",
                              "enum": [
                                2
                              ],
                              "description": "The qty chosen when the field is a size and multiple sizes are chosen"
                            },
                            "name": {
                              "type": "string",
                              "enum": [
                                "Large"
                              ],
                              "description": "The option label"
                            },
                            "code": {
                              "type": "string",
                              "enum": [
                                "L"
                              ],
                              "description": "The option value"
                            },
                            "sku": {
                              "type": "string",
                              "enum": [
                                "AAA234234"
                              ],
                              "description": "The sku when the field is a size"
                            },
                            "dn_sku_id": {
                              "type": "string",
                              "enum": [
                                "123423513"
                              ],
                              "description": "The deconetwork id of the sku."
                            },
                            "vendor_sku": {
                              "type": "string",
                              "enum": [
                                "AAA234234"
                              ],
                              "description": "The vendor's sku when the field is a size"
                            },
                            "sub_options": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "sub_option_id": {
                                    "type": "number",
                                    "enum": [
                                      35345
                                    ],
                                    "description": "The id of the sub option"
                                  },
                                  "qty": {
                                    "type": "number",
                                    "enum": [
                                      2
                                    ],
                                    "description": "The qty chosen when the field is a size and multiple sizes are chosen"
                                  },
                                  "name": {
                                    "type": "string",
                                    "enum": [
                                      "Long"
                                    ],
                                    "description": "The option label"
                                  },
                                  "code": {
                                    "type": "string",
                                    "enum": [
                                      "L"
                                    ],
                                    "description": "The option value"
                                  },
                                  "sku": {
                                    "type": "string",
                                    "enum": [
                                      "AAA234234"
                                    ],
                                    "description": "The sku when the field is a size"
                                  },
                                  "dn_sku_id": {
                                    "type": "string",
                                    "enum": [
                                      "123234"
                                    ],
                                    "description": "423513 (string, optional) - The deconetwork id of the sku."
                                  },
                                  "vendor_sku": {
                                    "type": "string",
                                    "enum": [
                                      "AAA234234"
                                    ],
                                    "description": "The vendor's sku when the field is a size"
                                  }
                                },
                                "required": [
                                  "sub_option_id",
                                  "name",
                                  "code",
                                  "dn_sku_id"
                                ],
                                "additionalProperties": false
                              },
                              "description": "The chosen sub options if the field has sub options"
                            }
                          },
                          "required": [
                            "option_id",
                            "name",
                            "code",
                            "sub_options"
                          ],
                          "additionalProperties": false
                        },
                        "description": "An array of chosen options (sizes)"
                      },
                      "string_value": {
                        "type": "string",
                        "enum": [
                          "ABC"
                        ],
                        "description": "The entered string value when field type is 7 or 8."
                      },
                      "date_value": {
                        "type": "string",
                        "enum": [
                          "2016-02-01T00:00:00"
                        ],
                        "description": "The entered date (ISO-8601 date format) when field type is 11, 12 or 13."
                      },
                      "file_value_url": {
                        "type": "string",
                        "enum": [
                          "/configured_product_field/s/213/2323/123/file.pdf"
                        ],
                        "description": "A url to download the upload file when field type is 9 or 10"
                      }
                    },
                    "required": [
                      "field_id",
                      "field_name",
                      "field_type",
                      "options"
                    ],
                    "additionalProperties": false
                  },
                  "description": "An array of fields (including size)"
                },
                "views": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "view_id": {
                        "type": "number",
                        "enum": [
                          35345
                        ],
                        "description": "The id of the view"
                      },
                      "view_name": {
                        "type": "string",
                        "enum": [
                          "Front"
                        ],
                        "description": "The name of the view"
                      },
                      "thumbnail": {
                        "type": "string",
                        "enum": [
                          "/configured_product_views/s/image/234/453/546/large_thumb.png"
                        ],
                        "description": "A url to download the thumbnail of the view"
                      },
                      "areas": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "area_id": {
                              "type": "number",
                              "enum": [
                                35345
                              ],
                              "description": "The id of the area"
                            },
                            "area_name": {
                              "type": "string",
                              "enum": [
                                "Body"
                              ],
                              "description": "The name of the area"
                            },
                            "processes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "process": {
                                    "type": "string",
                                    "enum": [
                                      "DTG"
                                    ],
                                    "description": "The process"
                                  },
                                  "production_file_url": {
                                    "type": "string",
                                    "enum": [
                                      "https://abc.secure-decoration.com/orders/get_design/1232132"
                                    ],
                                    "description": "A url to download the production file"
                                  },
                                  "edit_file_url": {
                                    "type": "string",
                                    "enum": [
                                      "https://abc.secure-decoration.com/orders/get_edit_file/1232132"
                                    ],
                                    "description": "A url to download the editable file"
                                  }
                                },
                                "required": [
                                  "process"
                                ],
                                "additionalProperties": false
                              },
                              "description": "An array of processes used to decorate this view"
                            },
                            "proof_url: `https://abc.secure-decoration.com/orders/get_area_proof/12321`": {
                              "type": "string",
                              "enum": [
                                ""
                              ],
                              "description": "A url to download a proof of the area"
                            }
                          },
                          "required": [
                            "area_id",
                            "area_name",
                            "processes"
                          ],
                          "additionalProperties": false
                        },
                        "description": "An array of area object for decorated areas"
                      },
                      "production_files_ready": {
                        "type": "boolean",
                        "enum": [
                          true
                        ],
                        "description": "True if production files ready to download for this view"
                      }
                    },
                    "required": [
                      "view_id",
                      "view_name",
                      "areas",
                      "production_files_ready"
                    ],
                    "additionalProperties": false
                  },
                  "description": "An array of views decorated"
                },
                "qty": {
                  "type": "number",
                  "enum": [
                    5
                  ],
                  "description": "The number of products ordered for this line item"
                },
                "total_price": {
                  "type": "number",
                  "enum": [
                    150.5
                  ],
                  "description": "The total of the line item"
                },
                "unit_price": {
                  "type": "number",
                  "enum": [
                    30.1
                  ],
                  "description": "The unit price"
                },
                "discount": {
                  "type": "number",
                  "enum": [
                    0
                  ],
                  "description": "The discount (bulk or overrriden) applied to the line item"
                },
                "tax": {
                  "type": "number",
                  "enum": [
                    10.5
                  ],
                  "description": "The tax applied the the line item."
                },
                "tax_names": {
                  "type": "string",
                  "enum": [
                    "Tax name"
                  ],
                  "description": "The names of the taxes applied to the line item."
                },
                "store_commission": {
                  "type": "number",
                  "enum": [
                    3
                  ],
                  "description": "The store commission given for this line item."
                },
                "parent_store_commission": {
                  "type": "number",
                  "enum": [
                    0.2
                  ],
                  "description": "The store commission given to parent store(s) for this line item."
                },
                "commission_transaction_fee": {
                  "type": "number",
                  "enum": [
                    0.6
                  ],
                  "description": "The commission transaction fee applied."
                },
                "production_status": {
                  "type": "number",
                  "enum": [
                    2
                  ],
                  "description": "production status 1: ready for production, 2: ready for shipping, 3: shipped, 7: on hold, 8: awaiting purchase order, 9: awaiting stock, 10: awaiting artwork"
                },
                "processed_date": {
                  "type": "string",
                  "enum": [
                    "2016-02-01T00:00:00"
                  ],
                  "description": "The date (ISO-8601 date format) the order was marked as produced."
                },
                "processed_by": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number",
                      "enum": [
                        35345
                      ],
                      "description": "The user id of the operator"
                    },
                    "login": {
                      "type": "string",
                      "enum": [
                        "Bob123"
                      ],
                      "description": "The login of the operator"
                    },
                    "firstname": {
                      "type": "string",
                      "enum": [
                        "Bob"
                      ],
                      "description": "The first name of the operator"
                    },
                    "lastname": {
                      "type": "string",
                      "enum": [
                        "Smith"
                      ],
                      "description": "The last name of the operator"
                    }
                  },
                  "required": [
                    "id",
                    "login"
                  ],
                  "additionalProperties": false,
                  "description": "The operator who producted the order line"
                },
                "production_assigned_to": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number",
                      "enum": [
                        35345
                      ],
                      "description": "The user id of the operator"
                    },
                    "login": {
                      "type": "string",
                      "enum": [
                        "Bob123"
                      ],
                      "description": "The login of the operator"
                    },
                    "firstname": {
                      "type": "string",
                      "enum": [
                        "Bob"
                      ],
                      "description": "The first name of the operator"
                    },
                    "lastname": {
                      "type": "string",
                      "enum": [
                        "Smith"
                      ],
                      "description": "The last name of the operator"
                    }
                  },
                  "required": [
                    "id",
                    "login"
                  ],
                  "additionalProperties": false,
                  "description": "The operator assigned to the order line"
                },
                "shipped_date": {
                  "type": "string",
                  "enum": [
                    "2016-02-01T00:00:00"
                  ],
                  "description": "The date (ISO-8601 date format) the order was marked as shipped."
                },
                "shipped_by": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "number",
                      "enum": [
                        35345
                      ],
                      "description": "The user id of the operator"
                    },
                    "login": {
                      "type": "string",
                      "enum": [
                        "Bob123"
                      ],
                      "description": "The login of the operator"
                    },
                    "firstname": {
                      "type": "string",
                      "enum": [
                        "Bob"
                      ],
                      "description": "The first name of the operator"
                    },
                    "lastname": {
                      "type": "string",
                      "enum": [
                        "Smith"
                      ],
                      "description": "The last name of the operator"
                    }
                  },
                  "required": [
                    "id",
                    "login"
                  ],
                  "additionalProperties": false,
                  "description": "The operator who shipped the order line"
                },
                "length": {
                  "type": "number",
                  "enum": [
                    6
                  ],
                  "description": "The unit length."
                },
                "width": {
                  "type": "number",
                  "enum": [
                    5
                  ],
                  "description": "The unit width."
                },
                "height": {
                  "type": "number",
                  "enum": [
                    1.25
                  ],
                  "description": "The unit height."
                },
                "unit_weight": {
                  "type": "number",
                  "enum": [
                    0.56
                  ],
                  "description": "The unit weight."
                },
                "workflow_items": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "number",
                        "enum": [
                          5463456
                        ],
                        "description": "The id of the workflow item."
                      },
                      "option_id": {
                        "type": "number",
                        "enum": [
                          35345
                        ],
                        "description": "The id of the option"
                      },
                      "sub_option_id": {
                        "type": "number",
                        "enum": [
                          35345
                        ],
                        "description": "The id of the sub option"
                      },
                      "vendor_sku": {
                        "type": "string",
                        "enum": [
                          "AAA234234"
                        ],
                        "description": "The vendor's sku when the field is a size"
                      },
                      "dn_sku_id": {
                        "type": "string",
                        "enum": [
                          "123234"
                        ],
                        "description": "423513 (string, optional) - The deconetwork id of the sku."
                      },
                      "qty_to_fulfill": {
                        "type": "number",
                        "enum": [
                          3
                        ],
                        "description": "Matches the qty on the customer order for this SKU."
                      },
                      "qty_required": {
                        "type": "number",
                        "enum": [
                          4
                        ],
                        "description": "qty to fulfill + any wasted qty (so will initially be equal to qty to fulfill)."
                      },
                      "qty_allocated": {
                        "type": "number",
                        "enum": [
                          4
                        ],
                        "description": "No. of units actually allocated to this workflow item. Max == qty required."
                      },
                      "qty_on_order": {
                        "type": "number",
                        "enum": [
                          4
                        ],
                        "description": "No of units on order. Max (qty on order + qty allocated) == qty required"
                      },
                      "qty_produced": {
                        "type": "number",
                        "enum": [
                          4
                        ],
                        "description": "No of units successfully produced. Max == qty to fulfill"
                      },
                      "qty_wasted": {
                        "type": "number",
                        "enum": [
                          1
                        ],
                        "description": "No of units unsuccessfully produced/shipped (doesn't achieve QC, destroyed, etc). Max (qty produced + qty wasted) == qty required."
                      },
                      "qty_shipped": {
                        "type": "number",
                        "enum": [
                          3
                        ],
                        "description": "No of units shipped. Item considered 'shipped' when qty shipped == qty to fulfill."
                      },
                      "qty_skip_po": {
                        "type": "number",
                        "enum": [
                          0
                        ],
                        "description": "No of units not using purchase orders."
                      },
                      "qty_skip_inv": {
                        "type": "number",
                        "enum": [
                          0
                        ],
                        "description": "No of units not using purchase orders which were allocated from inventory."
                      },
                      "procurement_status": {
                        "type": "number",
                        "enum": [
                          60
                        ],
                        "description": "20=AWAITING-STOCK, 40=PARTIALLY-RECEIVED, 60=RECEIVED"
                      },
                      "production_status": {
                        "type": "number",
                        "enum": [
                          80
                        ],
                        "description": "20=ON-HOLD, 40=AWAITING-PRODUCTION, 60=PARTIALLY-PRODUCED, 80=PRODUCED"
                      },
                      "shipping_status": {
                        "type": "number",
                        "enum": [
                          80
                        ],
                        "description": "20=ON-HOLD, 40=NONE-SHIPPED, 60=PARTIALLY-SHIPPED, 80=SHIPPED"
                      },
                      "purchase_order_lines": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "po_line_id": {
                              "type": "number",
                              "enum": [
                                9633543
                              ],
                              "description": "The id of the purchase order line (will match PurchaseOrderLine.id from purchase order api)."
                            },
                            "po_number PO": {
                              "type": "string",
                              "enum": [
                                ""
                              ],
                              "description": "3452 (string, required) - The Purchase Order number (will match PurchaseOrder.po number from purchase order api)."
                            },
                            "qty_ordered": {
                              "type": "number",
                              "enum": [
                                2
                              ],
                              "description": "The qty ordered"
                            },
                            "qty_received": {
                              "type": "number",
                              "enum": [
                                1
                              ],
                              "description": "The qty received"
                            }
                          },
                          "required": [
                            "po_line_id",
                            "po_number PO",
                            "qty_ordered",
                            "qty_received"
                          ],
                          "additionalProperties": false
                        },
                        "description": "Purchase Order line information that is included if include po data parameter is set to 1."
                      }
                    },
                    "required": [
                      "id",
                      "dn_sku_id",
                      "qty_to_fulfill",
                      "qty_required",
                      "qty_allocated",
                      "qty_on_order",
                      "qty_produced",
                      "qty_wasted",
                      "qty_shipped",
                      "qty_skip_po",
                      "qty_skip_inv",
                      "procurement_status",
                      "production_status",
                      "shipping_status",
                      "purchase_order_lines"
                    ],
                    "additionalProperties": false
                  },
                  "description": "Production workflow information that is included if include workflow data parameter is set to 1."
                }
              },
              "required": [
                "id",
                "product_id",
                "product_color",
                "sku",
                "fields",
                "views",
                "qty",
                "total_price",
                "unit_price",
                "discount",
                "tax",
                "store_commission",
                "parent_store_commission",
                "commission_transaction_fee",
                "production_status",
                "workflow_items"
              ],
              "additionalProperties": false
            },
            "description": "An array of order lines."
          },
          "notes": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "note_type": {
                  "type": "string",
                  "enum": [
                    "to customer"
                  ],
                  "description": "The type of the note"
                },
                "content": {
                  "type": "string",
                  "enum": [
                    "Please hurry"
                  ],
                  "description": "The content of the note"
                },
                "created_at": {
                  "type": "string",
                  "enum": [
                    "2016-02-01T00:00:00"
                  ],
                  "description": "The date (ISO-8601 date format) the note was created"
                },
                "from": {
                  "type": "object",
                  "properties": {
                    "user_id": {
                      "type": "number",
                      "enum": [
                        2143423
                      ],
                      "description": "Id of user"
                    },
                    "email": {
                      "type": "string",
                      "enum": [
                        "fred@acme.co"
                      ],
                      "description": "Email address of user"
                    },
                    "firstname": {
                      "type": "string",
                      "enum": [
                        "Fred"
                      ],
                      "description": "First name of user"
                    },
                    "lastname": {
                      "type": "string",
                      "enum": [
                        "Smith"
                      ],
                      "description": "Last name of user"
                    },
                    "country_code": {
                      "type": "string",
                      "enum": [
                        "US"
                      ],
                      "description": "2 letter country code"
                    },
                    "state": {
                      "type": "string",
                      "enum": [
                        "California"
                      ],
                      "description": "Name of state"
                    },
                    "city": {
                      "type": "string",
                      "enum": [
                        "Huntington Beach"
                      ],
                      "description": "Name of city"
                    },
                    "street": {
                      "type": "string",
                      "enum": [
                        "219 Cimmaron Road"
                      ],
                      "description": "Name of street"
                    },
                    "postcode": {
                      "type": "string",
                      "enum": [
                        "92647"
                      ],
                      "description": "zip/post code"
                    },
                    "company": {
                      "type": "string",
                      "enum": [
                        "Acme Co"
                      ],
                      "description": "company name"
                    },
                    "salutation": {
                      "type": "string",
                      "enum": [
                        "Mr"
                      ]
                    },
                    "ph_number": {
                      "type": "string",
                      "enum": [
                        "714"
                      ],
                      "description": "596-6776 (string, optional) - Phone number"
                    },
                    "custom_fields": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "caption": {
                            "type": "string",
                            "enum": [
                              "Student Name"
                            ],
                            "description": "The caption of the field"
                          },
                          "value": {
                            "type": "string",
                            "enum": [
                              "Fred"
                            ],
                            "description": "The value of the field"
                          }
                        },
                        "required": [
                          "caption"
                        ],
                        "additionalProperties": false
                      },
                      "description": "An array of custom fields"
                    }
                  },
                  "required": [
                    "user_id",
                    "ph_number"
                  ],
                  "additionalProperties": false,
                  "description": "The creator of the note"
                }
              },
              "required": [
                "note_type",
                "content",
                "created_at",
                "from"
              ],
              "additionalProperties": false
            },
            "description": "An array of order notes."
          },
          "assigned_to": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "enum": [
                  35345
                ],
                "description": "The user id of the operator"
              },
              "login": {
                "type": "string",
                "enum": [
                  "Bob123"
                ],
                "description": "The login of the operator"
              },
              "firstname": {
                "type": "string",
                "enum": [
                  "Bob"
                ],
                "description": "The first name of the operator"
              },
              "lastname": {
                "type": "string",
                "enum": [
                  "Smith"
                ],
                "description": "The last name of the operator"
              }
            },
            "required": [
              "id",
              "login"
            ],
            "additionalProperties": false,
            "description": "The operator assigned to the order."
          },
          "is_priority": {
            "type": "boolean",
            "enum": [
              false
            ],
            "description": "True if order is priority."
          },
          "store": {
            "type": "object",
            "properties": {
              "id": {
                "type": "number",
                "enum": [
                  11424233
                ],
                "description": "The id of the store."
              },
              "name": {
                "type": "string",
                "enum": [
                  "Bobs Store"
                ],
                "description": "The name of the store."
              },
              "domain": {
                "type": "string",
                "enum": [
                  "www.bobs.com"
                ],
                "description": "The primary domain of the store."
              },
              "owner": {
                "type": "object",
                "properties": {
                  "user_id": {
                    "type": "number",
                    "enum": [
                      2143423
                    ],
                    "description": "Id of user"
                  },
                  "email": {
                    "type": "string",
                    "enum": [
                      "fred@acme.co"
                    ],
                    "description": "Email address of user"
                  },
                  "firstname": {
                    "type": "string",
                    "enum": [
                      "Fred"
                    ],
                    "description": "First name of user"
                  },
                  "lastname": {
                    "type": "string",
                    "enum": [
                      "Smith"
                    ],
                    "description": "Last name of user"
                  },
                  "country_code": {
                    "type": "string",
                    "enum": [
                      "US"
                    ],
                    "description": "2 letter country code"
                  },
                  "state": {
                    "type": "string",
                    "enum": [
                      "California"
                    ],
                    "description": "Name of state"
                  },
                  "city": {
                    "type": "string",
                    "enum": [
                      "Huntington Beach"
                    ],
                    "description": "Name of city"
                  },
                  "street": {
                    "type": "string",
                    "enum": [
                      "219 Cimmaron Road"
                    ],
                    "description": "Name of street"
                  },
                  "postcode": {
                    "type": "string",
                    "enum": [
                      "92647"
                    ],
                    "description": "zip/post code"
                  },
                  "company": {
                    "type": "string",
                    "enum": [
                      "Acme Co"
                    ],
                    "description": "company name"
                  },
                  "salutation": {
                    "type": "string",
                    "enum": [
                      "Mr"
                    ]
                  },
                  "ph_number": {
                    "type": "string",
                    "enum": [
                      "714"
                    ],
                    "description": "596-6776 (string, optional) - Phone number"
                  },
                  "custom_fields": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "caption": {
                          "type": "string",
                          "enum": [
                            "Student Name"
                          ],
                          "description": "The caption of the field"
                        },
                        "value": {
                          "type": "string",
                          "enum": [
                            "Fred"
                          ],
                          "description": "The value of the field"
                        }
                      },
                      "required": [
                        "caption"
                      ],
                      "additionalProperties": false
                    },
                    "description": "An array of custom fields"
                  }
                },
                "required": [
                  "user_id",
                  "ph_number"
                ],
                "additionalProperties": false,
                "description": "The store owner details."
              }
            },
            "required": [
              "id",
              "name",
              "domain",
              "owner"
            ],
            "additionalProperties": false,
            "description": "The store details."
          }
        },
        "required": [
          "order_id",
          "item_amount",
          "shipping_amount",
          "tax_amount",
          "taxes",
          "discount_amount",
          "coupon_discount_amount",
          "gift_certificate_amount",
          "credit_used",
          "billable_amount",
          "outstanding_balance",
          "quote_pdf_url",
          "production_pdf_url",
          "customer_id",
          "order_status",
          "date_started",
          "date_ordered",
          "date_due",
          "account_terms",
          "shipping_method",
          "shipments",
          "billing_details",
          "payment_details",
          "order_lines",
          "store"
        ],
        "additionalProperties": false
      },
      "description": "An array of order objects"
    },
    "total": {
      "type": "number",
      "description": "The total number of orders found."
    }
  },
  "required": [
    "response_status",
    "orders"
  ]
}

Order Search
GET/api/json/manage_orders/find

Retrieve a list of orders based upon your search parameters.
The maximum number of rows returned is 100. Use the returned “total” value to determine if you need to paginate using the offset parameter.
You can specify multiple conditions in which case the conditions will be joined with a logical ‘AND’.
To use multiple conditions you will need to pass the parameters using the multi condition parameter format:
conditions[n][parameter name] where n starts at 1 and “parameter name” is the name of the parameter as below.

URI Parameters
HideShow
field
number (required) Example: 1

The Field the condition is tested against.
Multi condition parameter format: conditions[n][field]

Choices: 1: Date Ordered 2: Date Production Files Ready 3: Invoice Number 4: Order Status 5: Date Due 6: Date Invoiced 7: Date Shipped 8: Date Modified

condition
number (required) Example: 1

The logical test to use.
Multi condition parameter name: conditions[n][condition]

Choices: 1: == 2: != 3: < 4: > 5: <= 6: >= 7: Between

date1
date (optional) Example: 2016-03-28T22:01:46

The date to test against (Required when field is Date Ordered or Date Production Files Ready).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date1]

date2
date (optional) Example: 2016-03-28T22:01:46

The end date to test against (Required when field is Date Ordered or Date Production Files Ready and condition is 7: Between).
The date is in ISO-8601 date format in UTC timezone (YYYY-MM-DDTHH:MM:SS).
Multi condition parameter name: conditions[n][date2]

string
string (optional) Example: INV1234

The string to test against (Required when field is Invoice Number).
Multi condition parameter name: conditions[n][string]

limit
number (optional) Default: 100 Example: 100

Limit the number of results returned. The maximum limit is 100.

offset
number (optional) Default: 0 Example: 0

Offset of the results to allow pagination.

sortby
number (optional) Default: 2 Example: 1

What field to sort the results by.

Choices: 1: Date Ordered 2: Date Production Files Ready 3: Invoice Number 4: Order Status 5: Date Due 6: Date Invoiced 7: Date Shipped 8: Date Modified

include_workflow_data
number (optional) Default: 0 Example: 0

Include workflow information used to track items going through the production workflow. Set to 1 to include workflow information.

include_po_data
number (optional) Default: 0 Example: 0

Include purchase order information associated with the above workflow information. This will make workflow information be included.Set to 1 to include purchase order information.

include_shipments
number (optional) Default: 0 Example: 0

Include shipment information. Set to 1 to include shipment information.

username
string (required) Example: fred123

The username of the account to use when connecting to the API.

password
string (required) Example: password123

The password of the account to use when connecting to the API.


Update Order Status

POST /api/json/manage_orders/update_order_status
RequestsChange Status Of Order to Produced
Headers
Content-Type: application/x-www-form-urlencoded
Body
order_id=INV1234
order_line_id=12321324
new_status=1
contact_customer=false
operator_login=bob123
username=fred123
password=password123
Responses200
Headers
Content-Type: application/json
Body
{
  "response_status": {
    "code": 10001,
    "severity": "SUCCESS",
    "description": "."
  }
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "response_status": {
      "type": "object",
      "properties": {
        "code": {
          "type": "number",
          "description": "the status code."
        },
        "severity": {
          "type": "string",
          "description": "either SUCCESS or ERROR"
        },
        "description": {
          "type": "string",
          "description": "A description of the error. Blank when SUCCESS."
        }
      },
      "required": [
        "code"
      ]
    }
  },
  "required": [
    "response_status"
  ]
}

Update Order Status
POST/api/json/manage_orders/update_order_status

Update the status of an order and line items.
Multiple orders and line items can be specified in one request using the “multi change format”:
changes[n][parameter name] where “n” starts at 1, and “parameter name” is the name of the parameter as below.

URI Parameters
HideShow
order_id
string (required) Example: INV1234

The Invoice Number of the order.
Multi change parameter format: changes[n][order_id]

order_line_id
number (optional) Example: 12321324

The line item id of the line item getting changed. If missing the whole order will be changed.
Multi change parameter format: changes[n][order_line_id]

workflow_item_id
number (optional) Example: 4536345

The workflow item id of the workflow item getting changed. If missing the whole line item will be changed.
Multi change parameter format: changes[n][workflow_item_id]

qty
number (optional) Example: 3

The qty of the change. If you specify a qty, you must also specify a workflow_item_id. If missing the qty will be the outstanding qty for that item.
Multi change parameter format: changes[n][qty]

new_status
number (required) Example: 2

The status to change the order/line item to.
Multi change parameter format: changes[n][new_status]

Choices: 2: Produced 3: Shipped

contact_customer
boolean (optional) Default: false Example: true

Contact the customer letting them know of the status change. This will only happen if the whole order is moved status.
Multi change parameter format: changes[n][contact_customer]

shipping_code
string (optional) Example: POSTABC123

The Shipping Tracking Number to assign if marking as shipped.
Multi change parameter format: changes[n][shipping_tracking_code]

operator_id
number (optional) Example: 12332423

The id of the operator making the change. If not specified, the operator with the username/password sent will be used.
Multi change parameter format: changes[n][operator_id]

operator_login
string (optional) Example: bob123

The login of the operator making the change. Can be used if the id of the operator is unknown.
Multi change parameter format: changes[n][operator_login]

username
string (required) Example: fred123

The username of the account to use when connecting to the API.

password
string (required) Example: password123

The password of the account to use when connecting to the API.


Generated by aglio on 04 Sep 2019