OrdersApi
extends V3ApiBase
in package
V3 Orders API
V3 API for Orders is quite limited, so a V2 API client is provided.
Tags
Table of Contents
- __construct() : mixed
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- metafield() : OrderMetafieldsApi
- metafields() : OrderMetafieldsApi
- refund() : RefundsApi
- refunds() : RefundsApi
- transactions() : TransactionsResponse
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Tags
Return values
mixed —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —metafield()
public
metafield(int $id) : OrderMetafieldsApi
Parameters
- $id : int
Tags
Return values
OrderMetafieldsApi —metafields()
public
metafields() : OrderMetafieldsApi
Tags
Return values
OrderMetafieldsApi —refund()
public
refund() : RefundsApi
Tags
Return values
RefundsApi —refunds()
public
refunds() : RefundsApi
Tags
Return values
RefundsApi —transactions()
public
transactions() : TransactionsResponse