Search Orders

post

https://vinoshipper.com/api/v3/p/orders/search

        Search and filter orders using POST request body. Same functionality as GET endpoint but allows
        for more complex query structures via JSON body. Useful for complex filtering scenarios.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Order search criteria

page

int32

required

≥ 1

Defaults to 1

Page number for pagination (1-based)

pageSize

int32

required

1 to 100

Defaults to 25

Number of results per page

status

array of strings

List of order statuses to filter by

status

Allowed:

shippingClass

array of strings

List of shipping class codes to filter by

shippingClass

processed

object

required

Date range filter supporting both ISO datetime strings and simple dates

shipped

object

required

Date range filter supporting both ISO datetime strings and simple dates

sort

array of objects

List of sort criteria to apply to results

sort

string | null

Search string to match against order number (LIKE query) or credit card obfuscated number (exact match)

guestOnly

boolean

required

Defaults to false

Filter to only show guest orders (orders without a registered customer)

device

array of strings

List of device identifiers to filter by

device

club

boolean | null

Filter for club orders. True returns only club orders, false returns only non-club orders. Omit or null for no filtering.

clubId

array of int32s

List of wine club IDs to filter by. Only applicable when club is not false.

clubId

storeId

array of int32s

List of store IDs to filter by

storeId

shipperId

array of int32s

List of shipper IDs to filter by

shipperId

onHold

boolean | null

Filter orders by requested ship date. True returns only orders with a future requested ship date (on hold), false returns only orders with a past or no requested ship date. Omit or null for no filtering.

orderNumber

array of strings

List of exact order numbers to match. Unlike 'search' which uses partial matching, this performs exact matching.

orderNumber

deliveryType

array of strings

List of delivery types to filter by. When multiple values are specified, orders matching any of the specified types are returned.

deliveryType

Allowed:

releaseId

array of int32s

List of club release IDs to filter by. Returns orders associated with any of the specified releases.

releaseId

contentsCustomized

boolean | null

Filter by whether the order's contents were customized from the default club offering. True returns only orders with customized contents, false returns only orders with standard (default offering) contents. Omit or null for no filtering.

Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Operation successful

400Request has failed validation

500Internal server error