Using Endpoint

A separate and secured URL endpoint is provided by Steadfast that can be accessed using Authentication API Key.

3.1 Authentication

The authentication mechanism is the same as described on the Order API page.

3.2 Order Endpoint

The order endpoint is given below.

Order Status API

POST https://middleware.podapp.com.au/passthrough/customerorderstatus

Headers

Name	Type	Description
X-Steadfast-Api-Key	string	API Key Name that must be passed in request headers

Request Body

Name	Type	Description
request body	json	Please see below.

200 data successfully retrieved.

Sucess Response

{
    "Message": "Ok",
    "ResponseMessage": {
        "Success": true,
        "TokenChanged": false,
        "ErrorMessage": "",
        "NewToken": "00000000000000000000000000000000"
    },
    "TotalQueryRows": 0
}

401

Error Response 1

{
    "StatusCode": 401,
    "Message": "Authentication failed. Invalid Api Key."
}

Error Response 2

{
    "StatusCode": 401,
    "Message": "No Api Key is provided. Api Key is missing in request headers."
}

404 If the request URL is wrong like /passthrough/gerardorder1

Error Response 1

{
    "StatusCode": 404,
    "Message": "Endpoint gerardorder Not Found. Api in Not Active."
}

Error Response 2

{
    "StatusCode": 404,
    "Message": "Endpoint gerardorder1 Not Found. No Api is configured at gerardorder1."
}

500 In case of any other server error

Error Response 1

{
    "StatusCode": 500,
    "Message": "There is error while calling Outbound API."
}

3.3 Order Status Request

Example Request 1

{
    "CustomerRef": "72906"
}

3.4 Order Status Response

Example Response 1

{
    "Success": true,
    "ErrorMessage": "",
    "CustomerRef": "TEST007",
    "ConsRef": "TrackID007",
    "TripStatus": "Ended",
    "OrderFound": true,
    "JobNo": "966043",
    "Url": "test.com/track/TrackID007",
    "DispatchDate": "0001-01-01T00:00:00+00:00"
}

Example Response 2

{
    "Success": true,
    "ErrorMessage": "",
    "CustomerRef": null,
    "ConsRef": null,
    "TripStatus": null,
    "OrderFound": false,
    "JobNo": null,
    "Url": null,
    "PODdate": "0001-01-01T00:00:00+00:00"
}

OrderFound is the key field to check. If that is true, it means the order status has been fetched and returned successfully. In case it is false, it means the order is not found in our system or does not exist.