--- name: fulfillment-api description: "Fulfillment API skill. Use when working with Fulfillment for order, payment_dispute, payment_dispute_summary. Covers 15 endpoints." version: 1.0.0 generator: lapsh --- # Fulfillment API API version: v1.20.7 ## Auth OAuth2 ## Base URL https://api.ebay.com/sell/fulfillment/v1 ## Setup 1. Configure auth: OAuth2 2. GET /order -- use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. you can alternatively specify a list of orders using the orderids parameter. include the optional fieldgroups query parameter set to tax_breakdown to return a breakdown of the taxes and fees. by default, when no filters are used this call returns all orders created within the last 90 days. the returned order objects contain information you can use to create and process fulfillments, including: information about the buyer and seller information about the order's line items the plans for packaging, addressing and shipping the order the status of payment, packaging, addressing, and shipping the order a summary of monetary amounts specific to the order such as pricing, payments, and shipping costs a summary of applied taxes and fees, and optionally a breakdown of each important: in this call, the cancelstatus.cancelrequests array is returned but is always empty. use the getorder call instead, which returns this array fully populated with information about any cancellation requests. 3. POST /order/{order_id}/issue_refund -- create first issue_refund ## Endpoints 15 endpoints across 3 groups. See references/api-spec.lap for full details. ### Order | Method | Path | Description | |--------|------|-------------| | GET | /order/{orderId} | Use this call to retrieve the contents of an order based on its unique identifier, orderId. This value was returned in the getOrders call's orders.orderId field when you searched for orders by creation date, modification date, or fulfillment status. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees. The returned Order object contains information you can use to create and process fulfillments, including: Information about the buyer and seller Information about the order's line items The plans for packaging, addressing and shipping the order The status of payment, packaging, addressing, and shipping the order A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs A summary of applied taxes and fees, and optionally a breakdown of each | | GET | /order | Use this method to search for and retrieve one or more orders based on their creation date, last modification date, or fulfillment status using the filter parameter. You can alternatively specify a list of orders using the orderIds parameter. Include the optional fieldGroups query parameter set to TAX_BREAKDOWN to return a breakdown of the taxes and fees. By default, when no filters are used this call returns all orders created within the last 90 days. The returned Order objects contain information you can use to create and process fulfillments, including: Information about the buyer and seller Information about the order's line items The plans for packaging, addressing and shipping the order The status of payment, packaging, addressing, and shipping the order A summary of monetary amounts specific to the order such as pricing, payments, and shipping costs A summary of applied taxes and fees, and optionally a breakdown of each Important: In this call, the cancelStatus.cancelRequests array is returned but is always empty. Use the getOrder call instead, which returns this array fully populated with information about any cancellation requests. | | POST | /order/{order_id}/issue_refund | Issue Refund | | GET | /order/{orderId}/shipping_fulfillment | Use this call to retrieve the contents of all fulfillments currently defined for a specified order based on the order's unique identifier, orderId. This value is returned in the getOrders call's members.orderId field when you search for orders by creation date or shipment status. | | POST | /order/{orderId}/shipping_fulfillment | When 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 shipping fulfillment. For each package, execute this call once to generate a shipping fulfillment associated with that package. Note: A single line item in an order can consist of multiple units of a purchased item, and one unit can consist of multiple parts or components. Although these components might be provided by the manufacturer in separate packaging, the seller must include all components of a given line item in the same package. Before using this call for a given package, you must determine which line items are in the package. If the package has been shipped, you should provide the date of shipment in the request. If not provided, it will default to the current date and time. | | GET | /order/{orderId}/shipping_fulfillment/{fulfillmentId} | Use this call to retrieve the contents of a fulfillment based on its unique identifier, fulfillmentId (combined with the associated order's orderId). The fulfillmentId value was originally generated by the createShippingFulfillment call, and is returned by the getShippingFulfillments call in the members.fulfillmentId field. | ### Payment_dispute | Method | Path | Description | |--------|------|-------------| | GET | /payment_dispute/{payment_dispute_id} | Get Payment Dispute Details | | GET | /payment_dispute/{payment_dispute_id}/fetch_evidence_content | Get Payment Dispute Evidence File | | GET | /payment_dispute/{payment_dispute_id}/activity | Get Payment Dispute Activity | | POST | /payment_dispute/{payment_dispute_id}/contest | Contest Payment Dispute | | POST | /payment_dispute/{payment_dispute_id}/accept | Accept Payment Dispute | | POST | /payment_dispute/{payment_dispute_id}/upload_evidence_file | Upload an Evidence File | | POST | /payment_dispute/{payment_dispute_id}/add_evidence | Add an Evidence File | | POST | /payment_dispute/{payment_dispute_id}/update_evidence | Update evidence | ### Payment_dispute_summary | Method | Path | Description | |--------|------|-------------| | GET | /payment_dispute_summary | Search Payment Dispute by Filters | ## Common Questions Match user requests to endpoints in references/api-spec.lap. Key patterns: - "Get order details?" -> GET /order/{orderId} - "List all order?" -> GET /order - "Create a issue_refund?" -> POST /order/{order_id}/issue_refund - "List all shipping_fulfillment?" -> GET /order/{orderId}/shipping_fulfillment - "Create a shipping_fulfillment?" -> POST /order/{orderId}/shipping_fulfillment - "Get shipping_fulfillment details?" -> GET /order/{orderId}/shipping_fulfillment/{fulfillmentId} - "Get payment_dispute details?" -> GET /payment_dispute/{payment_dispute_id} - "List all fetch_evidence_content?" -> GET /payment_dispute/{payment_dispute_id}/fetch_evidence_content - "List all activity?" -> GET /payment_dispute/{payment_dispute_id}/activity - "List all payment_dispute_summary?" -> GET /payment_dispute_summary - "Create a contest?" -> POST /payment_dispute/{payment_dispute_id}/contest - "Create a accept?" -> POST /payment_dispute/{payment_dispute_id}/accept - "Create a upload_evidence_file?" -> POST /payment_dispute/{payment_dispute_id}/upload_evidence_file - "Create a add_evidence?" -> POST /payment_dispute/{payment_dispute_id}/add_evidence - "Create a update_evidence?" -> POST /payment_dispute/{payment_dispute_id}/update_evidence - "How to authenticate?" -> See Auth section above ## Response Tips - Check response schemas in references/api-spec.lap for field details - Paginated endpoints accept limit/offset or cursor parameters - Create/update endpoints return the modified resource on success - Error responses include status codes and descriptions in the spec ## References - Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas > Generated from the official API spec by [LAP](https://lap.sh)