Documentation

OrdersApi extends V2ApiBase

Orders v2 API

Some functionality for Orders is not available in V3, so this V2 API class has been implemented.

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

Methods

__construct()

public __construct(BaseApiClient $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
$client : BaseApiClient
$resourceId : int|null = null
$parentResourceId : int|null = null
Return values
mixed —

create()

public create(Order $order) : object
Parameters
$order : Order
Return values
object —

getAll()

public getAll([array<string|int, mixed> $filters = [] ][, int $page = 1 ][, int $limit = 250 ]) : array<string|int, Order>
Parameters
$filters : array<string|int, mixed> = []
$page : int = 1
$limit : int = 250
Return values
array<string|int, Order> —

getParentResourceId()

public getParentResourceId() : int|null
Return values
int|null —

getResourceId()

public getResourceId() : int|null
Return values
int|null —

multipleResourceUrl()

public multipleResourceUrl() : string
Return values
string —

singleResourceUrl()

public singleResourceUrl() : string
Return values
string —

Search results