Get Order

This endpoint is for fetching the details of an order.

Request

Security:

JWT

path Parameters

orderId

required

string

ID of order to retrieve

header Parameters

Authorization

required

string

Default: Bearer {$$.env.access_token}

Responses

200

The order response

403

Insufficient permissions to view an order

404

Order id not found

get/orders/{orderId}

Request samples

curl
C#
Node.js

curl -i -X GET \
  'https://api.tyro.com/connect/orders/{orderId}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Response samples

application/json

{"id": "order-identifier-in-tyro-connect",
"locationId": "tc-merchant-2000",
"origin": {"orderId": "2f8922fb-235f-40c6-af9a-3d6b46ce9635",
"orderReference": "Order for Tom",
"name": "Charlie's Preorder App"
},
"items": [{"id": "unique-item-id",
"sku": "sku-known-to-the-pos",
"description": "Amazing cheese burger",
"unitPrice": {"currency": "AUD",
"amount": 2000
},
"discounts": [{"currency": "AUD",
"amount": 1000,
"description": "Half price cheese burgers on the first of the month"
}
],
"modifiers": [{"id": "uuid-3636-101",
"sku": "634",
"description": "Bacon",
"unitPrice": {"amount": 0
},
"quantity": 1
}
],
"allergens": [{"description": "Fish"
},
{"description": "Nuts"
}
],
"quantity": 1
}
],
"discounts": [{"currency": "AUD",
"amount": 200,
"description": "Student discount"
}
],
"surcharges": [{"currency": "AUD",
"amount": 200,
"description": "Public Holiday"
},
{"currency": "AUD",
"amount": 200,
"description": "Plastic take away containers"
}
],
"tip": {"currency": "AUD",
"amount": 150
},
"total": {"currency": "AUD",
"amount": 1350
},
"table": {"id": "B1",
"section": "Bar"
},
"status": "ACCEPTED",
"customers": [{"firstName": "Daniel"
},
{"firstName": "Elizabeth"
}
],
"fulfilment": {"type": "PICK_UP"
},
"paymentStatus": "CLOSED"
}