Search Orders

get

https://api.tcgplayer.com/stores/{storeKey}/orders

Search Orders.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Returns an array containing the order numbers that match a specific search criteria.

{
    "totalItems": integer,
    "success": boolean,
    "errors": [],
    "results": [
        "string"
    ]
}

{
    "totalItems": 1,
    "success": true,
    "errors": [],
    "results": [
        "23132-0A4D52-A147D"
    ]
}

Path Params

storeKey

string

required

Required. A unique key used to identify the caller of the API.

Query Params

orderNumber

string

If provided, only return the order for the order number specified.

customerName

string

If provided, only return orders where the buyer's name contains the specified string. Format "Firstname, Lastname".

customerEmail

string

If provided, only return orders where the buyer's email address contains the specified string.

minOrderValue

double

If provided, only return orders with ProductAmt >= the specified value.

maxOrderValue

double

If provided, only return orders with ProductAmt <= the specified value.

channelIds

string

A comma delimited list of order channel Ids. If provided, only return orders from the specified channels.

orderStatusIds

string

A comma delimited list of order status Ids. If provided, only return orders in the specified order statuses.

pickupStatusIds

string

A comma delimited list of pickup status Ids. If provided, only return orders in the specified pickup statuses.

deliveryTypeIds

string

A comma delimited list of deliveryTypeIds. If provided, only return orders in the specified delivery types.

presaleStatusIds

string

A comma delimited list of presale status Ids. If provided, only return orders in the specified presale statuses.

orderTypeIds

string

A comma delimited list of order type Ids. If provided, only return orders in the specified order types.

sort

string

Used for sorting. Default is "OrderStatus Asc". Acceptable sort terms are: OrderNumber, OrderDate, OrderStatus, ShippingName, ProductAmt, ShippingAmt, SellerTaxAmt, OrderAmt

offset

int32

Used for paging. The number of order numbers to skip. Default is 0.

limit

int32

Used for paging. The maximum number of order numbers to return. Default is 10.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

200OK