Wired Plus API Documentation

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

GET GetOrders

Get a list of orders in the system.

This feature must be enabled for your account.

Input and output parameters

Input Parameter Name Type/Info
contact_id Show orders by contact.
order_update_from Filter by order's update date, format: yyyy-mm-dd hh:mm:ss.
order_create_from Filter by order's create date, format: yyyy-mm-dd hh:mm:ss
select Number of records to return, maximum 500.
skip Number of records to skip
sort How to sort the results, options: update_date_asc | update_date_desc | create_date_asc | create_date_desc | order_update_date_asc | order_update_date_desc | order_create_date_asc | order_create_date_desc
Outputs:
  • id - unique identifier in our system.
  • api_integration - name of the integration.
  • api_resource - the integration resource name.
  • api_reference_id - your system ID to identify the order.
  • order_reference - reference for your order.
  • contact_id - contact assigned to the order, if missing we'll use "customer_email" to assign contact_id for you.
  • create_date - date order was added to the system
  • update_date - date order was updated in the system
  • order_create_date - date order was created in your system
  • order_update_date - date order was updated in your system
  • order_status - unknown | pending | processing | under-review | awaiting-payment | awaiting-fulfillment | awaiting-pickup | partially-shipped | completed | shipped | fraud | closed | cancelled | declined | refunded | disputed | partially-refunded
  • invoice_tax_total - total tax charged for the order.
  • invoice_total - order total.
  • invoice_total_inc_tax - order total with tax.
  • invoice_discount_total - order discount applied.
  • shipping_tax_total - tax charged to shipping.
  • shipping_total - total shipping cost.
  • shipping_total_inc_tax - total shipping cost with tax.
  • shipping_discount_total - total shipping discount.
  • grand_total - order total with discount, shipping applied.
  • grand_total_inc_tax - order total with tax, discount, shipping applied.
  • iso_currency_code - alpha 3 iso code.
  • payment_type - type of payment made.
  • payment_type_name - friendly name for payment type.
  • number_of_products - number of products included in the order.
  • customer_email - customer's email.
  • customer_firstname - customer's first name.
  • customer_lastname - customer's last name.
  • customer_gender - customer's gender.
  • customer_telephone - customer's tel.
  • customer_mobile - customer's mobile tel.
  • customer_dob - customer's date of birth.
  • customer_is_guest - is a guest account.
  • customer_notes - notes associated with the order.
  • billing_first_name - billing person first name.
  • billing_last_name - billing person last name.
  • billing_address1 - billing person address line 1.
  • billing_address2 - billing person address line 2.
  • billing_city - billing person address city.
  • billing_county - billing person address county.
  • billing_post_code - billing person address post code.
  • billing_country - billing person address country.
  • shipping_first_name - shipping person first name.
  • shipping_last_name - shipping person last name.
  • shipping_address1 - shipping person address line 1.
  • shipping_address2 - shipping person address line 2.
  • shipping_city - shipping person address city.
  • shipping_county - shipping person address county.
  • shipping_post_code - shipping person address post code.
  • shipping_country - shipping person address country.
order_lines - array of order lines
  • id - unique id in the system.
  • order_id - system order id.
  • order_line_id - your assigned id for the line.
  • date_created - date line was created.
  • date_updated - date line was updated.
  • product_id - system product id, if omitted we'll use "product_sku" to set this.
  • product_sku - product sku.
  • product_name - product name.
  • product_description - product description.
  • tax_percent - percent tax charged.
  • product_price_tax - tax applied to price.
  • product_original_price - product rrp.
  • product_price - product price.
  • product_price_inc_tax - product price with tax.
  • quantity - quantity bought.
  • row_total - total for order line.
  • row_total_inc_tax - total for order line with tax.
  • row_total_discount - total discounts applied.
custom_fields - Custom fields for the order.
  • Key is the field name then value assigned:
    field_name: field_value

Examples

Curl

    
    
    

PHP

    
    


jQuery

    
    


Result Format JSON