API Reference

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
≥ 1
Defaults to 1

Page number for pagination (1-based)

int32
1 to 100
Defaults to 25

Number of results per page

status
array of strings

List of order statuses to filter by

status
shippingClass
array of strings

List of shipping class codes to filter by

shippingClass
processed
object

Date range filter supporting both ISO datetime strings and simple dates

shipped
object

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)

boolean
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
Responses

401

Authentication failed

403

Insufficient permission

404

Not Found

Updated 6 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!

Updated 6 months ago