Skip to main content

  • Important: Due to EU & UK Payments regulatory requirements, an additional security verification via Digital Signatures is required for certain API calls that are made by EU/UK sellers. Please refer to Digital Signatures for APIs to learn more on the impacted APIs and the process to create signature to be included in the HTTP payload.

  • OpenAPI Specification - Version 2.0 for all of our RESTful APIs will no longer be available starting April 5, 2023. We will continue leveraging OpenAPI Specification - Version 3.0 for new features in our RESTful APIs.

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 NameHTTP MethodPathSummarySamples
getOrderGET/order/{orderId}Retrieve the details of a specific order.View getOrder - /order/{orderId}
getOrdersGET/orderSearch for and retrieve the details of multiple orders.View getOrders - /order
issueRefundPOST/order/{order_id}/issue_refundSeller can issue a full or partial refund to a buyer for an order.View issueRefund - /order/{order_id}/issue_refund

order:shipping_fulfillment

Method NameHTTP MethodPathSummarySamples
createShippingFulfillmentPOST/order/{orderId}/shipping_fulfillmentDefine a package and its shipping information for an order.View createShippingFulfillment - /order/{orderId}/shipping_fulfillment
getShippingFulfillmentGET/order/{orderId}/shipping_fulfillment/{fulfillmentId}Retrieve the details of a specified shipping fulfillment definition for an order.View getShippingFulfillment - /order/{orderId}/shipping_fulfillment/{fulfillmentId}
getShippingFulfillmentsGET/order/{orderId}/shipping_fulfillmentRetrieve the details of all shipping fulfillments defined for an order.View getShippingFulfillments - /order/{orderId}/shipping_fulfillment

payment_dispute

Method NameHTTP MethodPathSummarySamples
getPaymentDisputeGET/payment_dispute/{payment_dispute_id}Retrieve full details on a specific payment dispute.View getPaymentDispute - /payment_dispute/{payment_dispute_id}
fetchEvidenceContentGET/payment_dispute/{payment_dispute_id}/fetch_evidence_contentRetrieve a specific evidence file for a payment dispute.View fetchEvidenceContent - /payment_dispute/{payment_dispute_id}/fetch_evidence_content
getActivitiesGET/payment_dispute/{payment_dispute_id}/activityRetrieve a log of activity for a payment dispute.View getActivities - /payment_dispute/{payment_dispute_id}/activity
getPaymentDisputeSummariesGET/payment_dispute_summaryRetrieve one or more payment disputes. Several filters are available.View getPaymentDisputeSummaries - /payment_dispute_summary
contestPaymentDisputePOST/payment_dispute/{payment_dispute_id}/contestContest a payment disputeView contestPaymentDispute - /payment_dispute/{payment_dispute_id}/contest
acceptPaymentDisputePOST/payment_dispute/{payment_dispute_id}/acceptAccept a payment disputeView acceptPaymentDispute - /payment_dispute/{payment_dispute_id}/accept
uploadEvidenceFilePOST/payment_dispute/{payment_dispute_id}/upload_evidence_fileUpload an evidence file for a contested payment dispute.View uploadEvidenceFile - /payment_dispute/{payment_dispute_id}/upload_evidence_file
addEvidencePOST/payment_dispute/{payment_dispute_id}/add_evidenceAdd an evidence file for a payment dispute.View addEvidence - /payment_dispute/{payment_dispute_id}/add_evidence
updateEvidencePOST/payment_dispute/{payment_dispute_id}/update_evidenceUpdate an evidence set for a contested payment dispute.View updateEvidence - /payment_dispute/{payment_dispute_id}/update_evidence