/order

Use this call 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. 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.

{ "href": "string", "limit": 0, "next": "string", "offset": 0, "orders": [ { "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" } } ], "prev": "string", "total": 0, "warnings": [ { "category": "string", "domain": "string", "errorId": 0, "inputRefIds": [ "string" ], "longMessage": "string", "message": "string", "outputRefIds": [ "string" ], "parameters": [ { "name": "string", "value": "string" } ], "subdomain": "string" } ] }

Request

Responses