Get Order by Id

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

Returns the selected Order.

App Scope
ChannelPosRiderLoyalty
✔️(¹)✔️(²)✔️(³)✔️(²)

Depending on the Scope associated with your App, the returned Order will change to the following form:

(1) Scope Channel
Only Orders sent by the Channel will be returned

(2) Scope Pos and Loyalty
All Orders will be returned, regardless of the Channel

(3) Scope Rider
Only Orders will be returned, regardless of the Channel, in which delivery was requested via the Rider service. In order to be able to take in charge the delivery, you must use the Update Order Status endpoint and send a new CREATED status. At this point, you will be able to retrieve the order correctly.
An image is added to help understand the entire flow:

669
Path Params
string
required

The id of the Store whose Order you want to retrieve

string
required

The id of the Order you want to retrieve

Responses

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