Get Order Information

Introduction

The orderInfo API facilitates pulling order information for an existing order.

Method

Service

API

Type

GET

rewardsOrderProcessing

orderInfo → Explore

Synchronous

URI: https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/orderInfo/byKeys?orderNumber=<Order Number>
URI: https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/orderInfo/byKeys?requestId=<Request ID>&clientProgramNumber=<Client Program Number>

Note: EITHERorderNumber OR requestId and clientProgramNumber must be sent to retrieve order information.

Retrieving Order Information

To send the request for shipping information we need to send the following information in the request header:

Parameter

Description

Type

Required

Default Value

merchantId

The Merchant ID (MID) is a string identifier, provided to you by your account manager that varies based on the product type.

String

Yes

None

requestId

A unique identifier for each request provided by you (the caller).

String

Yes

None

In our example we will be sending the following values:

Content-Type: application/json
merchantId: 60300003779
requestId: 2019-11-05T13:47:01-0600

There are two method to retrieve the order information, by orderNumber or by requestId and clientProgramNumber.

Retrieving Order Information by Order Number

To retrieve the order information by order number we need to send the order number as a query parameter.

Parameter

Description

Type

Required

orderNumber

The order number for the order to information for.

String

Yes

Example: https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/orderInfo/byKeys?orderNumber=701099988

Retrieving Order Information by Request ID and Program Number

To retrieve the order information by the request id and program number we need to send the the following query parameters:

Parameter

Description

Type

Required

requestId

The requestId returned from the order API call.

String

Yes

clientProgramNumber

The program identifier (or Quote ID) for the program the order was placed under.

String

Yes

Example: https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/orderInfo/byKeys?requestId=7894561234564&clientProgramNumber=993564408

Response

Success Response

If the order is found an HTTP status code of 200 will be returned with a JSON object containing the following information:

Parameter

Description

Type

Required

Allowed Values

orderNumber

The order number for this order.

String

No

clientProgramNumber

The program number or Quote ID the order was placed under.

Integer

No

requestId

The requestId for the request made to the order API.

String

No

orderStatus

Current order status.

String

No

See Order Status Reference for possible value returned.

dateSubmitted

The date the order was placed.

String (date-time)

No

numberOfCards

The number of cards contained within the order.

Integer

No

totalCost

The total cost of the order.

Number

No

{
   "orderNumber": "701099988",
   "clientProgramNumber": 993564408,
   "requestId": "7894561234564",
   "orderStatus": "Complete",
   "dateSubmitted": "2019-11-05T18:01:39.343+0000",
   "numberOfCards": 2,
   "totalCost": 100
}
{
   "clientProgramNumber": 43608108,
   "requestId": "9876543210",
   "orderStatus": "In Process",
   "dateSubmitted": "2020-05-20T19:30:16.503+0000"
}
{
   "orderNumber": "401149752",
   "clientProgramNumber": 95000937,
   "requestId": "147852369",
   "orderStatus": "Funding Hold",
   "dateSubmitted": "2020-05-20T19:29:52.303+0000",
   "numberOfCards": 1,
   "totalCost": 41.25
}

Error Response

If the orderNumber or requestId is not found for the clientProgramNumber passed then an HTTP status code of 400 will be returned.

{
  "errors" : [ {
    "errorCode" : "order.not.found",
    "message" : "Order not found based on parameters provided."
  } ]
}
{
    "errors": [{
            "errorCode": "technical.error.resubmit",
            "message": "Technical error encountered while processing order request. Order was not processed. It is safe to submit a new order request."
        }
    ]
}

Order Status Reference

📘

These status codes will only be returned if the order is found.

orderStatus Value

Notes

Cancelled

Order was cancelled before shipping.

Complete

The order completed successfully. This is the final status for a successfully delivered order.

Declined

The order was declined before shipping.

Error

An error was encountered when placing the order. The order was not shipped.

Funding Hold

The order is pending funding. It has not shipped yet.

Funding Posted

The processor has successfully received the order. The order will be shipped soon.

In Process

The order is processing.

Not All Records Funded

Not all the records in the order could be funded. The order has not shipped.

Not All Records Reversed

Not all records in the order could be reversed.

Failure

An order using a real time API failed. This is a final status. The order must be resubmitted.

Note: Real-time calls can only be made for eGift and Virtual Prepaid Accounts so there will never be a shipment.

Shipped

Blackhawk Network has been notified that the order has shipped.

Note: Shipped orders are moved to "COMPLETE" status nightly.

Successfully Sent To Processor

The order has been sent to the processor. Blackhawk Network is waiting for confirmation of shipment.


Did this page help you?