Fulfillment API
  1. Schemas
Fulfillment API
  • order
    • /order
    • /order/{orderId}
    • Issue Refund
  • shipping_fulfillment
    • /order/{orderId}/shipping_fulfillment
    • /order/{orderId}/shipping_fulfillment
    • /order/{orderId}/shipping_fulfillment/{fulfillmentId}
  • payment_dispute
    • Get Payment Dispute Details
    • Accept Payment Dispute
    • Get Payment Dispute Activity
    • Add an Evidence File
    • Contest Payment Dispute
    • Get Payment Dispute Evidence File
    • Update evidence
    • Upload an Evidence File
    • Search Payment Dispute by Filters
  • Schemas
    • Schemas
      • AcceptPaymentDisputeRequest
      • AddEvidencePaymentDisputeRequest
      • AddEvidencePaymentDisputeResponse
      • Address
      • Amount
      • AppliedPromotion
      • Buyer
      • CancelRequest
      • CancelStatus
      • ContestPaymentDisputeRequest
      • DeliveryCost
      • DisputeAmount
      • DisputeEvidence
      • DisputeSummaryResponse
      • EbayCollectAndRemitTax
      • EbayFulfillmentProgram
      • EbayTaxReference
      • Error
      • ErrorParameter
      • EvidenceRequest
      • ExtendedContact
      • FileEvidence
      • FileInfo
      • FulfillmentStartInstruction
      • GiftDetails
      • InfoFromBuyer
      • IssueRefundRequest
      • ItemLocation
      • LegacyReference
      • LineItem
      • LineItemFulfillmentInstructions
      • LineItemProperties
      • LineItemReference
      • LineItemRefund
      • MonetaryTransaction
      • Order
      • OrderLineItems
      • OrderRefund
      • OrderSearchPagedCollection
      • Payment
      • PaymentDispute
      • PaymentDisputeActivity
      • PaymentDisputeActivityHistory
      • PaymentDisputeOutcomeDetail
      • PaymentDisputeSummary
      • PaymentHold
      • PaymentSummary
      • Phone
      • PhoneNumber
      • PickupStep
      • PostSaleAuthenticationProgram
      • PricingSummary
      • Program
      • Refund
      • RefundItem
      • ReturnAddress
      • SellerActionsToRelease
      • ShippingFulfillment
      • ShippingFulfillmentDetails
      • ShippingFulfillmentPagedCollection
      • ShippingStep
      • SimpleAmount
      • Tax
      • TaxAddress
      • TaxIdentifier
      • TrackingInfo
      • UpdateEvidencePaymentDisputeRequest
  1. Schemas

Order

This type contains the details of an order, including information about the buyer, order history, shipping fulfillments, line items, costs, payments, and order fulfillment status.

{
    "buyer": {
        "taxAddress": {
            "city": "string",
            "countryCode": "string",
            "postalCode": "string",
            "stateOrProvince": "string"
        },
        "taxIdentifier": {
            "issuingCountry": "string",
            "taxIdentifierType": "string",
            "taxpayerId": "string"
        },
        "username": "string"
    },
    "buyerCheckoutNotes": "string",
    "cancelStatus": {
        "cancelRequests": [
            {
                "cancelCompletedDate": "string",
                "cancelInitiator": "string",
                "cancelReason": "string",
                "cancelRequestId": "string",
                "cancelRequestState": "string",
                "cancelRequestedDate": "string"
            }
        ],
        "cancelState": "string",
        "cancelledDate": "string"
    },
    "creationDate": "string",
    "ebayCollectAndRemitTax": true,
    "fulfillmentHrefs": [
        "string"
    ],
    "fulfillmentStartInstructions": [
        {
            "ebaySupportedFulfillment": true,
            "finalDestinationAddress": {
                "addressLine1": "string",
                "addressLine2": "string",
                "city": "string",
                "country": "string",
                "county": "string",
                "postalCode": "string",
                "stateOrProvince": "string"
            },
            "fulfillmentInstructionsType": "string",
            "maxEstimatedDeliveryDate": "string",
            "minEstimatedDeliveryDate": "string",
            "pickupStep": {
                "merchantLocationKey": "string"
            },
            "shippingStep": {
                "shipTo": {
                    "companyName": "string",
                    "contactAddress": {
                        "addressLine1": "string",
                        "addressLine2": "string",
                        "city": "string",
                        "country": "string",
                        "county": "string",
                        "postalCode": "string",
                        "stateOrProvince": "string"
                    },
                    "email": "string",
                    "fullName": "string",
                    "primaryPhone": {
                        "phoneNumber": "string"
                    }
                },
                "shipToReferenceId": "string",
                "shippingCarrierCode": "string",
                "shippingServiceCode": "string"
            }
        }
    ],
    "lastModifiedDate": "string",
    "legacyOrderId": "string",
    "lineItems": [
        {
            "appliedPromotions": [
                {
                    "description": "string",
                    "discountAmount": {
                        "convertedFromCurrency": "string",
                        "convertedFromValue": "string",
                        "currency": "string",
                        "value": "string"
                    },
                    "promotionId": "string"
                }
            ],
            "deliveryCost": {
                "importCharges": {
                    "convertedFromCurrency": "string",
                    "convertedFromValue": "string",
                    "currency": "string",
                    "value": "string"
                },
                "shippingCost": {
                    "convertedFromCurrency": "string",
                    "convertedFromValue": "string",
                    "currency": "string",
                    "value": "string"
                },
                "shippingIntermediationFee": {
                    "convertedFromCurrency": "string",
                    "convertedFromValue": "string",
                    "currency": "string",
                    "value": "string"
                }
            },
            "discountedLineItemCost": {
                "convertedFromCurrency": "string",
                "convertedFromValue": "string",
                "currency": "string",
                "value": "string"
            },
            "ebayCollectAndRemitTaxes": [
                {
                    "amount": {
                        "convertedFromCurrency": "string",
                        "convertedFromValue": "string",
                        "currency": "string",
                        "value": "string"
                    },
                    "collectionMethod": "string",
                    "ebayReference": {
                        "name": "string",
                        "value": "string"
                    },
                    "taxType": "string"
                }
            ],
            "giftDetails": {
                "message": "string",
                "recipientEmail": "string",
                "senderName": "string"
            },
            "itemLocation": {
                "countryCode": "string",
                "location": "string",
                "postalCode": "string"
            },
            "legacyItemId": "string",
            "legacyVariationId": "string",
            "lineItemCost": {
                "convertedFromCurrency": "string",
                "convertedFromValue": "string",
                "currency": "string",
                "value": "string"
            },
            "lineItemFulfillmentInstructions": {
                "guaranteedDelivery": true,
                "maxEstimatedDeliveryDate": "string",
                "minEstimatedDeliveryDate": "string",
                "shipByDate": "string"
            },
            "lineItemFulfillmentStatus": "string",
            "lineItemId": "string",
            "listingMarketplaceId": "string",
            "properties": {
                "buyerProtection": true,
                "fromBestOffer": true,
                "soldViaAdCampaign": true
            },
            "purchaseMarketplaceId": "string",
            "quantity": 0,
            "refunds": [
                {
                    "amount": {
                        "convertedFromCurrency": "string",
                        "convertedFromValue": "string",
                        "currency": "string",
                        "value": "string"
                    },
                    "refundDate": "string",
                    "refundId": "string",
                    "refundReferenceId": "string"
                }
            ],
            "sku": "string",
            "soldFormat": "string",
            "taxes": [
                {
                    "amount": {
                        "convertedFromCurrency": "string",
                        "convertedFromValue": "string",
                        "currency": "string",
                        "value": "string"
                    },
                    "taxType": "string"
                }
            ],
            "title": "string",
            "total": {
                "convertedFromCurrency": "string",
                "convertedFromValue": "string",
                "currency": "string",
                "value": "string"
            }
        }
    ],
    "orderFulfillmentStatus": "string",
    "orderId": "string",
    "orderPaymentStatus": "string",
    "paymentSummary": {
        "payments": [
            {
                "amount": {
                    "convertedFromCurrency": "string",
                    "convertedFromValue": "string",
                    "currency": "string",
                    "value": "string"
                },
                "paymentDate": "string",
                "paymentHolds": [
                    {
                        "expectedReleaseDate": "string",
                        "holdAmount": {
                            "convertedFromCurrency": "string",
                            "convertedFromValue": "string",
                            "currency": "string",
                            "value": "string"
                        },
                        "holdReason": "string",
                        "holdState": "string",
                        "releaseDate": "string",
                        "sellerActionsToRelease": [
                            {
                                "sellerActionToRelease": "string"
                            }
                        ]
                    }
                ],
                "paymentMethod": "string",
                "paymentReferenceId": "string",
                "paymentStatus": "string"
            }
        ],
        "refunds": [
            {
                "amount": {
                    "convertedFromCurrency": "string",
                    "convertedFromValue": "string",
                    "currency": "string",
                    "value": "string"
                },
                "refundDate": "string",
                "refundId": "string",
                "refundReferenceId": "string",
                "refundStatus": "string"
            }
        ],
        "totalDueSeller": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        }
    },
    "pricingSummary": {
        "adjustment": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "deliveryCost": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "deliveryDiscount": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "fee": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "priceDiscountSubtotal": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "priceSubtotal": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "tax": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        },
        "total": {
            "convertedFromCurrency": "string",
            "convertedFromValue": "string",
            "currency": "string",
            "value": "string"
        }
    },
    "program": {
        "authenticityVerification": {
            "outcomeReason": "string",
            "status": "string"
        },
        "fulfillmentProgram": {
            "fulfilledBy": "string"
        }
    },
    "salesRecordReference": "string",
    "sellerId": "string",
    "totalFeeBasisAmount": {
        "convertedFromCurrency": "string",
        "convertedFromValue": "string",
        "currency": "string",
        "value": "string"
    },
    "totalMarketplaceFee": {
        "convertedFromCurrency": "string",
        "convertedFromValue": "string",
        "currency": "string",
        "value": "string"
    }
}
Built with