README.md

sdk-ebay-rest-fulfillment

Use the Fulfillment API to complete the process of packaging, addressing, handling, and shipping each order on behalf of the seller, in accordance with the payment method and timing specified at checkout.

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 1.11.1
• Package version: 2.3.2
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/macropage/sdk-ebay-rest-fulfillment.git"
    }
  ],
  "require": {
    "macropage/sdk-ebay-rest-fulfillment": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/sdk-ebay-rest-fulfillment/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');

// Configure OAuth2 access token for authorization: api_auth
$config = macropage\SDKs\ebay\rest\fulfillment\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new macropage\SDKs\ebay\rest\fulfillment\Api\OrderApi(
    // 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
);
$orderId = 'orderId_example'; // string | The unique identifier of the order. Order ID values are shown in My eBay/Seller Hub, and are also returned by the getOrders method in the orders.orderId field. Note: A new order ID format was introduced to all eBay APIs (legacy and REST) in June 2019. In REST APIs that return Order IDs, including the Fulfillment API, all order IDs are returned in the new format, but the getOrder method will accept both the legacy and new format order ID. The new format is a non-parsable string, globally unique across all eBay marketplaces, and consistent for both single line item and multiple line item orders. These order identifiers will be automatically generated after buyer payment, and unlike in the past, instead of just being known and exposed to the seller, these unique order identifiers will also be known and used/referenced by the buyer and eBay customer support.

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

?>

Documentation for API Endpoints

All URIs are relative to https://api.ebay.com/sell/fulfillment/v1

Class	Method	HTTP request	Description
OrderApi	getOrder	GET /order/{orderId}	Get an Order
OrderApi	getOrders	GET /order	Get Orders
OrderApi	issueRefund	POST /order/{order_id}/issue_refund	Issue Refund
PaymentDisputeApi	fetchEvidenceContent	GET /payment_dispute/{payment_dispute_id}/fetch_evidence_content	Get Payment Dispute Evidence File
PaymentDisputeApi	getActivities	GET /payment_dispute/{payment_dispute_id}/activity	Get Payment Dispute Activity
PaymentDisputeApi	getPaymentDispute	GET /payment_dispute/{payment_dispute_id}	Get Payment Dispute Details
PaymentDisputeApi	getPaymentDisputeSummaries	GET /payment_dispute_summary	Search Payment Dispute by Filters
ShippingFulfillmentApi	createShippingFulfillment	POST /order/{orderId}/shipping_fulfillment	Create a Shipping Fulfillment
ShippingFulfillmentApi	getShippingFulfillment	GET /order/{orderId}/shipping_fulfillment/{fulfillmentId}	Get a Shipping Fulfillment
ShippingFulfillmentApi	getShippingFulfillments	GET /order/{orderId}/shipping_fulfillment	Get Shipping Fulfillments

Documentation For Models

• Address
• Amount
• AppliedPromotion
• Buyer
• CancelRequest
• CancelStatus
• DeliveryCost
• DisputeEvidence
• DisputeSummaryResponse
• EbayCollectAndRemitTax
• Error
• ErrorParameter
• EvidenceRequest
• ExtendedContact
• FileInfo
• FulfillmentStartInstruction
• GiftDetails
• InfoFromBuyer
• IssueRefundRequest
• LegacyReference
• LineItem
• LineItemFulfillmentInstructions
• LineItemProperties
• LineItemReference
• LineItemRefund
• Order
• OrderLineItems
• OrderRefund
• OrderSearchPagedCollection
• Payment
• PaymentDispute
• PaymentDisputeActivity
• PaymentDisputeActivityHistory
• PaymentDisputeOutcomeDetail
• PaymentDisputeSummary
• PaymentHold
• PaymentSummary
• PhoneNumber
• PickupStep
• PricingSummary
• Refund
• RefundItem
• SellerActionsToRelease
• ShippingFulfillment
• ShippingFulfillmentDetails
• ShippingFulfillmentPagedCollection
• ShippingStep
• SimpleAmount
• Tax
• TrackingInfo

Documentation For Authorization

api_auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://auth.ebay.com/oauth2/authorize
• Scopes:
• https://api.ebay.com/oauth/api_scope/sell.fulfillment: View and manage your order fulfillments
• https://api.ebay.com/oauth/api_scope/sell.finances: View and manage your payment and order information to display this information to you and allow you to initiate refunds using the third party application
• https://api.ebay.com/oauth/api_scope/sell.payment.dispute: View and manage disputes and related details (including payment and order information).
• https://api.ebay.com/oauth/api_scope/sell.fulfillment.readonly: View your order fulfillments

Author