README

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: io.swagger.codegen.v3.generators.php.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "http://github.com/nethead-co/otto-php-client.git"
    }
  ],
  "require": {
    "nethead-co/otto-php-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/otto-php-client/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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


$apiInstance = new Otto\Client\Api\OrdersV4Api(
    // 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
);
$sales_order_id = "sales_order_id_example"; // string | The salesOrderId of the order
$position_item_id = array("position_item_id_example"); // string[] | The positionItemIds of the order to cancel

try {
    $apiInstance->ordersV4CancelPartnerOrderPositionItems($sales_order_id, $position_item_id);
} catch (Exception $e) {
    echo 'Exception when calling OrdersV4Api->ordersV4CancelPartnerOrderPositionItems: ', $e->getMessage(), PHP_EOL;
}


$apiInstance = new Otto\Client\Api\OrdersV4Api(
    // 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
);
$sales_order_id = array("sales_order_id_example"); // string[] | The salesOrderIds of the orders to cancel

try {
    $apiInstance->ordersV4CancelPartnerOrders($sales_order_id);
} catch (Exception $e) {
    echo 'Exception when calling OrdersV4Api->ordersV4CancelPartnerOrders: ', $e->getMessage(), PHP_EOL;
}


$apiInstance = new Otto\Client\Api\OrdersV4Api(
    // 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
);
$from_date = "from_date_example"; // string | Defines earliest change date (ISO 8601) the returned orders should have
$from_order_date = "from_order_date_example"; // string | Only orders newer than the date specified (ISO 8601) will be returned
$to_order_date = "to_order_date_example"; // string | Only orders older than the date specified (ISO 8601) will be returned
$fulfillment_status = "fulfillment_status_example"; // string | <br>ANNOUNCED: Orders with at least one position item in state ANNOUNCED<br>PROCESSABLE: Orders with at least one position item in state PROCESSABLE and none in ANNOUNCED<br>SENT: Orders with at least one position item in state SENT and none in either ANNOUNCED or PROCESSABLE<br>RETURNED: Orders with at least one position item in state RETURNED and none in either ANNOUNCED, PROCESSABLE, or SENT<br>CANCELLED_BY_PARTNER: Orders with at least one position item in state CANCELLED_BY_PARTNER<br>CANCELLED_BY_MARKETPLACE: Orders with at least one position item in state CANCELLED_BY_MARKETPLACE<br><br>If no state is provided, orders in all possible states are returned.<br>Several values can be passed; it will return a combination of these states without duplicates. Also see parameter 'mode'.<br><br>Example: ?fulfillmentStatus=PROCESSABLE&fulfillmentStatus=CANCELLED_BY_MARKETPLACE
$limit = 128; // int | The maximum amount of orders to return
$order_direction = "ASC"; // string | Sort result by 'orderColumnType' in ASCending or DESCending order
$order_column_type = "ORDER_LIFECYCLE_DATE"; // string | The column on which to apply 'orderDirection' parameter
$mode = "BUCKET"; // string | In search mode AT_LEAST_ONE orders with at least one  position item in given 'fulfillmentStatus' will always be returned
$nextcursor = "nextcursor_example"; // string | Cursor for paging requests. If a next cursor is provided, the only other request parameter being considered is 'limit'<br><br>Note: Only the cursor string is required - not the whole link

try {
    $result = $apiInstance->ordersV4FindPartnerOrders($from_date, $from_order_date, $to_order_date, $fulfillment_status, $limit, $order_direction, $order_column_type, $mode, $nextcursor);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersV4Api->ordersV4FindPartnerOrders: ', $e->getMessage(), PHP_EOL;
}


$apiInstance = new Otto\Client\Api\OrdersV4Api(
    // 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
);
$order_number = "order_number_example"; // string | 

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


$apiInstance = new Otto\Client\Api\OrdersV4Api(
    // 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
);
$sales_order_id = "sales_order_id_example"; // string | 

try {
    $result = $apiInstance->ordersV4GetPartnerOrderBySalesOrderId($sales_order_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersV4Api->ordersV4GetPartnerOrderBySalesOrderId: ', $e->getMessage(), PHP_EOL;
}
?>

Documentation for API Endpoints

All URIs are relative to https://api.otto.market

Documentation For Models

• AcceptedPartnerReturnV2ReturnsV2
• AcceptedReturnMultiStatusResponseReturnsV2
• AcceptedStatusDataReturnsV2
• ActiveStatusListRequestProductsV2
• ActiveStatusListResponseProductsV2
• ActiveStatusProductsV2
• AdditionalRequirementProductsV2
• AddressOrdersV4
• AddressShipmentsV1
• AllOfLineItemReceiptsV2PriceToPay
• AllOfLineItemReceiptsV2Total
• AllOfLineItemReceiptsV2TotalDiscount
• AllOfLineItemReceiptsV2UnitPrice
• AllOfPartialRefundReceiptsV2PartialRefundAmount
• AllOfServicePositionInfoReceiptsV2Total
• AllOfServicePositionInfoReceiptsV2UnitPrice
• AllOfShippingFeeReceiptsV2Price
• AllOfTotalReceiptsV2AmountDue
• AllOfTotalReceiptsV2Gross
• AllOfTotalReceiptsV2Net
• AmountOrdersV4
• AnnouncedStatusDataReturnsV2
• ApiErrorResponseReturnsV2
• ApiErrorResponseV2QuantitiesV2
• ApiErrorReturnsV2
• ApiErrorV2QuantitiesV2
• AttributeDefinitionProductsV2
• AttributeProductsV2
• AvailableQuantityRequestDTOV2QuantitiesV2
• AvailableQuantityResponseDTOV2QuantitiesV2
• AvailableQuantityResponseV2QuantitiesV2
• AvailableQuantityResponseV2QuantitiesV2Resources
• AvailableQuantitySingleResponseDTOV2QuantitiesV2
• BadRequestAddPositionItemByShipmentIdShipmentsV1
• BadRequestAddPositionItemByTrackingNumberShipmentsV1
• BadRequestShipmentsV1
• BrandProductsV2
• CategoryGroupProductsV2
• CategoryGroupsProductsV2
• ConditionProductsV2
• ConflictAddPositionItemByShipmentIdShipmentsV1
• ConflictAddPositionItemByTrackingNumberShipmentsV1
• ConflictShipmentsV1
• ContentChangeProductsV2
• ContentChangesApiResultProductsV2
• CreateShipmentRequestShipmentsV1
• CreateShipmentResponseShipmentsV1
• CustomerReceiptsV2
• DeliveryAddressReceiptsV2
• DeliveryProductsV2
• DiscountDetailsReceiptsV2
• ErrorDescriptionShipmentsV1
• ForbiddenGetShipmentByShipmentIdShipmentsV1
• ForbiddenGetShipmentByTrackingNumberShipmentsV1
• InitialDeliveryFeeOrdersV4
• InitialDiscountOrdersV4
• InternalServerErrorAddPositionItemByShipmentIdShipmentsV1
• InternalServerErrorAddPositionItemByTrackingNumberShipmentsV1
• InternalServerErrorGetShipmentByShipmentIdShipmentsV1
• InternalServerErrorGetShipmentByTrackingNumberShipmentsV1
• InternalServerErrorGetShipmentListShipmentsV1
• InternalServerErrorShipmentsV1
• LineItemReceiptsV2
• LinkOrdersV4
• LinkProductsV2
• LinkQuantitiesV2
• LinkReceiptsV2
• LinkRelationProductsV2
• LinkReturnsV2
• LinkShipmentsV1
• LogisticsProductsV2
• MarketPlaceStatusApiResultProductsV2
• MarketPlaceStatusErrorProductsV2
• MarketPlaceStatusInformationProductsV2
• MarketPlaceStatusLinkProductsV2
• MarketPlaceStatusProductsV2
• MediaAssetProductsV2
• MisdirectedStatusDataReturnsV2
• MonetaryAmountProductsV2
• NormPriceInfoProductsV2
• NotFoundAddPositionItemByShipmentIdShipmentsV1
• NotFoundAddPositionItemByTrackingNumberShipmentsV1
• NotFoundGetShipmentByShipmentIdShipmentsV1
• NotFoundGetShipmentByTrackingNumberShipmentsV1
• OrderLifecycleInformationOrdersV4
• PackingUnitProductsV2
• PartialRefundReceiptsV2
• PartnerOrderListOrdersV4
• PartnerOrderOrdersV4
• PartnerReceiptsV2
• PayloadTooLargeApiErrorResponseV2QuantitiesV2
• PaymentOrdersV4
• PositionItemListReturnsV2
• PositionItemOrdersV4
• PositionItemReturnsV2
• PositionItemShipmentsV1
• PriceApiResultProductsV2
• PricingProductsV2
• ProductDescriptionProductsV2
• ProductLinkProductsV2
• ProductOrdersV4
• ProductProcessProgressProductsV2
• ProductProcessResultLinkProductsV2
• ProductProcessResultProductsV2
• ProductProcessTaskErrorProductsV2
• ProductProcessTaskResultProductsV2
• ProductVariationApiResultProductsV2
• ProductVariationProductsV2
• ReceiptReceiptsV2
• ReceiptsListReceiptsV2
• RejectedPartnerReturnV2ReturnsV2
• RejectedPositionItemReturnsV2
• RejectedReturnMultiStatusResponseReturnsV2
• RejectedStatusDataReturnsV2
• ReturnTrackingKeyReturnsV2
• ReturnTrackingKeyShipmentsV1
• ReturnedItemStatusDataReturnsV2
• ReturnedPositionItemReturnsV2
• SaleProductsV2
• ServicePositionInfoReceiptsV2
• ServicePositionItemInfoReceiptsV2
• ShipmentListShipmentsV1
• ShipmentShipmentsV1
• ShipmentWithMinimumDetailsShipmentsV1
• ShippingCostReceiptsV2
• ShippingFeeReceiptsV2
• SkuPricingProductsV2
• TotalReceiptsV2
• TrackingInfoOrdersV4
• TrackingKeyShipmentsV1
• UnauthenticatedShipmentsV1
• UpdateQuantityMultiStatusResponseQuantitiesV2

Documentation For Authorization

JWT

• Type: HTTP bearer authentication

Author