### Install ChannelAdvisor Library using Composer

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

This command installs the ChannelAdvisor library using Composer, a dependency manager for PHP. Ensure Composer is installed and accessible in your environment.

```bash
composer require alldigitalrewards/channeladvisor
```

--------------------------------

### Product Management

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Provides examples for retrieving product information, including fetching all products with pagination and retrieving a single product by its ID.

```APIDOC
## Product Management

### Get All Products (Paginated)

Retrieve all products from the catalog with automatic pagination support. The API returns approximately 100 products per page.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $nextLink = null;
    $pageNumber = 0;

    while (true) {
        $productCollection = $client->getProducts($nextLink);
        $pageNumber++;

        echo "Page {$pageNumber}: " . count($productCollection) . " products\n";

        // Process each product in the collection
        foreach ($productCollection as $product) {
            echo "SKU: " . $product->getSku() . "\n";
            echo "Title: " . $product->getTitle() . "\n";
            echo "Price: $" . $product->getRetailPrice() . "\n";
            echo "Quantity: " . $product->getTotalAvailableQuantity() . "\n";
            echo "---\n";
        }

        // Check if this is the last page
        if ($productCollection->isLastPage()) {
            echo "Finished processing all products.\n";
            break;
        }

        // Get the next page link
        $nextLink = $productCollection->getNextLink();
    }
} catch (ApiException $e) {
    echo "API Error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}
```

### Get Single Product

Retrieve a specific product by its ChannelAdvisor product ID.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $product = $client->getProduct('6200111');

    echo "Product ID: " . $product->getId() . "\n";
    echo "SKU: " . $product->getSku() . "\n";
    echo "Title: " . $product->getTitle() . "\n";
    echo "Description: " . $product->getDescription() . "\n";
    echo "Brand: " . $product->getBrand() . "\n";
    echo "Condition: " . $product->getCondition() . "\n";
    echo "Retail Price: $" . $product->getRetailPrice() . "\n";
    echo "Buy It Now Price: $" . $product->getBuyItNowPrice() . "\n";
    echo "Total Quantity: " . $product->getTotalQuantity() . "\n";
    echo "Available Quantity: " . $product->getTotalAvailableQuantity() . "\n";
    echo "UPC: " . $product->getUPC() . "\n";
    echo "ASIN: " . $product->getASIN() . "\n";
    echo "Is Blocked: " . ($product->isBlocked() ? 'Yes' : 'No') . "\n";
} catch (ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}
```
```

--------------------------------

### Get Product Images

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves all images associated with a specific product identified by its ID.

```APIDOC
## GET /products/{productId}/images

### Description
Retrieves all images associated with a specific product. Requires the product ID.

### Method
GET

### Endpoint
/products/{productId}/images

### Path Parameters
- **productId** (string) - Required - The unique identifier of the product.

### Request Example
```php
// Example using the client library
$client->getProductImages('123456789');
```

### Response
#### Success Response (200)
- **imageCollection** (Array<Image>) - A collection of image objects associated with the product.
  - **url** (string) - The URL of the image.
  - **placementName** (string) - The name of the image placement (e.g., 'Main', 'Alternate').

#### Response Example
```json
[
  {
    "url": "http://example.com/image1.jpg",
    "placementName": "Main"
  },
  {
    "url": "http://example.com/image2.jpg",
    "placementName": "Alternate"
  }
]
```
```

--------------------------------

### Create ChannelAdvisor Client using Factory

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Obtains an instance of the ChannelAdvisor client using a factory method. This approach leverages environment variables for authentication credentials, simplifying client setup when these variables are pre-configured.

```php
<?php
$client = \AllDigitalRewards\ChannelAdvisor\ClientFactory::getClient();
```

--------------------------------

### Get Products Updated After Date

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Fetches products that have been modified since a specific date and time. Supports pagination.

```APIDOC
## GET /products/updated-after

### Description
Fetches products that have been modified since a specific date/time. This endpoint supports pagination to retrieve large datasets.

### Method
GET

### Endpoint
/products/updated-after

### Query Parameters
- **startDate** (DateTime) - Required - The date and time from which to retrieve updated products.

### Request Example
```php
// Example using the client library
$client->getProductsUpdatedAfter(new DateTime('-1 day', new DateTimeZone('UTC')));
```

### Response
#### Success Response (200)
- **productCollection** (Array<Product>) - A collection of product objects updated after the specified date.
  - **sku** (string) - The stock keeping unit of the product.
  - **updateDateUtc** (DateTime) - The date and time the product was last updated in UTC.

#### Response Example
```json
[
  {
    "sku": "SKU123",
    "updateDateUtc": "2023-10-27T10:00:00Z"
  },
  {
    "sku": "SKU456",
    "updateDateUtc": "2023-10-27T11:30:00Z"
  }
]
```
```

--------------------------------

### Get All Fulfillments from ChannelAdvisor

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves a list of all fulfillment records from ChannelAdvisor. Requires a valid client instance.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

$fulfillments = $client->getFulfillments();

if ($fulfillments !== null) {
    foreach ($fulfillments as $fulfillment) {
        echo "Fulfillment ID: " . $fulfillment->getID() . "\n";
        echo "Order ID: " . $fulfillment->getOrderID() . "\n";
        echo "Tracking: " . $fulfillment->getTrackingNumber() . "\n";
        echo "Carrier: " . $fulfillment->getShippingCarrier() . "\n";
        echo "Status: " . $fulfillment->getDeliveryStatus() . "\n";
        echo "Shipped Date: " . $fulfillment->getShippedDateUtc() . "\n";
        echo "---\n";
    }
} else {
    echo "No fulfillments found.\n";
}
?>
```

--------------------------------

### Get All Products Paginated with ChannelAdvisor PHP Library

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves all products from the ChannelAdvisor catalog with automatic pagination. The library handles fetching subsequent pages until all products are retrieved. It includes error handling for API exceptions.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $nextLink = null;
    $pageNumber = 0;

    while (true) {
        $productCollection = $client->getProducts($nextLink);
        $pageNumber++;

        echo "Page {$pageNumber}: " . count($productCollection) . " products\n";

        // Process each product in the collection
        foreach ($productCollection as $product) {
            echo "SKU: " . $product->getSku() . "\n";
            echo "Title: " . $product->getTitle() . "\n";
            echo "Price: $" . $product->getRetailPrice() . "\n";
            echo "Quantity: " . $product->getTotalAvailableQuantity() . "\n";
            echo "---\n";
        }

        // Check if this is the last page
        if ($productCollection->isLastPage()) {
            echo "Finished processing all products.\n";
            break;
        }

        // Get the next page link
        $nextLink = $productCollection->getNextLink();
    }
} catch (ApiException $e) {
    echo "API Error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Bulk Product Export Request (PHP)

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Initiates an asynchronous bulk export of products, specifically those with a quantity greater than zero. The code demonstrates how to start the export, retrieve an export token, and then poll for the status of the export request until it completes or reaches a maximum number of attempts. Requires the AllDigitalRewards ChannelAdvisor client library.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    // Start the bulk export request
    $request = $client->bulkProductsRequest();

    echo "Export Token: " . $request->getToken() . "\n";
    echo "Status: " . $request->getStatus() . "\n";
    echo "Started: " . $request->getStartedOnUtc() . "\n";

    // Poll for completion (in production, use a queue or scheduled task)
    $token = $request->getToken();
    $maxAttempts = 10;
    $attempt = 0;

    while ($attempt < $maxAttempts) {
        sleep(30); // Wait 30 seconds between checks
        $attempt++;

        $status = $client->bulkProductRequestStatus($token);
        echo "Attempt {$attempt} - Status: " . $status->getStatus() . "\n";

        if ($status->getStatus() === 'Complete') {
            echo "Download URL: " . $status->getResponseFileUrl() . "\n";
            break;
        }
    }
} catch (ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Get All ChannelAdvisor Orders with Pagination using PHP

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves all orders from ChannelAdvisor with support for pagination. It iterates through results until the last page is reached. Requires API credentials and handles potential API errors.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $nextLink = null;

    do {
        $orderCollection = $client->getOrders($nextLink);

        foreach ($orderCollection as $order) {
            echo "Order #" . $order->getId() . " - ";
            echo $order->getBuyerEmailAddress() . " - ";
            echo "$" . $order->getTotalPrice() . " - ";
            echo "Status: " . $order->getShippingStatus() . "\n";
        }

        $nextLink = $orderCollection->getNextLink();

    } while (!$orderCollection->isLastPage());

} catch (ApiException $e) {
    echo "Error fetching orders: " . $e->getMessage() . "\n";
}

```

--------------------------------

### Get Exported/Unexported Orders from ChannelAdvisor

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves orders based on their export status. Useful for processing unexported orders or reviewing exported ones. Requires a valid client instance.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

// Get unexported orders (for processing)
$unexportedOrders = $client->getExportedOrders(false);

if ($unexportedOrders !== null) {
    echo "Unexported Orders:\n";
    foreach ($unexportedOrders as $order) {
        echo "Order #" . $order->getId() . " - $" . $order->getTotalPrice() . "\n";

        // Process order...

        // Mark as exported after processing
        $client->exportOrder($order->getId());
    }
} else {
    echo "No unexported orders found.\n";
}

// Get already exported orders
$exportedOrders = $client->getExportedOrders(true);

if ($exportedOrders !== null) {
    echo "\nExported Orders: " . count($exportedOrders) . "\n";
}
?>
```

--------------------------------

### Get Fulfillment by Order ID from ChannelAdvisor

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves detailed fulfillment information for a specific order, including line item details. Requires a valid client instance and the order ID.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

$orderId = 123456789;
$fulfillmentCollection = $client->getFulfillment($orderId);

if ($fulfillmentCollection !== null) {
    foreach ($fulfillmentCollection as $fulfillment) {
        echo "Fulfillment ID: " . $fulfillment->getID() . "\n";
        echo "Order ID: " . $fulfillment->getOrderID() . "\n";
        echo "Type: " . $fulfillment->getType() . "\n";
        echo "Delivery Status: " . $fulfillment->getDeliveryStatus() . "\n";
        echo "Tracking Number: " . $fulfillment->getTrackingNumber() . "\n";
        echo "Shipping Carrier: " . $fulfillment->getShippingCarrier() . "\n";
        echo "Shipping Class: " . $fulfillment->getShippingClass() . "\n";
        echo "Shipping Cost: $" . $fulfillment->getShippingCost() . "\n";
        echo "Shipped Date: " . $fulfillment->getShippedDateUtc() . "\n";

        // Access fulfillment items
        $items = $fulfillment->getItems();
        if ($items) {
            echo "Items:\n";
            foreach ($items as $item) {
                print_r($item);
            }
        }
        echo "---\n";
    }
} else {
    echo "No fulfillment found for order {$orderId}.\n";
    print_r($client->getErrors());
}
?>
```

--------------------------------

### Get Product Images (PHP)

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves all images associated with a specific product SKU. The code iterates through the returned image collection, printing the URL and placement of each image. It also includes error handling for cases where no images are found or an API error occurs. Requires the AllDigitalRewards ChannelAdvisor client library.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $imageCollection = $client->getProductImages('123456789');

    echo "Found " . count($imageCollection) . " images:\n";

    foreach ($imageCollection as $image) {
        echo "Image URL: " . $image->getUrl() . "\n";
        echo "Placement: " . $image->getPlacementName() . "\n";
        echo "---\n";
    }
} catch (ApiException $e) {
    echo "No images available or error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Get ChannelAdvisor Order Items by Order ID with PHP

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Fetches and displays the line items for a specific ChannelAdvisor order. Requires API credentials and the order ID. Outputs SKU, quantity, and unit price for each item, or an error message.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $orderItems = $client->getOrderItems(987654321);

    echo "Order Items:\n";
    foreach ($orderItems as $item) {
        echo "SKU: " . $item->getSku() . "\n";
        echo "Quantity: " . $item->getQuantity() . "\n";
        echo "Unit Price: $" . $item->getUnitPrice() . "\n";
        echo "---\n";
    }
} catch (ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Get Products Updated After Date (PHP)

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Fetches products that have been modified since a specified date and time. It handles potential API errors and includes logic for paginating through results if there are many updated products. Requires the AllDigitalRewards ChannelAdvisor client library.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    // Get products updated in the last 24 hours
    $yesterday = new DateTime('-1 day', new DateTimeZone('UTC'));
    $productCollection = $client->getProductsUpdatedAfter($yesterday);

    echo "Products updated since " . $yesterday->format('Y-m-d H:i:s') . " UTC:\n";

    foreach ($productCollection as $product) {
        echo "SKU: " . $product->getSku() . " - Updated: " . $product->getUpdateDateUtc() . "\n";
    }

    // Handle pagination if needed
    while (!$productCollection->isLastPage()) {
        $productCollection = $client->getProducts($productCollection->getNextLink());
        foreach ($productCollection as $product) {
            echo "SKU: " . $product->getSku() . " - Updated: " . $product->getUpdateDateUtc() . "\n";
        }
    }
} catch (ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
}

```

--------------------------------

### Get Single Product by ID with ChannelAdvisor PHP Library

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves a specific product from ChannelAdvisor using its unique product ID. This function demonstrates how to fetch detailed information for a single product and includes error handling for API requests.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $product = $client->getProduct('6200111');

    echo "Product ID: " . $product->getId() . "\n";
    echo "SKU: " . $product->getSku() . "\n";
    echo "Title: " . $product->getTitle() . "\n";
    echo "Description: " . $product->getDescription() . "\n";
    echo "Brand: " . $product->getBrand() . "\n";
    echo "Condition: " . $product->getCondition() . "\n";
    echo "Retail Price: $" . $product->getRetailPrice() . "\n";
    echo "Buy It Now Price: $" . $product->getBuyItNowPrice() . "\n";
    echo "Total Quantity: " . $product->getTotalQuantity() . "\n";
    echo "Available Quantity: " . $product->getTotalAvailableQuantity() . "\n";
    echo "UPC: " . $product->getUPC() . "\n";
    echo "ASIN: " . $product->getASIN() . "\n";
    echo "Is Blocked: " . ($product->isBlocked() ? 'Yes' : 'No') . "\n";
} catch (ApiException $e) {
    echo "Error: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Get ChannelAdvisor Order by ID with PHP

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Retrieves a specific order from ChannelAdvisor using its unique ID. Requires API credentials and the order ID. Outputs detailed order information or a 'not found' message.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

$orderId = 987654321;
$order = $client->getOrder($orderId);

if ($order !== null) {
    echo "Order ID: " . $order->getId() . "\n";
    echo "Site Order ID: " . $order->getSiteOrderID() . "\n";
    echo "Buyer Email: " . $order->getBuyerEmailAddress() . "\n";
    echo "Total Price: $" . $order->getTotalPrice() . "\n";
    echo "Shipping Status: " . $order->getShippingStatus() . "\n";
    echo "Payment Status: " . $order->getPaymentStatus() . "\n";
    echo "Created: " . $order->getCreateDateUtc() . "\n";

    // Shipping address
    echo "\nShipping Address:\n";
    echo $order->getShippingFirstName() . " " . $order->getShippingLastName() . "\n";
    echo $order->getShippingAddressLine1() . "\n";
    if ($order->getShippingAddressLine2()) {
        echo $order->getShippingAddressLine2() . "\n";
    }
    echo $order->getShippingCity() . ", " . $order->getShippingStateOrProvince() . " " . $order->getShippingPostalCode() . "\n";
} else {
    echo "Order not found.\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Client Initialization

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Demonstrates how to initialize the ChannelAdvisor client using either direct constructor arguments or a factory method with environment variables.

```APIDOC
## Client Initialization

### Create Client with Constructor

Initialize the ChannelAdvisor client by providing OAuth credentials and profile ID directly to the constructor.

```php
<?php
require __DIR__ . '/vendor/autoload.php';

use AllDigitalRewards\ChannelAdvisor\Client;

// Create client with explicit credentials
$client = new Client(
    "your_refresh_token",      // OAuth refresh token from ChannelAdvisor
    "your_application_id",     // Application ID from developer console
    "your_shared_secret",      // Shared secret from developer console
    123456789                  // ChannelAdvisor Profile ID
);

// The client automatically handles access token retrieval and refresh
// You can now use $client to make API calls
```

### Create Client with Factory

Use the ClientFactory to instantiate the client when credentials are stored in environment variables.

```php
<?php
require __DIR__ . '/vendor/autoload.php';

use AllDigitalRewards\ChannelAdvisor\ClientFactory;

// Set environment variables before calling the factory:
// CHANNELADVISOR_REFRESH_TOKEN
// CHANNELADVISOR_APPLICATION_ID
// CHANNELADVISOR_SHARED_SECRET
// CHANNELADVISOR_PROFILE_ID

try {
    $client = ClientFactory::getClient();
    // Client is ready to use
} catch (Exception $e) {
    echo "Failed to create client: " . $e->getMessage();
}
```
```

--------------------------------

### Sample Configuration for Creating a ChannelAdvisor Order

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Provides a sample array structure for configuring a new order in ChannelAdvisor. This includes essential details like profile ID, order identifiers, pricing, buyer information, shipping details, and line items.

```bash
$sampleOrderConfig = [
    "ProfileID" => 123456789, //Identifies the ChannelAdvisor profile
    "SiteOrderID" => "123456789-12341234", // This should be the Transaction GUID
    "TotalPrice" => 38.41,
    "BuyerEmailAddress" => "jmuto@alldigitalrewards.com",
    "ShippingTitle" => "Mr.",
    "ShippingFirstName" => "Joseph",
    "ShippingLastName" => "Muto",
    "ShippingSuffix" => null,
    "ShippingCompanyName" => null,
    "ShippingCompanyJobTitle" => null,
    "ShippingDaytimePhone" => "123456789",
    "ShippingEveningPhone" => null,
    "ShippingAddressLine1" => "935 Bungalow Ave",
    "ShippingAddressLine2" => "",
    "ShippingCity" => "Winter Park",
    "ShippingStateOrProvince" => "FL",
    "ShippingPostalCode" => "32789",
    "Items" => [
        [
            "Sku" => "72539",
            "Quantity" => 1,
            "UnitPrice" => 38.41,
        ]
    ]
]
```

--------------------------------

### Create ChannelAdvisor Client using Constructor

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Instantiates the ChannelAdvisor client by directly passing authentication credentials and profile ID to the constructor. This method requires explicit provision of all necessary tokens and IDs.

```php
<?php
$client = new \AllDigitalRewards\ChannelAdvisor\Client(
    "REFRESH_TOKEN",
    "APPLICATION_ID",
    "SHARED_SECRET",
    123456789
);
```

--------------------------------

### Initialize ChannelAdvisor Client with Factory

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Instantiates the ChannelAdvisor client using the ClientFactory when credentials are stored in environment variables. This approach enhances security by avoiding hardcoded credentials. Ensure the required environment variables are set before execution.

```php
<?php
require __DIR__ . '/vendor/autoload.php';

use AllDigitalRewards\ChannelAdvisor\ClientFactory;

// Set environment variables before calling the factory:
// CHANNELADVISOR_REFRESH_TOKEN
// CHANNELADVISOR_APPLICATION_ID
// CHANNELADVISOR_SHARED_SECRET
// CHANNELADVISOR_PROFILE_ID

try {
    $client = ClientFactory::getClient();
    // Client is ready to use
} catch (Exception $e) {
    echo "Failed to create client: " . $e->getMessage();
}

```

--------------------------------

### Initialize ChannelAdvisor Client with Constructor

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Initializes the ChannelAdvisor client by providing OAuth credentials and profile ID directly to the constructor. This method is suitable when credentials are known and available at runtime. It automatically handles token retrieval and refresh.

```php
<?php
require __DIR__ . '/vendor/autoload.php';

use AllDigitalRewards\ChannelAdvisor\Client;

// Create client with explicit credentials
$client = new Client(
    "your_refresh_token",      // OAuth refresh token from ChannelAdvisor
    "your_application_id",     // Application ID from developer console
    "your_shared_secret",      // Shared secret from developer console
    123456789                  // ChannelAdvisor Profile ID
);

// The client automatically handles access token retrieval and refresh
// You can now use $client to make API calls

```

--------------------------------

### Run Tests using Composer

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Executes the test suite for the ChannelAdvisor library using Composer. This command is typically defined in the project's `composer.json` file under the `scripts` section.

```bash
$ composer test
```

--------------------------------

### Bulk Product Export Request

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Initiates an asynchronous bulk export of products. Returns a token to track the export status.

```APIDOC
## POST /products/export/bulk

### Description
Initiates a bulk export of all products with quantity greater than zero. This is an asynchronous operation. A token is returned to poll for the export status and download URL.

### Method
POST

### Endpoint
/products/export/bulk

### Query Parameters
- **quantityGreaterThan** (integer) - Optional - Filters products to export only those with quantity greater than this value. Defaults to 0.

### Request Example
```php
// Example using the client library
$request = $client->bulkProductsRequest();
```

### Response
#### Success Response (200)
- **token** (string) - A unique token to track the status of the bulk export.
- **status** (string) - The initial status of the export request (e.g., 'Pending').
- **startedOnUtc** (DateTime) - The date and time the export request was initiated in UTC.

#### Response Example
```json
{
  "token": "EXPORT_TOKEN_XYZ",
  "status": "Pending",
  "startedOnUtc": "2023-10-27T12:00:00Z"
}
```

## GET /products/export/status/{token}

### Description
Retrieves the status of a bulk product export request using the provided token. If the export is complete, it includes the download URL.

### Method
GET

### Endpoint
/products/export/status/{token}

### Path Parameters
- **token** (string) - Required - The token obtained from the bulk product export request.

### Response
#### Success Response (200)
- **status** (string) - The current status of the export (e.g., 'Processing', 'Complete', 'Failed').
- **responseFileUrl** (string, optional) - The URL to download the exported file if the status is 'Complete'.

#### Response Example
```json
{
  "status": "Complete",
  "responseFileUrl": "http://example.com/exports/products_20231027.csv"
}
```
```

--------------------------------

### Fetch All Products Paginated using ProductFetcher

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Retrieves products from ChannelAdvisor in a paginated manner using the ProductFetcher. The loop continues fetching pages until the last page is reached, processing each collection of products.

```php
<?php
$productFetcher = new \AllDigitalRewards\ChannelAdvisor\ProductFetcher($client);
$next_link = null;
$counter = 0;

while(true) {
    $productCollection = $productFetcher->getProducts($next_link);

    // Do something with this page of products...
    // There should be about 100 products in the collection.
    echo count($productCollection) . " in collection {$counter}.
";

    if($productCollection->isLastPage()) {
        // We're done iterating, break the cipher.
        break 1;
    }

    $next_link = $productCollection->getNextLink();
}

```

--------------------------------

### Handle API Errors and Exceptions in PHP

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Demonstrates how to catch and handle various exceptions including API errors, client-level errors, and general exceptions when interacting with the ChannelAdvisor API. It also shows how to retrieve detailed error messages after an operation fails.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;
use AllDigitalRewards\ChannelAdvisor\ClientException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

try {
    $product = $client->getProduct('invalid-id');
} catch (ApiException $e) {
    // API-level errors (invalid requests, not found, etc.)
    echo "API Error: " . $e->getMessage() . "\n";

    // Get detailed error information
    $errors = $client->getErrors();
    foreach ($errors as $error) {
        echo "Detail: " . $error . "\n";
    }
} catch (ClientException $e) {
    // Client-level errors (authentication, configuration, etc.)
    echo "Client Error: " . $e->getMessage() . "\n";
} catch (Exception $e) {
    // General exceptions (network issues, etc.)
    echo "General Error: " . $e->getMessage() . "\n";
}

// Alternative: Check errors after operations that return null on failure
$order = $client->getOrder(999999999);
if ($order === null) {
    $errors = $client->getErrors();
    if (!empty($errors)) {
        echo "Failed to retrieve order:\n";
        foreach ($errors as $error) {
            echo "- " . $error . "\n";
        }
    }
}

```

--------------------------------

### Check Code Style with Composer

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Verifies the code against PSR2 coding standards using Composer. This command helps ensure code consistency and adherence to project style guidelines before submitting changes.

```bash
$ composer check-style
```

--------------------------------

### Create ChannelAdvisor Order with PHP

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Creates a new order in ChannelAdvisor, including shipping details and line items. Requires ChannelAdvisor API credentials and specific order data. Outputs success or error messages with order details.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;
use AllDigitalRewards\ChannelAdvisor\ApiException;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

$orderData = [
    "ProfileID" => 123456789,                              // ChannelAdvisor profile ID
    "SiteOrderID" => "ORD-" . uniqid(),                   // Your unique order identifier
    "TotalPrice" => 99.99,                                 // Order total
    "BuyerEmailAddress" => "customer@example.com",
    "ShippingTitle" => "Mr.",
    "ShippingFirstName" => "John",
    "ShippingLastName" => "Doe",
    "ShippingSuffix" => null,
    "ShippingCompanyName" => "Acme Corp",
    "ShippingCompanyJobTitle" => null,
    "ShippingDaytimePhone" => "555-123-4567",
    "ShippingEveningPhone" => null,
    "ShippingAddressLine1" => "123 Main Street",
    "ShippingAddressLine2" => "Suite 100",
    "ShippingCity" => "Los Angeles",
    "ShippingStateOrProvince" => "CA",
    "ShippingPostalCode" => "90001",
    "Items" => [
        [
            "Sku" => "PROD-001",
            "Quantity" => 2,
            "UnitPrice" => 29.99,
        ],
        [
            "Sku" => "PROD-002",
            "Quantity" => 1,
            "UnitPrice" => 40.01,
        ]
    ]
];

try {
    $order = $client->createOrder($orderData);

    echo "Order Created Successfully!\n";
    echo "Order ID: " . $order->getId() . "\n";
    echo "Site Order ID: " . $order->getSiteOrderID() . "\n";
    echo "Total Price: $" . $order->getTotalPrice() . "\n";
    echo "Checkout Status: " . $order->getCheckoutStatus() . "\n";
    echo "Payment Status: " . $order->getPaymentStatus() . "\n";

    // Access full order data as array
    print_r($order->toArray());
} catch (ApiException $e) {
    echo "Failed to create order: " . $e->getMessage() . "\n";
    print_r($client->getErrors());
}

```

--------------------------------

### Fix Code Style Issues with Composer

Source: https://github.com/alldigitalrewards/channeladvisor/blob/master/README.md

Automatically formats the code to comply with PSR2 coding standards. This command can be used to resolve style issues identified by `composer check-style`.

```bash
$ composer fix-style
```

--------------------------------

### Export Order to ChannelAdvisor

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Marks an order as exported in ChannelAdvisor to prevent it from being processed again. Requires a valid client instance.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

$orderId = 12345678;
$exported = $client->exportOrder($orderId);

if ($exported) {
    echo "Order {$orderId} successfully marked as exported.\n";
} else {
    echo "Failed to export order.\n";
    print_r($client->getErrors());
}
?>
```

--------------------------------

### Cancel Order in ChannelAdvisor

Source: https://context7.com/alldigitalrewards/channeladvisor/llms.txt

Cancels an existing order in ChannelAdvisor by adjusting its status. Requires a valid client instance and the order ID.

```php
<?php
use AllDigitalRewards\ChannelAdvisor\Client;

$client = new Client("REFRESH_TOKEN", "APPLICATION_ID", "SHARED_SECRET", 123456789);

$orderId = 1234567;
$cancelled = $client->cancelOrder($orderId);

if ($cancelled) {
    echo "Order {$orderId} has been cancelled successfully.\n";
} else {
    echo "Failed to cancel order.\n";
    print_r($client->getErrors());
}
?>
```

=== COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.