Create Order

Creates a new order in Despatch Cloud and returns a success or failure message as well as the order id of the order created.

This API call can be used to create both manual orders and orders linked to a sales channel setup in Despatch Cloud.

Endpoint: https://YOUR-ACCOUNT-NAME.despatchcloud.co.uk/ws/v1/wsorders/create_order
Method: POST

Field Name	Required	Format	Notes
order_id	No	String	Automatically generated if empty.
channel_id	No	String
channel_alt_id	No	String
date_received	No	Unix Time Stamp	Automatically generated if empty.
sales_channel	No	String	Must be a valid sales channel, Automatically set to manual if empty.
status	No	Integer	1 = Draft / 2 = On Hold / 3 = Ready
invoice_name_company	No	String
invoice_name	No	String
invoice_address_line_one	No	String
invoice_address_line_two	No	String
invoice_address_city	No	String
invoice_address_county	No	String
invoice_address_country	No	String
invoice_address_postcode	No	String
invoice_address_iso	No	String
shipping_name_company	No	String
shipping_name	No	String
shipping_address_line_one	No	String
shipping_address_line_two	No	String
shipping_address_city	No	String
shipping_address_county	No	String
shipping_address_country	No	String
shipping_address_postcode	No	String
shipping_address_iso	No	String
email	No	String
phone_one	No	String
phone_two	No	String
total_paid	No	String
tax_paid	No	String
shipping_paid	No	String
payment_method	No	String
payment_ref	No	String
payment_currency	No	String
shipping_method_requested	No	String
customer_comments	No	String
staff_notes	No	String

Example Request (POST):

CopyCopyCopyCopyCopyCopyCopyCopyCopy{
  "order": {
    "order_id": "123456789-9",
    "channel_id": "1",
    "channel_alt_id": "",
    "shipping_name_company": "Despatch Cloud Ltd",
    "shipping_name": "Jane Doe",
    "shipping_address_line_one": "Unit 76",
    "shipping_address_line_two": "Warfield Road",
    "shipping_address_city": "Driffield",
    "shipping_address_county": "East Yorkshire",
    "shipping_address_country": "United Kingdom",
    "shipping_address_postcode": "YO25 9DJ",
    "shipping_address_iso": "GB",
    "invoice_name_company": "Despatch Cloud Ltd",
    "invoice_name": "Jane Doe",
    "invoice_address_line_one": "Unit 76",
    "invoice_address_line_two": "Warfield Road",
    "invoice_address_city": "Driffield",
    "invoice_address_county": "East Yorkshire",
    "invoice_address_country": "United Kingdom",
    "invoice_address_postcode": "YO25 9DJ",
    "invoice_address_iso": "GB",
    "email": "[email protected]",
    "phone_one": "01377455180",
    "phone_two": "",
    "total_paid": "24.00",
    "tax_paid": "4.00",
    "shipping_paid": "4.00",
    "total_discount": "0.00",
    "shipping_method_requested": "Next Day",
    "shipping_tracking_code": "",
    "payment_method": "Shopifypayments",
    "payment_ref": "",
    "payment_currency": "GBP",
    "sales_channel": "Shopify",
    "date_received": "1564655767",
    "date_dispatched": "0",
    "status": "1",
    "customer_comments": "",
    "staff_comments": "",
    "deleted": "0",
    "files": "",
    "discount_code_used": "",
    "coupon_code": "",
    "inventory": [
      {
        "stock_code": "TESTSKU",
        "name": "Test Product",
        "quantity": 1,
        "price": "30.00",
        "options": "Colour: Brown | Size: 9",
        "notes": ""
      }
    ]
  }
}

Example Response:

CopyCopyCopyCopyCopyCopyCopyCopyCopy{"status":"SUCCESS","order_id":"123456789-9"}