gisevevokoru / ezze-siftuz-shipments-v1
dev-master
2021-10-26 03:56 UTC
Requires
- php: >=5.5
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^6.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ~1.12
- phpunit/phpunit: ^4.8
- squizlabs/php_codesniffer: ~2.6
This package is auto-updated.
Last update: 2024-09-26 10:14:24 UTC
README
本界面描述了与运输领域相关的所有端点。
此PHP包由Swagger Codegen项目自动生成,具体信息请访问Swagger Codegen。
- API版本:1.1.0
- 包版本:v1.0
- 构建包:io.swagger.codegen.v3.generators.php.PhpClientCodegen
要求
PHP 5.5 及以上版本
安装与使用
Composer
要使用Composer安装绑定,请将以下内容添加到 composer.json
{
"repositories": [
{
"type": "git",
"url": "http://github.com/gisevevokoru/ezze-siftuz-shipments-v1.git"
}
],
"require": {
"gisevevokoru/ezze-siftuz-shipments-v1": "*@dev"
}
}
然后运行 composer install
手动安装
下载文件并包含 autoload.php
require_once('/path/to/SwaggerClient-php/vendor/autoload.php');
测试
要运行单元测试
composer install
./vendor/bin/phpunit
入门
请按照安装流程进行操作,然后运行以下命令
<?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; } ?>
API端点文档
所有URI都是相对于 https://live.api.otto.market
模型文档
- 地址
- 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
授权文档
所有端点都不需要授权。