fulfillment_api

FulfillmentApi - JavaScript client for fulfillment_api 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 SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.10.1
• Package version: 1.10.1
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install fulfillment_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your fulfillment_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var FulfillmentApi = require('fulfillment_api');

var defaultClient = FulfillmentApi.ApiClient.instance;
// Configure OAuth2 access token for authorization: api_auth
var api_auth = defaultClient.authentications['api_auth'];
api_auth.accessToken = "YOUR ACCESS TOKEN"

var api = new FulfillmentApi.OrderApi()
var orderId = "orderId_example"; // {String} The unique identifier of the order. This value was returned by the getOrders method in the orders.orderId field. The getOrder method supports all order identifier formats. Note: Order IDs in both Trading/legacy APIs and REST APIs are transitioning to a new format. 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.
api.getOrder(orderId).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- FulfillmentApi.OrderApi | getOrder | GET /order/{orderId} | Get an Order FulfillmentApi.OrderApi | getOrders | GET /order | Get Orders FulfillmentApi.OrderApi | issueRefund | POST /order/{order_id}/issue_refund | Issue Refund FulfillmentApi.ShippingFulfillmentApi | createShippingFulfillment | POST /order/{orderId}/shipping_fulfillment | Create a Shipping Fulfillment FulfillmentApi.ShippingFulfillmentApi | getShippingFulfillment | GET /order/{orderId}/shipping_fulfillment/{fulfillmentId} | Get a Shipping Fulfillment FulfillmentApi.ShippingFulfillmentApi | getShippingFulfillments | GET /order/{orderId}/shipping_fulfillment | Get Shipping Fulfillments

Documentation for Models

• FulfillmentApi.Address
• FulfillmentApi.Amount
• FulfillmentApi.AppliedPromotion
• FulfillmentApi.Buyer
• FulfillmentApi.CancelRequest
• FulfillmentApi.CancelStatus
• FulfillmentApi.DeliveryCost
• FulfillmentApi.EbayCollectAndRemitTax
• FulfillmentApi.Error
• FulfillmentApi.ErrorParameter
• FulfillmentApi.ExtendedContact
• FulfillmentApi.FulfillmentStartInstruction
• FulfillmentApi.GiftDetails
• FulfillmentApi.IssueRefundRequest
• FulfillmentApi.LegacyReference
• FulfillmentApi.LineItem
• FulfillmentApi.LineItemFulfillmentInstructions
• FulfillmentApi.LineItemProperties
• FulfillmentApi.LineItemReference
• FulfillmentApi.LineItemRefund
• FulfillmentApi.Order
• FulfillmentApi.OrderRefund
• FulfillmentApi.OrderSearchPagedCollection
• FulfillmentApi.Payment
• FulfillmentApi.PaymentHold
• FulfillmentApi.PaymentSummary
• FulfillmentApi.PhoneNumber
• FulfillmentApi.PickupStep
• FulfillmentApi.PricingSummary
• FulfillmentApi.Refund
• FulfillmentApi.RefundItem
• FulfillmentApi.SellerActionsToRelease
• FulfillmentApi.ShippingFulfillment
• FulfillmentApi.ShippingFulfillmentDetails
• FulfillmentApi.ShippingFulfillmentPagedCollection
• FulfillmentApi.ShippingStep
• FulfillmentApi.Tax

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.fulfillment.readonly: View your order fulfillments