FriendsOfCE\Channel\ApiClient\OrderApi

All URIs are relative to https://demo.channelengine.net/api, except if the operation defines another base path.

Method	HTTP request	Description
orderAcknowledge()	POST /v2/orders/acknowledge	Acknowledge Order.
orderGetByFilter()	GET /v2/orders	Get Orders By Filter.
orderGetNew()	GET /v2/orders/new	Get New Orders.
orderInvoice()	GET /v2/orders/{merchantOrderNo}/invoice	Download Invoice.
orderPackingSlip()	GET /v2/orders/{merchantOrderNo}/packingslip	Download Packing Slip.
orderUpdate()	PUT /v2/orders/comment	Update Comment.
orderUploadInvoice()	POST /v2/orders/{merchantOrderNo}/invoice	Upload Invoice.

`orderAcknowledge()`

orderAcknowledge($merchantOrderAcknowledgementRequest): \FriendsOfCE\Channel\ApiClient\Model\ApiResponse

Acknowledge Order.

Acknowledge an order. By acknowledging the order the merchant can confirm that
the order has been imported. When acknowledging an order the merchant has to supply
references that uniquely identify the order and the order lines. These references
will be used in the other API calls.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchantOrderAcknowledgementRequest = new \FriendsOfCE\Channel\ApiClient\Model\MerchantOrderAcknowledgementRequest(); // \FriendsOfCE\Channel\ApiClient\Model\MerchantOrderAcknowledgementRequest | Relations between the id's returned by ChannelEngine and the references which the merchant uses.

try {
    $result = $apiInstance->orderAcknowledge($merchantOrderAcknowledgementRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderAcknowledge: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
merchantOrderAcknowledgementRequest	\FriendsOfCE\Channel\ApiClient\Model\MerchantOrderAcknowledgementRequest	Relations between the id's returned by ChannelEngine and the references which the merchant uses.	[optional]

Return type

\FriendsOfCE\Channel\ApiClient\Model\ApiResponse

Authorization

apiKey

HTTP request headers

Content-Type: application/json-patch+json, application/json, application/*+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`orderGetByFilter()`

orderGetByFilter($statuses, $emailAddresses, $merchantOrderNos, $channelOrderNos, $fromDate, $toDate, $fromCreatedAtDate, $toCreatedAtDate, $excludeMarketplaceFulfilledOrdersAndLines, $fulfillmentType, $onlyWithCancellationRequests, $channelIds, $stockLocationIds, $isAcknowledged, $fromUpdatedAtDate, $toUpdatedAtDate, $fromAcknowledgedDate, $toAcknowledgedDate, $page): \FriendsOfCE\Channel\ApiClient\Model\CollectionOfMerchantOrderResponse

Get Orders By Filter.

Fetch orders based on the provided OrderFilter.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$statuses = array(new \FriendsOfCE\Channel\ApiClient\Model\\FriendsOfCE\Channel\ApiClient\Model\OrderStatusView()); // \FriendsOfCE\Channel\ApiClient\Model\OrderStatusView[] | Order status(es) to filter on. AWAITING_PAYMENT orders will be excluded if it is not included in this Statuses filter.
$emailAddresses = array('emailAddresses_example'); // string[] | Client emailaddresses to filter on.
$merchantOrderNos = array('merchantOrderNos_example'); // string[] | Filter on unique order reference used by the merchant.
$channelOrderNos = array('channelOrderNos_example'); // string[] | Filter on unique order reference used by the channel.
$fromDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the order date, starting from this date. This date is inclusive.<br />The order date is based on the data we got from a channel.
$toDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the order date, until this date. This date is exclusive.<br />The order date is based on the data we got from a channel.
$fromCreatedAtDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the created at date in ChannelEngine, starting from this date. This date is inclusive.<br />The created date is set on the date and time when the order is created.
$toCreatedAtDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the created at date in ChannelEngine, until this date. This date is exclusive.<br />The created date is set on the date and time when the order is created.
$excludeMarketplaceFulfilledOrdersAndLines = True; // bool | Exclude order (lines) fulfilled by the marketplace (amazon:FBA, bol:LVB, etc.)
$fulfillmentType = new \FriendsOfCE\Channel\ApiClient\Model\FulfillmentType(); // FulfillmentType | Filter orders on fulfillment type. This will include all orders lines, even if they are partially fulfilled by the marketplace.<br />To exclude orders and lines that are fulfilled by the marketplace from the response, set ExcludeMarketplaceFulfilledOrdersAndLines to true.
$onlyWithCancellationRequests = True; // bool | Filter on orders containing cancellation requests.<br />Some channels allow a customer to cancel an order until it has been shipped.<br />When an order has already been acknowledged in ChannelEngine, it can only be cancelled by creating a cancellation.
$channelIds = array(56); // int[] | Filter orders on channel(s).
$stockLocationIds = array(56); // int[] | Filter on stock locations
$isAcknowledged = True; // bool | Filter on acknowledged value
$fromUpdatedAtDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the order update date, starting from this date. This date is inclusive.
$toUpdatedAtDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the order update date, unitl this date. This date is exclusive.
$fromAcknowledgedDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the order acknowledged date, starting from this date. This date is inclusive.
$toAcknowledgedDate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Filter on the order acknowledged date, unitl this date. This date is exclusive.
$page = 56; // int | The page to filter on. Starts at 1.

try {
    $result = $apiInstance->orderGetByFilter($statuses, $emailAddresses, $merchantOrderNos, $channelOrderNos, $fromDate, $toDate, $fromCreatedAtDate, $toCreatedAtDate, $excludeMarketplaceFulfilledOrdersAndLines, $fulfillmentType, $onlyWithCancellationRequests, $channelIds, $stockLocationIds, $isAcknowledged, $fromUpdatedAtDate, $toUpdatedAtDate, $fromAcknowledgedDate, $toAcknowledgedDate, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderGetByFilter: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
statuses	\FriendsOfCE\Channel\ApiClient\Model\OrderStatusView[]	Order status(es) to filter on. AWAITING_PAYMENT orders will be excluded if it is not included in this Statuses filter.	[optional]
emailAddresses	string[]	Client emailaddresses to filter on.	[optional]
merchantOrderNos	string[]	Filter on unique order reference used by the merchant.	[optional]
channelOrderNos	string[]	Filter on unique order reference used by the channel.	[optional]
fromDate	\DateTime	Filter on the order date, starting from this date. This date is inclusive.<br />The order date is based on the data we got from a channel.	[optional]
toDate	\DateTime	Filter on the order date, until this date. This date is exclusive.<br />The order date is based on the data we got from a channel.	[optional]
fromCreatedAtDate	\DateTime	Filter on the created at date in ChannelEngine, starting from this date. This date is inclusive.<br />The created date is set on the date and time when the order is created.	[optional]
toCreatedAtDate	\DateTime	Filter on the created at date in ChannelEngine, until this date. This date is exclusive.<br />The created date is set on the date and time when the order is created.	[optional]
excludeMarketplaceFulfilledOrdersAndLines	bool	Exclude order (lines) fulfilled by the marketplace (amazon:FBA, bol:LVB, etc.)	[optional]
fulfillmentType	FulfillmentType	Filter orders on fulfillment type. This will include all orders lines, even if they are partially fulfilled by the marketplace.<br />To exclude orders and lines that are fulfilled by the marketplace from the response, set ExcludeMarketplaceFulfilledOrdersAndLines to true.	[optional]
onlyWithCancellationRequests	bool	Filter on orders containing cancellation requests.<br />Some channels allow a customer to cancel an order until it has been shipped.<br />When an order has already been acknowledged in ChannelEngine, it can only be cancelled by creating a cancellation.	[optional]
channelIds	int[]	Filter orders on channel(s).	[optional]
stockLocationIds	int[]	Filter on stock locations	[optional]
isAcknowledged	bool	Filter on acknowledged value	[optional]
fromUpdatedAtDate	\DateTime	Filter on the order update date, starting from this date. This date is inclusive.	[optional]
toUpdatedAtDate	\DateTime	Filter on the order update date, unitl this date. This date is exclusive.	[optional]
fromAcknowledgedDate	\DateTime	Filter on the order acknowledged date, starting from this date. This date is inclusive.	[optional]
toAcknowledgedDate	\DateTime	Filter on the order acknowledged date, unitl this date. This date is exclusive.	[optional]
page	int	The page to filter on. Starts at 1.	[optional]

Return type

\FriendsOfCE\Channel\ApiClient\Model\CollectionOfMerchantOrderResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`orderGetNew()`

orderGetNew($stockLocationId): \FriendsOfCE\Channel\ApiClient\Model\CollectionOfMerchantOrderResponse

Get New Orders.

Fetch newly placed orders (order with status NEW).

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$stockLocationId = 56; // int | The ChannelEngine id of the stock location.

try {
    $result = $apiInstance->orderGetNew($stockLocationId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderGetNew: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
stockLocationId	int	The ChannelEngine id of the stock location.	[optional]

Return type

\FriendsOfCE\Channel\ApiClient\Model\CollectionOfMerchantOrderResponse

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`orderInvoice()`

orderInvoice($merchantOrderNo, $useCustomerCulture): \SplFileObject

Download Invoice.

Generates the ChannelEngine VAT invoice for this order in PDF.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchantOrderNo = 'merchantOrderNo_example'; // string | The unique order reference as used by the merchant.
$useCustomerCulture = false; // bool | Generate the invoice in the billing address' country's language.

try {
    $result = $apiInstance->orderInvoice($merchantOrderNo, $useCustomerCulture);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderInvoice: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
merchantOrderNo	string	The unique order reference as used by the merchant.
useCustomerCulture	bool	Generate the invoice in the billing address' country's language.	[optional] [default to false]

Return type

\SplFileObject

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`orderPackingSlip()`

orderPackingSlip($merchantOrderNo, $useCustomerCulture): \SplFileObject

Download Packing Slip.

Generates the ChannelEngine packing slip for this order in PDF.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchantOrderNo = 'merchantOrderNo_example'; // string | The unique order reference as used by the merchant.
$useCustomerCulture = false; // bool | Generate the invoice in the billing address' country's language.

try {
    $result = $apiInstance->orderPackingSlip($merchantOrderNo, $useCustomerCulture);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderPackingSlip: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
merchantOrderNo	string	The unique order reference as used by the merchant.
useCustomerCulture	bool	Generate the invoice in the billing address' country's language.	[optional] [default to false]

Return type

\SplFileObject

Authorization

apiKey

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`orderUpdate()`

orderUpdate($merchantOrderCommentUpdateRequest): \FriendsOfCE\Channel\ApiClient\Model\ApiResponse

Update Comment.

Update the merchant comment for an order. Either the ChannelEngine order id or the
merchant order number can be used for updating a comment.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchantOrderCommentUpdateRequest = new \FriendsOfCE\Channel\ApiClient\Model\MerchantOrderCommentUpdateRequest(); // \FriendsOfCE\Channel\ApiClient\Model\MerchantOrderCommentUpdateRequest

try {
    $result = $apiInstance->orderUpdate($merchantOrderCommentUpdateRequest);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
merchantOrderCommentUpdateRequest	\FriendsOfCE\Channel\ApiClient\Model\MerchantOrderCommentUpdateRequest		[optional]

Return type

\FriendsOfCE\Channel\ApiClient\Model\ApiResponse

Authorization

apiKey

HTTP request headers

Content-Type: application/json-patch+json, application/json, application/*+json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`orderUploadInvoice()`

orderUploadInvoice($merchantOrderNo, $invoice, $invoiceNumber): \FriendsOfCE\Channel\ApiClient\Model\ApiResponse

Upload Invoice.

Upload merchant invoice for order.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: apiKey
$config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKey('apikey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = FriendsOfCE\Channel\ApiClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apikey', 'Bearer');


$apiInstance = new FriendsOfCE\Channel\ApiClient\Api\OrderApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$merchantOrderNo = 'merchantOrderNo_example'; // string | The unique order reference as used by the merchant.
$invoice = "/path/to/file.txt"; // \SplFileObject | PDF invoice file up to 1 MB with additional data.
$invoiceNumber = 'invoiceNumber_example'; // string | The invoice number used in the invoice.

try {
    $result = $apiInstance->orderUploadInvoice($merchantOrderNo, $invoice, $invoiceNumber);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrderApi->orderUploadInvoice: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
merchantOrderNo	string	The unique order reference as used by the merchant.
invoice	\SplFileObject\SplFileObject	PDF invoice file up to 1 MB with additional data.
invoiceNumber	string	The invoice number used in the invoice.	[optional]

Return type

\FriendsOfCE\Channel\ApiClient\Model\ApiResponse

Authorization

apiKey

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

OrderApi.md

Latest commit

History

OrderApi.md

File metadata and controls

FriendsOfCE\Channel\ApiClient\OrderApi

orderAcknowledge()

Example

Parameters

Return type

Authorization

HTTP request headers

orderGetByFilter()

Example

Parameters

Return type

Authorization

HTTP request headers

orderGetNew()

Example

Parameters

Return type

Authorization

HTTP request headers

orderInvoice()

Example

Parameters

Return type

Authorization

HTTP request headers

orderPackingSlip()

Example

Parameters

Return type

Authorization

HTTP request headers

orderUpdate()

Example

Parameters

Return type

Authorization

HTTP request headers

orderUploadInvoice()

Example

Parameters

Return type

Authorization

HTTP request headers

`orderAcknowledge()`

`orderGetByFilter()`

`orderGetNew()`

`orderInvoice()`

`orderPackingSlip()`

`orderUpdate()`

`orderUploadInvoice()`