API Service Documentation

Command: create_order

Creates an order record in order_management

Request

NameTypeRequiredExample
user_idIntegerY1001

The user id in system

productsjsonY[{"qty":3,"price":0,"title":"test0","stock_item_id":0,"product_code":"asdfs0"},{"qty":2,"price":2,"title":"test1","stock_item_id":1,"product_code":"asdfs1"}]

The products associated array

totalfloatY10.00

The order total

shippingfloatY10.00

The order shipping cost

taxfloatY10.00

The order tax

external_idmixedN1001

Another order id

admin_commentsstringNLorem Ispn

The details provided by admin

payment_statusstringNLorem Ispn

The payment status. Needs to be one of these "AUTH, AUTH CAPTURE, CAPTURE, OVERRIDE, VOID, REFUND, REFUND PARTIAL, ERROR, DECLINED, PENDING, PROCESSING""

date_addedtimestampN2017-02-14 13:59:00

Set the timestamp for when the order was created. Default timestamp is the timestamp of the request

merchant_idIntegerN10

Set order merchant id. Mechant must exist.

billing_addrjsonN{"first_name":"test","last_name":"test","company":"","address_line_1":"1 fake street","address_line_2":"","city":"tampa","region":"FL","country":"US","postal_code":"33771","email":"test@example.com","phone":"1234567890"}

The billing address

shipping_addrjsonN{"first_name":"test","last_name":"test","company":"","address_line_1":"1 fake street","address_line_2":"","city":"tampa","region":"FL","country":"US","postal_code":"33771","email":"test@example.com","phone":"1234567890"}

The shipping address

Response

NameTypeExample
statusInteger0

Success

statusInteger1

Fail

status_messageJSON