Documentation

OrdersApi extends V2ApiBase

in package

• BigCommerce

Uses CreateResource, GetResource, GetAllResources

Orders v2 API

Tags

see

OrdersApi

for the V3 API

see

OrderProductsApi

for listing the products in an order

Example

Create an Order

$api = new BigCommerce\ApiV2\V2ApiClient($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);

$order = new BigCommerce\ApiV2\ResourceModels\Order\Order();
$order->products = [
    OrderProduct::build('test', 1, 12, 10),
];
// set order details...

try {
    $createdOrder = $api->orders->create($order);
    echo "Order {$createdOrder->id} has been created.";
} catch (\Psr\Http\Client\ClientExceptionInterface $exception) {
    echo "Unable to update product: {$exception->getMessage()}";
}

Get Order Counts

$api = new BigCommerce\ApiV2\V2ApiClient($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
$ordersAwaitingFulfillmentCount = $api->orders()->count()->statuses['Awaiting Fulfillment'];

Table of Contents

__construct()  : mixed

count()  : OrderCount

create()  : object

get()  : Order|null

getAll()  : array<string|int, Order>

getClient()  : BaseApiClient

getParentResourceId()  : int|null

getResourceId()  : int|null

multipleResourceUrl()  : string

product()  : OrderProductsApi

products()  : OrderProductsApi

shippingAddress()  : OrderShippingAddressesApi

shippingAddresses()  : OrderShippingAddressesApi

singleResourceUrl()  : string