Wired Plus API Documentation

API v1 Guide

Account

Automation

Contacts

Dynamic Rows

Lists

Campaigns

Transactional Emails

Lead Score

Products

Carts

Orders

Custom Fields

POST BulkOrderUpdate

Create/Update a list of orders.

This feature must be enabled for your account.

A maximum of 50 records can be updated per request.

Input and output parameters

*denotes required field.

Input Parameter Name Type/Info
id id of the order in the system, provide this if you want to update.
api_reference_id* your reference to identify the order, if no "id" is provided we'll use this to update your order.
contact_id ID of the contact in our system you want to assign the order to. Without we'll use "customer_email" to assign the contact.
order_reference An additional user friendly reference for your order.
order_create_date When your order was created YYYY-MM-DD HH:MM:SS.
order_update_date When your order was updated YYYY-MM-DD HH:MM:SS.
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 on the order.
invoice_total Total worth of the order.
invoice_total_inc_tax Total worth of the order with tax.
invoice_discount_total Total discount applied.
shipping_tax_total Tax paid on shipping.
shipping_total Total shipping charges.
shipping_total_inc_tax Total shipping charges with tax.
shipping_discount_total Discount applied to shipping.
grand_total Total paid for order.
grand_total_inc_tax Total paid for order with tax.
iso_currency_code ISO alpha 3 currency code.
payment_type Type of payment made.
payment_type_name Friendly name for payment type.
number_of_products Number of products assigned to the order.
customer_email* Email address to the customer, without a contact_id, we'll use this to assign to the contact.
customer_firstname Customer first name.
customer_lastname Customer last name.
customer_gender Customer's gender.
customer_telephone Customer's contact number.
customer_mobile Customer's contact mobile number.
customer_dob Customer's date of birth.
customer_is_guest Is this a guest checkout.
customer_notes Any further info about the customer.
billing_first_name Billing first name.
billing_last_name Billing last name.
billing_address1 Billing address line 1.
billing_address2 Billing address line 2.
billing_city Billing address city.
billing_county Billing address county.
billing_post_code Billing address post-code.
billing_country Billing address country.
shipping_first_name Shipping first name.
shipping_last_name Shipping last name.
shipping_address1 Shipping address line 1.
shipping_address2 Shipping address line 2.
shipping_city Shipping address city.
shipping_county Shipping address county.
shipping_post_code Shipping address post-code.
shipping_country Shipping address country.
order_lines* Array of data:
  • order_line_id - Your order reference.
  • product_sku - Your product SKU.
  • product_name - Your product name.
  • product_description - Your product description.
  • tax_percent - Tax charged.
  • product_price - Price for product.
  • product_price_tax - Tax charged to product.
  • product_price_inc_tax - Product price with tax.
  • product_original_price - Original product price (rrp).
  • quantity - Number stocked.
  • row_total - Cost for the order line.
  • row_total_inc_tax - Cost for the order line with tax.
  • row_total_discount - Discount for the order line.
custom_fields Array of key value pairs for any custom fields data
Key is the field name then value assigned:
  • field_name: field_value
Outputs:
  • id - system id for the order
  • status - http status code
  • message - action performed
  • error - only present during failure

Examples

Curl

PHP

jQuery

Result Format JSON