OrdersApi extends V2ApiBase
Orders v2 API
Currently only implements create.
Example
$api = new BigCommerce\ApiV2\V2ApiClient($_ENV['hash'], $_ENV['CLIENT_ID'], $_ENV['ACCESS_TOKEN']);
$order = new BigCommerce\ApiV2\ResourceModels\Order\Order();
// 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()}";
}
Table of Contents
- __construct() : mixed
- create() : object
- getClient() : V2ApiClient
- getParentResourceId() : int|null
- getResourceId() : int|null
- multipleResourceUrl() : string
- singleResourceUrl() : string
Methods
__construct()
public
__construct(V2ApiClient $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : V2ApiClient
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Return values
mixed —create()
public
create(Order $order) : object
Parameters
- $order : Order
Return values
object —getClient()
public
getClient() : V2ApiClient
Return values
V2ApiClient —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