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.
order
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getOrder | GET | /order/{orderId} | Retrieves the details of a specific order. | View getOrder - /order/{orderId} |
getOrders | GET | /order | Retrieves the details of orders matching search criteria. | View getOrders - /order |
issueRefund | POST | /order/{order_id}/issue_refund | Issues a full or partial refund to a buyer on behalf of the seller. | View issueRefund - /order/{order_id}/issue_refund |
order:shipping_fulfillment
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
createShippingFulfillment | POST | /order/{orderId}/shipping_fulfillment | Creates a shipping fulfillment for one or more line items with shipment tracking information. | View createShippingFulfillment - /order/{orderId}/shipping_fulfillment |
getShippingFulfillment | GET | /order/{orderId}/shipping_fulfillment/{fulfillmentId} | Retrieves details of a shipping fulfillment. | View getShippingFulfillment - /order/{orderId}/shipping_fulfillment/{fulfillmentId} |
getShippingFulfillments | GET | /order/{orderId}/shipping_fulfillment | Retrieves the details of all shipping fulfillments defined for an order. | View getShippingFulfillments - /order/{orderId}/shipping_fulfillment |
payment_dispute
Method Name | HTTP Method | Path | Summary | Samples |
---|---|---|---|---|
getPaymentDispute | GET | /payment_dispute/{payment_dispute_id} | Retrieves full details on a specific payment dispute. | View getPaymentDispute - /payment_dispute/{payment_dispute_id} |
fetchEvidenceContent | GET | /payment_dispute/{payment_dispute_id}/fetch_evidence_content | Retrieves a specific evidence file for a payment dispute. | View fetchEvidenceContent - /payment_dispute/{payment_dispute_id}/fetch_evidence_content |
getActivities | GET | /payment_dispute/{payment_dispute_id}/activity | Retrieves a log of activity for a payment dispute. | View getActivities - /payment_dispute/{payment_dispute_id}/activity |
getPaymentDisputeSummaries | GET | /payment_dispute_summary | Retrieves payment disputes based on search criteria. | View getPaymentDisputeSummaries - /payment_dispute_summary |
contestPaymentDispute | POST | /payment_dispute/{payment_dispute_id}/contest | Contests a payment dispute. | View contestPaymentDispute - /payment_dispute/{payment_dispute_id}/contest |
acceptPaymentDispute | POST | /payment_dispute/{payment_dispute_id}/accept | Accepts a payment dispute. | View acceptPaymentDispute - /payment_dispute/{payment_dispute_id}/accept |
uploadEvidenceFile | POST | /payment_dispute/{payment_dispute_id}/upload_evidence_file | Uploads an evidence file for a contested payment dispute. | View uploadEvidenceFile - /payment_dispute/{payment_dispute_id}/upload_evidence_file |
addEvidence | POST | /payment_dispute/{payment_dispute_id}/add_evidence | Adds an evidence file for a payment dispute. | View addEvidence - /payment_dispute/{payment_dispute_id}/add_evidence |
updateEvidence | POST | /payment_dispute/{payment_dispute_id}/update_evidence | Updates an evidence set for a contested payment dispute. | View updateEvidence - /payment_dispute/{payment_dispute_id}/update_evidence |