Explore

Order

id	Type:String	Read only:True	The unique identifier of the order
ordernumber	Type:String	Read only:True	The unique order number
created *	Type:DateTime	Read only:True	The timestamp that the order was created
modified *	Type:DateTime	Read only:True	The timestamp that the order was last updated
success *	Type:Boolean	Read only:False	A flag indicating if the order was successful
customer *	Type:Order Customer	Read only:False	The customer associated with this order
items*	Type:Order Line[]	Read only:False	Array of order lines
subtotal *	Type:Decimal	Read only:False	The subtotal of the order lines
discounts *	Type:Decimal	Read only:False	The total discounts applied to the order
tax *	Type:Decimal	Read only:False	The total tax applied to the order
total *	Type:Decimal	Read only:False	The total value of the order
items*	Type:String[]	Read only:False	Array of promotional/coupon codes
fulfilmentmethod	Type:String	Read only:True	The fulfilment method of this order
shipping *	Type:Order Shipping	Read only:False	The shipping details of the order
financeagreement *	Type:Order Finance Agreement	Read only:False	Details of a finance agreement associated with this order

Example

{
  "id": "5668f38d46fc510c6c0d4705",
  "ordernumber": "159949",
  "created": "2017-12-10T03:37:49.745+00:00",
  "modified": "2017-12-10T12:01:29.502+00:00",
  "success": true,
  "currency": "GBP",
  "status": {
    "id": "56409ed246fc580098b28604",
    "name": "Complete"
  },
  "customer": {
    "id": "5643eff487bb38127c11e324",
    "email": "[email protected]",
    "billto": {
      "name": {
        "title": "Mr",
        "firstname": "Test",
        "surname": "Customer"
      },
      "company": null,
      "address": {
        "addressline1": "20-22 Wenlock Road",
        "addressline2": "",
        "addressline3": "",
        "towncity": "London",
        "stateprovince": "London",
        "postalcode": "N1 7GU",
        "country": "GB"
      }
    },
    "shipto": {
      "name": {
        "title": "Mr",
        "firstname": "Test",
        "surname": "Customer"
      },
      "company": null,
      "address": {
        "addressline1": "20-22 Wenlock Road",
        "addressline2": "",
        "addressline3": "",
        "towncity": "London",
        "stateprovince": "London",
        "postalcode": "N1 7GU",
        "country": "GB"
      }
    },
    "numbers": [
      "02030869860"
    ],
    
  },
  "items": [
    {
      "id": "1668f38d46fc510c6c0d4706",
      "sku": "R24842344",
      "name": "Sylvanian Families Family Barbeque Set",
      "variation": null,
      "quantity": 1,
      "unitprice": 5,
      "unitsalediscount": 0,
      "unittax": 0,
      "subtotal": 5,
      "productid": "52f840e687bb3843cc26e704",
      "variantid": "53f840e687bb3843cc26e705",
      "cancellation": null
    }
  ],
  "subtotal": 5,
  "discounts": 0,
  "tax": 0,
  "total": 5,
  "promotions": [
    "FREEPOST"
  ],
  "fulfilmentmethod": "Home Delivery",
  "shipping": {
    "service": "Standard (3-5 working days)",
    "carriercode": null,
    "cost": 0,
    "nominateddate": null,
    "notes": "",
    "shippingdate": null,
    "consignmentnumber": null
  },
  "financeagreement": {
    "active": false,
    "agreementnumber": null,
    "status": null
  }
}