Cmdlets for eBay

Build 24.0.9060

Orders

Query all orders in which the authenticated user is either the buyer or seller. By default, only orders made in the last 90 days are returned. Orders older than 90 days can be retrieved by specifying OrderId.

View Specific Information

Select

Examples of querying the Orders view:

SELECT * FROM Orders WHERE OrderId = '110276240386-28854859001'

SELECT * FROM Orders WHERE OrderId IN ('110276240386-28854859001', '110277719772-28859911001')

SELECT * FROM Orders WHERE CreateTimeFrom = '2018-02-10' AND CreateTimeTo = '2018-03-16'

SELECT * FROM Orders WHERE OrderStatus = 'Active'

SELECT * FROM Orders WHERE NumberOfDays = '26'

Columns

Name Type Description
OrderId [KEY] String A unique identifier for an eBay order.
ExtendedOrderId String The unique identifier of the order in legacy format, as traditionally used by the Trading API.
BuyerUserId String eBay user ID of the order's buyer.
SellerUserId String This is the eBay user ID of the order's seller.
OrderStatus String This enumeration value indicates the current status of the order. Applicable Values: Active, All, Cancelled, Completed, Inactive.
AdjustmentAmount Decimal This value indicates the dollar amount by which the buyer has adjusted the order total.
AmountPaid Decimal This value indicates the total amount of the order.
AmountSaved Decimal This value indicates the shipping discount experienced by the buyer as a result of creating a Combined Invoice order.
CreatedTime Datetime Timestamp that indicates the date and time that the order was created.
ShippedTime Datetime Timestamp indicating the date and time of order shipment. This field is not returned until the order has been marked as shipped.
PaymentMethod String The payment method that the buyer selected to pay for the order.
PaymentStatus String This value indicates the payment status of an order.
CheckoutStatus String Container consisting of details related to the current checkout status of the order.
SellerEmail String The email address of the seller involved in the order. The email address of the seller is only returned if it is the same seller making the call.
SubTotal Decimal The subtotal amount for the order is the total cost of all order line items. This value does not include any shipping/handling, shipping insurance, or sales tax costs.
Total Decimal The Total amount equals the Subtotal value plus the shipping/handling, shipping insurance, and sales tax costs.
CancelCompleteDate Datetime Timestamp indicating when the cancellation process of an eBay order has been completed.
CancelInitiationDate Datetime This timestamp indicates when the cancellation of the eBay order was initiated.
CancelInitiator String This value indicates which party initiated the cancellation of the eBay order.
CancelReason String This value indicates the reason why the order cancellation was initiated.
CancelStatus String The current status for the order cancellation request if it exists.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
CreateTimeFrom Datetime Specifies the start of the date range for which to retrieve orders created within this date range.
CreateTimeTo Datetime Specifies the end of the date range for which to retrieve orders created within this date range.
ModTimeFrom Datetime Specifies the start of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days.
ModTimeTo Datetime Specifies the end of the date range for which to retrieve orders modified within this date range. The maximum time range that may be specified is 30 days.
NumberOfDays Integer All eBay orders that were either created or modified within this period are returned in the output. Min: 1. Max: 30.
OrderRole String Filters the returned orders based on the role of the user. The user's role is either buyer or seller.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060