Qodex.ai

Create Order

POST https://api.ecartapi.com/api/v2/orders

Creates new orders.

Important information:

Request Body

{"order"=>{"reference"=>"ORDER1234567", "currency"=>"USD", "email"=>"john@example.com", "billingAddress"=>{"firstName"=>"John", "lastName"=>"Doe", "address1"=>"8 Clarkson Street", "address2"=>"Unit 2F", "city"=>"New York", "state"=>{"code"=>"NY"}, "country"=>{"code"=>"US"}, "postalCode"=>"10014", "phone"=>"999-999-9999"}, "shippingAddress"=>{"firstName"=>"Jane", "lastName"=>"Smith", "address1"=>"225 Varick Street", "address2"=>"12th Floor", "city"=>"New York", "state"=>{"code"=>"NY"}, "country"=>{"code"=>"US"}, "postalCode"=>"10014", "phone"=>"999-999-9999"}, "items"=>[{"variantId"=>"d624eac3-e0fc-4f83-9a7c-dc13e1c5508a", "quantity"=>"1", "price"=>"49.00"}], "shippingLines"=>{"method"=>"Flat Rate", "price"=>"0"}, "taxesIncluded"=>"true", "totals"=>{"subtotal"=>"49", "total"=>"49"}, "fulfillmentStatus"=>"PENDING"}}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{"success":true,"order":{"id":"5f7df9502657060e058da41d","number":"4","marketPlaceId":null,"name":null,"email":"john@example.com","fulfillmentStatus":{"id":null,"status":"PENDING","ecartapi":"unfulfilled","ecartapiId":"3","partiallAvailable":"false"},"currency":"USD","totals":{"subtotal":"49.00","total":"49.00","tax":"0.00","discount":"0.00","weight":null},"taxesIncluded":null,"units":{"weight":null},"status":{"id":null,"status":null,"financial":null,"ecartapi":"pending","ecartapiId":"2"},"locationId":null,"reference":null,"tags":null,"payment":null,"customer":{},"billingAddress":{},"shippingMethod":"Flat Rate","shippingAddress":{"id":null,"firstName":"Jane","lastName":"Smith","address1":"225 Varick Street","address2":"12th Floor","country":{"code":"US","name":"United States of America","codeIso2":"US","codeIso3":"USA"},"state":{"code":null,"name":"NY","codeIso2":null,"codeIso3":null},"city":"New York","postalCode":"10014","phone":"999-999-9999","company":null,"references":null},"items":[{"id":"5f7df94e5fab760001063cd0","variantId":"d624eac3-e0fc-4f83-9a7c-dc13e1c5508a","productId":"d624eac3-e0fc-4f83-9a7c-dc13e1c5508a","sku":"SQ8482056","fulfillment":{"quantity":null,"service":null,"status":null},"name":"Test","requiresShipping":"true","quantity":"1","price":"49.00","discount":null,"tax":null,"taxable":null,"vendor":null,"imageUrl":"https://static1.squarespace.com/static/5f75fe1d4bba4f2a73f7e62e/5f75fe530cb6f82db937253e/5f75fffb05a7793966d2111c/1601568769758/Cali.jpg","ecartapiUrl":"localhost:3000/api/v2/products/d624eac3-e0fc-4f83-9a7c-dc13e1c5508a","currency":"USD"}],"meta":null,"dates":{"canceledAt":null,"closedAt":null,"createdAt":"2020-10-07T17:22:21.099Z","updatedAt":"2020-10-07T17:22:24.785Z"},"cancelReason":null,"note":null,"checkoutId":null}}