Retrieves information about the specified order

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Metadata
orderIDs
object
fast_search
object

Enable the fast search

fields
object

Fields that should be returned

projectID
object

Filter by project

offset
object

Where to start pagination

limit
object

Limit of orders returned

mode
object

How to filter a field with different values chosen ('AND', 'OR', 'MIX')

mode_fields
object

Filters than can choose more than a value

order
object

Specify the order of the result set

order_states
object

Filters orders by order state

payment_states
object

Filters orders by payment state

shipping_states
object

Filters orders by shipping state

fulfillment
object

Filters orders by the fulfillment of any of it's product's warehouse

warehouse
object

Filters orders by it's products' warehouse of origin

giftcard
object

Filters orders containgin giftcard service product associated to the given code. It should always return only one order

date
object

Filters order by date

return_id
object

Filter orders for the given return authorization number

license_data
object

Filters orders by license

country
object

Filters orders from a country

productID
object

Filter orders that contain the given product's internal identifier

refID
object

Filter orders that contain the given product's SKU

email
object

Filter orders that contain the given product by customer email

voucher
object

Filters orders that used the given voucher

campaign
object

Filters orders that used the given discount campaign

rule
object

Filter order that followed the given discount rule

sell_type
object

Filters orders cby seller type

resellerID
object

Filter orders by the resellers internal identifier

affiliate_trackID
object

Filters orders by affiliate tracking ID

sellerID
object

Filter orders by the sellers internal identifier

userID
object

Filters orders by user internal identifier

is_b2b
object
ugroupIDs
object

Filter orders for the given user group

trackID
object

Filter orders by the tracking number

ip
object

Filter orders done from the given IP address

product_type
object

Filters orders containgin products of the given type

service_type
object

Filters orders containgin service products of the given service_type

product_upc
object

Filter orders that contain the given product's UPC

product_ean
object

Filter orders that contain the given product's EAN

product_jan
object

Filter orders that contain the given product's JAN

product_isbn
object

Filter orders that contain the given product's ISBN

shippingID
object

Filter orders by the shipping identifier

total_amount
object

Filter orders by the total amount

shipping
object

Filter the order by shipping address data

invoicing
object

Filter the order by invoice address data

payment
object

Filter orders by payment data

cb
object

Filter orders by cb

cb_hashed
object

Filter orders by payment cb (hashed)

paypal_email
object

Filter orders by the customers paypal email

card_ending
object

Filter orders by last numbers of the card used to pay

flag
object

Filters orders with the given flag

changelog
object

Filters orders by changelog message

safe_phone
object

Filter orders by the phone used to verify the customers identity

variantID
object

Filter orders by product variant internal identifier

subscriptionID
object

Filter orders belonging to a subscription

order_type
object

Filter orders by type

bundle_elements
object

Filter orders that contain bundle elements

marketplace_name
object

Filter orders by marketplace name

marketplace_order_id
object

Filter orders by marketplace order id

string
required

The Client identifier provided by Scalefast

string
required

The OAuth2 access token

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json