ShipmentApi.md

Swagger\Client\ShipmentApi

All URIs are relative to https://demo.channelengine.net/api

Method	HTTP request	Description
shipmentCreate	POST /v2/shipments	Mark (part of) an order as shipped.
shipmentGet	GET /v2/shipments/{merchantReference}	Get a shipment by its merchant reference.
shipmentIndex	GET /v2/shipments	Gets all shipments created since the supplied date.

shipmentCreate

\Swagger\Client\Model\ShipmentViewModel shipmentCreate($model)

Mark (part of) an order as shipped.

Example

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

$api_instance = new Swagger\Client\Api\ShipmentApi();
$model = new \Swagger\Client\Model\ShipmentViewModel(); // \Swagger\Client\Model\ShipmentViewModel | 

try {
    $result = $api_instance->shipmentCreate($model);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
model	\Swagger\Client\Model\ShipmentViewModel

Return type

\Swagger\Client\Model\ShipmentViewModel

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json, text/json, text/xml, application/x-www-form-urlencoded
• Accept: application/json, text/json, text/xml

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

shipmentGet

\Swagger\Client\Model\ShipmentViewModel shipmentGet($merchant_reference)

Get a shipment by its merchant reference.

Example

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

$api_instance = new Swagger\Client\Api\ShipmentApi();
$merchant_reference = "merchant_reference_example"; // string | The unique shipment reference supplied by the merchant

try {
    $result = $api_instance->shipmentGet($merchant_reference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
merchant_reference	string	The unique shipment reference supplied by the merchant

Return type

\Swagger\Client\Model\ShipmentViewModel

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, text/xml

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

shipmentIndex

\Swagger\Client\Model\ShipmentViewModel[] shipmentIndex($created_since)

Gets all shipments created since the supplied date.

Example

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

$api_instance = new Swagger\Client\Api\ShipmentApi();
$created_since = new \DateTime(); // \DateTime | 

try {
    $result = $api_instance->shipmentIndex($created_since);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ShipmentApi->shipmentIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
created_since	\DateTime

Return type

\Swagger\Client\Model\ShipmentViewModel[]

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/json, text/xml

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