eBay

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…

E-commerce#openapi#ecommerce

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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.

Endpoints 15

order

  • GETgetOrders/order?fieldGroups=string&filter=string&limit=string&offset=string&orderIds=stringUse this call to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the…
  • GETgetOrder/order/:orderId?fieldGroups=stringUse this call to retrieve the contents of an order based on its unique identifier, <i>orderId</i>. This value was returned in the <b> getOrders</b> call's…
  • POSTIssue Refund/order/:order_id/issue_refund<div class="msgbox_important"><p class="msgbox_importantInDiv" data-mc-autonum="&lt;b&gt;&lt;span style=&quot;color: #dd1e31;&quot;…

shipping_fulfillment

  • GETgetShippingFulfillments/order/:orderId/shipping_fulfillmentUse this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, <b>orderId</b>.…
  • POSTcreateShippingFulfillment/order/:orderId/shipping_fulfillmentWhen you group an order's line items into one or more packages, each package requires a corresponding plan for handling, addressing, and shipping; this is a…
  • GETgetShippingFulfillment/order/:orderId/shipping_fulfillment/:fulfillmentIdUse this call to retrieve the contents of a fulfillment based on its unique identifier, <b>fulfillmentId</b> (combined with the associated order's…

payment_dispute

  • GETGet Payment Dispute Detailshttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_idThis method retrieves detailed information on a specific payment dispute. The payment dispute identifier is passed in as path parameter at the end of the call…
  • POSTAccept Payment Disputehttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/acceptThis method is used if the seller wishes to accept a payment dispute. The unique identifier of the payment dispute is passed in as a path parameter, and…
  • GETGet Payment Dispute Activityhttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/activityThis method retrieve a log of activity for a payment dispute. The identifier of the payment dispute is passed in as a path parameter. The output includes a…
  • POSTAdd an Evidence Filehttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/add_evidenceThis method is used by the seller to add one or more evidence files to address a payment dispute initiated by the buyer. The unique identifier of the payment…
  • POSTContest Payment Disputehttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/contestThis method is used if the seller wishes to contest a payment dispute initiated by the buyer. The unique identifier of the payment dispute is passed in as a…
  • GETGet Payment Dispute Evidence Filehttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/fetch_evidence_content?evidence_id=string&file_id=stringThis call retrieves a specific evidence file for a payment dispute. The following three identifying parameters are needed in the call…
  • POSTUpdate evidencehttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/update_evidenceThis method is used by the seller to update an existing evidence set for a payment dispute with one or more evidence files. The unique identifier of the…
  • POSTUpload an Evidence Filehttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute/:payment_dispute_id/upload_evidence_fileThis method is used to upload an evidence file for a contested payment dispute. The unique identifier of the payment dispute is passed in as a path parameter,…
  • GETSearch Payment Dispute by Filtershttps://apiz.ebay.com/sell/fulfillment/v1/payment_dispute_summary?order_id=string&buyer_username=string&open_date_from=string&open_date_to=string&payment_dispute_status=string&limit=string&offset=stringThis method is used retrieve one or more payment disputes filed against the seller. These payment disputes can be open or recently closed. The following…

API details

Base URL
https://api.ebay.com{basePath}
https://apiz.ebay.com{basePath}
Authentication
OAuth 2.0 (authorization code flow) with 4 scopes
Operations
15 operations on 14 pathsGET 8POST 7
Main resources
payment_dispute 9order 3shipping_fulfillment 3
Response formats
application/json application/octet-stream
Description format
OpenAPI 3.0.0, API version v1.19.19
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Fulfillment API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Fulfillment API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 4 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “getOrders” (GET /order?fieldGroups=string&filter=string&limit=string&offset=string&orderIds=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the 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… It is listed under E-commerce and has 15 endpoints.

Who publishes the Fulfillment API?

It is listed from eBay's public API description (an OpenAPI document), not published by eBay on Swastik Codes. Anyone who controls ebay.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Fulfillment API?

Its description lists 2 base URLs: https://api.ebay.com{basePath}, https://apiz.ebay.com{basePath}. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the Fulfillment API?

With OAuth 2.0 (authorization code flow) with 4 scopes.

How many endpoints does the Fulfillment API have?

15 operations on 14 paths (8 GET, 7 POST). The largest groups are payment_dispute, order, shipping_fulfillment.

Is forking the Fulfillment API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.