(PHP Extension) Ecwid - Create Order

See more Ecwid Examples

Create a new order in an Ecwid store. This can be useful for storefronts with a custom checkout process or manually creating orders for sales made earlier.

For more information, see https://api-docs.ecwid.com/reference/orders#create-an-order

Chilkat PHP Downloads PHP Extension for Windows, Linux, MacOS, Alpine Linux, Solaris

<?php

// The version number (9_5_0) should match version of the Chilkat extension used, omitting the micro-version number.
// For example, if using Chilkat v9.5.0.48, then include as shown here:
include("chilkat_9_5_0.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

// Create and send the following HTTP request:

// Load the access token previously obtained in Ecwid Get Access Token
$jsonToken = new CkJsonObject();
$jsonToken->LoadFile('qa_data/tokens/ecwid.json');

$sbUrl = new CkStringBuilder();
$sbUrl->Append('https://app.ecwid.com/api/v3/4870020/orders?token=');
$sbUrl->Append($jsonToken->stringOf('access_token'));

// POST /api/v3/4870020/orders?token=1234567890qwqeertt HTTP/1.1
// Host: app.ecwid.com
// Content-Type: application/json;charset=utf-8
// Cache-Control: no-cache
// 
// {
//         "subtotal": 30,
//         "total": 40,
//         "email": "example@example.com",
//         "paymentMethod": "Phone order",
//         "tax": 0,
//         "paymentStatus": "PAID",
//         "customerTaxExempt": false,
//         "customerTaxId": "",
//         "customerTaxIdValid": false,
//         "reversedTaxApplied": false,
//         "fulfillmentStatus": "AWAITING_PROCESSING",
//         "createDate": "2015-09-20 19:59:43 +0000",
//         "items": [
//             {
//                 "price": 15,
//                 "weight": 0.32,
//                 "sku": "00004",
//                 "quantity": 2,
//                 "name": "Cherry"
//             }
//         ],
//         "billingPerson": {
//             "name": "Eugene K",
//             "companyName": "Hedgehog and Bucket",
//             "street": "My Street",
//             "city": "San Diego",
//             "countryCode": "US",
//             "postalCode": "90002",
//             "stateOrProvinceCode": "CA",
//             "phone": "123141321"
//         },
//         "shippingPerson": {
//             "name": "Eugene K",
//             "companyName": "Hedgehog and Bucket",
//             "street": "My Street",
//             "city": "San Diego",
//             "countryCode": "US",
//             "postalCode": "90002",
//             "stateOrProvinceCode": "CA",
//             "phone": "123141321"
//         },
//         "shippingOption": {
//             "shippingMethodName": "Fast Delivery",
//             "shippingRate": 10,
//             "isPickup": false,
//             "fulfilmentType": "DELIVERY"
//         },
//         "hidden": false,
//         "privateAdminNotes": "Must be delivered till Sunday.",
//         "acceptMarketing": false,
//         "disableAllCustomerNotifications": true,
//         "externalFulfillment": true,
//         "externalOrderId": "2",
//         "pricesIncludeTax": false  
//     }

$http = new CkHttp();
$http->SetRequestHeader('Cache-Control','no-cache');

$json = new CkJsonObject();
$json->UpdateInt('subtotal',30);
$json->UpdateInt('total',40);
$json->UpdateString('email','example@example.com');
$json->UpdateString('paymentMethod','Phone order');
$json->UpdateInt('tax',0);
$json->UpdateString('paymentStatus','PAID');
$json->UpdateBool('customerTaxExempt',false);
$json->UpdateString('customerTaxId','');
$json->UpdateBool('customerTaxIdValid',false);
$json->UpdateBool('reversedTaxApplied',false);
$json->UpdateString('fulfillmentStatus','AWAITING_PROCESSING');
$json->UpdateString('createDate','2015-09-20 19:59:43 +0000');
$json->UpdateInt('items[0].price',15);
$json->UpdateNumber('items[0].weight','0.32');
$json->UpdateString('items[0].sku','00004');
$json->UpdateInt('items[0].quantity',2);
$json->UpdateString('items[0].name','Cherry');
$json->UpdateString('billingPerson.name','Eugene K');
$json->UpdateString('billingPerson.companyName','Hedgehog and Bucket');
$json->UpdateString('billingPerson.street','My Street');
$json->UpdateString('billingPerson.city','San Diego');
$json->UpdateString('billingPerson.countryCode','US');
$json->UpdateString('billingPerson.postalCode','90002');
$json->UpdateString('billingPerson.stateOrProvinceCode','CA');
$json->UpdateString('billingPerson.phone','123141321');
$json->UpdateString('shippingPerson.name','Eugene K');
$json->UpdateString('shippingPerson.companyName','Hedgehog and Bucket');
$json->UpdateString('shippingPerson.street','My Street');
$json->UpdateString('shippingPerson.city','San Diego');
$json->UpdateString('shippingPerson.countryCode','US');
$json->UpdateString('shippingPerson.postalCode','90002');
$json->UpdateString('shippingPerson.stateOrProvinceCode','CA');
$json->UpdateString('shippingPerson.phone','123141321');
$json->UpdateString('shippingOption.shippingMethodName','Fast Delivery');
$json->UpdateInt('shippingOption.shippingRate',10);
$json->UpdateBool('shippingOption.isPickup',false);
$json->UpdateString('shippingOption.fulfilmentType','DELIVERY');
$json->UpdateBool('hidden',false);
$json->UpdateString('privateAdminNotes','Must be delivered till Sunday.');
$json->UpdateBool('acceptMarketing',false);
$json->UpdateBool('disableAllCustomerNotifications',true);
$json->UpdateBool('externalFulfillment',true);
$json->UpdateString('externalOrderId','2');
$json->UpdateBool('pricesIncludeTax',false);

// resp is a CkHttpResponse
$resp = $http->PostJson3($sbUrl->getAsString(),'application/json',$json);
if ($http->get_LastMethodSuccess() != true) {
    print $http->lastErrorText() . "\n";
    exit;
}

print 'Response status code = ' . $resp->get_StatusCode() . "\n";

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": 20,
//   "orderid": "XJ12H"
// }

// Sample code for parsing the JSON response...
// Use the following online tool to generate parsing code from sample JSON:
// Generate Parsing Code from JSON

$id = $jResp->IntOf('id');
$orderid = $jResp->stringOf('orderid');


?>