Retrieve orders

post

https://{instance}.wshop.cloud/api/v1/orders/get

Returns a bare array of orders (paginated with page / limit). Date range filters are applied only when both bounds are provided. StoreBooking (e-reservation) orders are excluded unless orderType = StoreBooking.

Business errors are returned with HTTP 200 as {"success": false, "error": "ORDxxxx - message"}.

Recent Requests

Log in to see full request history

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

length ≤ 13

^(C[0-9]{11}|CT[0-9]{10})$

Target a single order. Order number: main order (C + 11 digits) or split order (CT + 10 digits)

clientId

integer

≥ 0

Customer id

created_from

string

Order creation date start (use with created_to). Format (YYYY-MM-DD HH:II:SS)

created_to

string

Order creation date end (use with created_from). Format (YYYY-MM-DD HH:II:SS)

begin

string

Last modification date start (use with end). Format (YYYY-MM-DD HH:II:SS)

end

string

Last modification date end (use with begin). Format (YYYY-MM-DD HH:II:SS)

shipped_from

date

Shipping date start, day precision (use with shipped_to)

shipped_to

date

Shipping date end, day precision (use with shipped_from)

orderStatus

string

enum

Cancelled is an alias of Canceled. ValidationPending covers orders waiting for payment or validation. Any other value returns an error.

orderCustomerStatus

string

enum

Detailed status filter; overrides orderStatus

storeStatus

string

enum

Store status filter (unknown values are ignored)

carrierCode

integer

Carrier id from /carriers/get

payment_method

object

orderType

string

enum

NoShipFromStore excludes ShipFromStore and StoreBooking orders. Unknown values are ignored.

Allowed:

email

string

Customer email; must belong to an existing customer (otherwise error ORD0071)

externalReference

string

length ≥ 1

transactionId

string

length ≥ 1

storeCode

string

length ≥ 1

storeId

integer

≥ 1

Store id the order is assigned to

promoCode

string

length ≥ 1

orderOrigin

string

enum

Allowed:

sentWs

integer

enum

Web-service export flag

Allowed:

sentGlopal

integer

enum

Restrict to Glopal orders with this sent flag (adds glopal to each order)

Allowed:

metadata

object

site

integer

≥ 1

Site ID (must exist)

page

integer

≥ 1

Defaults to 1

limit

integer

1 to 10000

Defaults to 10000

Responses

Language

Credentials

Bearer

URL

Loading…

Response

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

application/json