This interface describes all endpoints regarding the shipment domain.
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.1.0
- Package version: v1.0
- Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen
PHP 5.5 and later
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "git",
"url": "http://github.com/gisevevokoru/ezze-siftuz-shipments-v1.git"
}
],
"require": {
"gisevevokoru/ezze-siftuz-shipments-v1": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
To run the unit tests:
composer install
./vendor/bin/phpunit
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$apiInstance = new EzzeSiftuz\ShipmentsV1\Api\ShipmentsApi(
// 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()
);
$body = array(new \EzzeSiftuz\ShipmentsV1\Model\PositionItem()); // \EzzeSiftuz\ShipmentsV1\Model\PositionItem[] | The position items included in shipment.
$carrier = "carrier_example"; // string | The carrier of the shipment.
$tracking_number = "tracking_number_example"; // string | The tracking number of the shipment assigned by the carrier.
try {
$apiInstance->appendPositionItemsByCarrierAndTrackingNumberUsingPOST($body, $carrier, $tracking_number);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->appendPositionItemsByCarrierAndTrackingNumberUsingPOST: ', $e->getMessage(), PHP_EOL;
}
$apiInstance = new EzzeSiftuz\ShipmentsV1\Api\ShipmentsApi(
// 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()
);
$body = array(new \EzzeSiftuz\ShipmentsV1\Model\PositionItem()); // \EzzeSiftuz\ShipmentsV1\Model\PositionItem[] | positionItems
$shipment_id = "shipment_id_example"; // string | Internal shipment identifier assigned by OTTO Market.
try {
$apiInstance->appendPositionItemsUsingPOST($body, $shipment_id);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->appendPositionItemsUsingPOST: ', $e->getMessage(), PHP_EOL;
}
$apiInstance = new EzzeSiftuz\ShipmentsV1\Api\ShipmentsApi(
// 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()
);
$body = new \EzzeSiftuz\ShipmentsV1\Model\CreateShipmentRequest(); // \EzzeSiftuz\ShipmentsV1\Model\CreateShipmentRequest | request
try {
$result = $apiInstance->createdAndSentShipmentUsingPOST($body);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->createdAndSentShipmentUsingPOST: ', $e->getMessage(), PHP_EOL;
}
$apiInstance = new EzzeSiftuz\ShipmentsV1\Api\ShipmentsApi(
// 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()
);
$datefrom = "datefrom_example"; // string | Shipments created from this date onwards for the given authorized partner will be returned. The date is considered as UTC.
$limit = 25; // int | The maximum number of shipments to be returned in each response.
$next = "next_example"; // string | The cursor which points to the next shipment that should be queried. It is used to paginate the results.
try {
$result = $apiInstance->listShipmentsUsingGET($datefrom, $limit, $next);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->listShipmentsUsingGET: ', $e->getMessage(), PHP_EOL;
}
$apiInstance = new EzzeSiftuz\ShipmentsV1\Api\ShipmentsApi(
// 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()
);
$carrier = "carrier_example"; // string | The carrier of the shipment.
$tracking_number = "tracking_number_example"; // string | The tracking number of the shipment assigned by the carrier.
try {
$result = $apiInstance->shipmentByCarrierAndTrackingNumberUsingGET($carrier, $tracking_number);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->shipmentByCarrierAndTrackingNumberUsingGET: ', $e->getMessage(), PHP_EOL;
}
$apiInstance = new EzzeSiftuz\ShipmentsV1\Api\ShipmentsApi(
// 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()
);
$shipment_id = "shipment_id_example"; // string | Internal shipment identifier assigned by OTTO Market.
try {
$result = $apiInstance->shipmentUsingGET($shipment_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ShipmentsApi->shipmentUsingGET: ', $e->getMessage(), PHP_EOL;
}
?>
All URIs are relative to https://live.api.otto.market
Class | Method | HTTP request | Description |
---|---|---|---|
ShipmentsApi | appendPositionItemsByCarrierAndTrackingNumberUsingPOST | POST /v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber}/positionitems | |
ShipmentsApi | appendPositionItemsUsingPOST | POST /v1/shipments/{shipmentId}/positionitems | |
ShipmentsApi | createdAndSentShipmentUsingPOST | POST /v1/shipments | |
ShipmentsApi | listShipmentsUsingGET | GET /v1/shipments | |
ShipmentsApi | shipmentByCarrierAndTrackingNumberUsingGET | GET /v1/shipments/carriers/{carrier}/trackingnumbers/{trackingNumber} | |
ShipmentsApi | shipmentUsingGET | GET /v1/shipments/{shipmentId} |
- Address
- BadRequest
- BadRequestAddPositionItemByShipmentId
- BadRequestAddPositionItemByTrackingNumber
- Conflict
- ConflictAddPositionItemByShipmentId
- ConflictAddPositionItemByTrackingNumber
- CreateShipmentRequest
- CreateShipmentResponse
- ErrorDescription
- ForbiddenGetShipmentByShipmentId
- ForbiddenGetShipmentByTrackingNumber
- InternalServerError
- InternalServerErrorAddPositionItemByShipmentId
- InternalServerErrorAddPositionItemByTrackingNumber
- InternalServerErrorGetShipmentByShipmentId
- InternalServerErrorGetShipmentByTrackingNumber
- InternalServerErrorGetShipmentList
- Link
- NotFoundAddPositionItemByShipmentId
- NotFoundAddPositionItemByTrackingNumber
- NotFoundGetShipmentByShipmentId
- NotFoundGetShipmentByTrackingNumber
- PositionItem
- ReturnTrackingKey
- Shipment
- ShipmentList
- ShipmentWithMinimumDetails
- TrackingKey
- Unauthenticated
All endpoints do not require authorization.