Get Shipping Information

Introduction

The queryShippingInfo API facilitates pulling shipping information for an order.

Method

Service

API

Type

GET

rewardsOrderProcessing

queryShippingInfo → Explore

Synchronous

URI: https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/queryShippingInfo?orderNumber=<Order Number>

Retrieving Shipping 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-10-31T15:25:11-0600

The following query parameters need to be sent:

Parameter

Description

Type

Required

orderNumber

The order number for the order to return shipping information for.

String

Yes

Example: https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/queryShippingInfo?orderNumber=1234567890

Assuming the query was successful a JSON object will be returned in the response containing the following information:

Parameter

Description

Type

Required

current

An echo of the endpoint for this API.

The value is always https://api.blackhawknetwork.com/rewardsOrderProcessing/v1/queryShippingInfo for production and https://apipp.blackhawknetwork.com/rewardsOrderProcessing/v1/queryShippingInfo for the certification environment.

String

Yes

totalCount

Count of records returned

Integer

Yes

currentResults

The returned shipping information

Object

No

currentResults

Parameter

Description

Type

Required

Allowed Values

message

Result message from the shipper.

String

No

shipDate

Shipping date.

String (date-time)

No

shipMethod

Shipping method.

String

No

trackingNumber

Shipper tracking number.

String

No

orderStatus

Current order status.

String

No

See Order Status Reference for possible value returned.

{
    "current": "https://api.blackhawknetwork.com/rewardsOrderProcessing/v1/queryShippingInfo",
    "totalCount": 1,
    "currentResults": [{
        "message": "Requested Information.",
        "shipDate": "2019-10-14T04:00:00.000+0000",
        "shipMethod": "UPS_GROUND",
        "trackingNumber":"1Z999AA10123456784",     
        "orderStatus": "COMPLETE"
   }]
}

Order Status Reference

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 and has not yet shipped.

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.

REAL-TIME_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.

Error Code Reference

Listed below are common error codes you may receive when calling this API.

HTTP Status Code

Error Code

Message

Resolution

400

order.number.not.found

Order number not found.

Make sure you passed the correct order number.

Ensure the order you are trying to retrieve shipping information for can be accessed by your account.

400

search.criteria.orderNumber.required

Order number is required.

You did not send an order number. Ensure an order number is sent.

Sample Error Response

HTTP/1.1 400 Bad Request
Date: Wed, 30 Oct 2019 21:26:57 GMT
Server: Apache-Coyote/1.1
Content-Type: application/json
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
BHN-TRACE-ID: XboAIQrcuIoAAGiZDy4AAABs
Connection: close
Transfer-Encoding: chunked

{
  "errors" : [ {
    "errorCode" : "order.number.not.found",
    "message" : "Order number not found."
  } ]
}
HTTP/1.1 400 Bad Request
Date: Wed, 30 Oct 2019 21:20:06 GMT
Server: Apache-Coyote/1.1
Content-Type: application/json
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
BHN-TRACE-ID: [email protected]@pF4AAACr
Connection: close
Transfer-Encoding: chunked

{
  "errors" : [ {
    "errorCode" : "search.criteria.orderNumber.required",
    "message" : "Order number is required."
  } ]
}

Did this page help you?