ListAllEgiftsByOrderLineItem

**ListAllEgiftsByOrderLineItem

Description**

This API is for retrieving a list of egifts by order line item.

EndPoint

HTTP Method: GET

End point: https://api.blackhawknetwork.com

Resource: /orderservices/v1/fulfillmentorder/{fulfillmentorderid}/fulfillmentorderitems/{orderlineitemid}/egifts

URI: https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/X2DKSDQ743DL6XJ75K58RACBRM/fulfillmentorderitems/3GDABNP0C7H17J7A8SL8RS3TXM/egifts&page=0&size=3

*Request Header Attributes

Name

Type

Required

Max Length

Description

merchantid

String

Y

11

Merchant ID MID. BHN issued unique identifier for the merchant who is making the call.

requestId

String

Y

50

An unique identifier of the request. It should a unique value for every request.

Path Parameter

Name

Type

Required

Max Length

Description

fulfillmentorderid

GUID

Y

26

Fulfillment order id

orderlineitemid

GUID

Y

26

BHN order line item

Request Parameter

Name

Type

Required

Max Length

Description

page

Integer

N

The page number of the complete result set.

size

Integer

N

The total number of results per page which matches the searching criteria. If not specified, defaults to 20

Response Header Attributes

Standard header attributes only.

Response Attributes

Name

Type

Description

totalElements

Integer

Represents total orders in the request.

totalPages

Integer

Represents a total number of pages in the request.

numberOfElements

Integer

Represents a total number of orders in the page.

first

Boolean

Represents if the current page is first.

last

Boolean

Represents if the current page is last.

size

Integer

Represents size of the request.

content

List

The array of entities that match the query criteria and represent the subset of entities specified by the pagination related query string parameters.

_links

Link

Represents the URI of the egifts

EgiftByLineItemResponse

Name

Type

Description

egiftURI

String

egift entity Id

egiftURL

String

egift url for Activation Spot

Link

Name

Type

Description

rel

String

The relationship value with the current page(see Link Notes*)

href

String

Url of the order

Link Notes*: next, first, prev, last, self

**Http Response Codes

Success Code** 

HTTP Status Code

Description

200

Request was processed successfully and the response is returned

Error Code

HTTP Status Code

Error Code

Description

Notes

400

invalid.request

page number entered is more than the number of page available

400

invalid.request

requires BHN OrderItemId in the path

404

resource.not.found

Attempt to retrieve a non existing resource.

404

404

com.bhn.general.attempt.to.call.nonexistent.service

URL incorrect

403

not.authorized.to.access.resource

The requestor is not authorized to access the requested resource.

502

502

com.bhn.general.service.error

503

503

com.bhn.general.service.error

504

504

com.bhn.general.service.timeout

500

500

Internal server error

Samples

https://apiqa.blackhawknetwork.com/orderservices/v1/fulfillmentorder/X2DKSDQ743DL6XJ75K58RACBRM/fulfillmentorderitems/3GDABNP0C7H17J7A8SL8RS3TXM/egifts
HTTP/1.1
Accept-Encoding: gzip,deflate
requestId: HPCDKMSV763K2VGHCKQQ09QSGM
MerchantId: 60300004232
Host: apiqa.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
{
 "last": true,
 "totalElements": 1,
 "totalPages": 1,
 "numberOfElements": 1,
 "first": true,
 "size": 100,
 "content": [
 {
 "egiftURI": "CSFQTWBVN6YNA08F953HVZQS90"
 }
 ],
 "_links": {
 "first": {
 "href": "https://apiqa.blackhawknetwork.com/orderservices/v1/fulfillmentorder/X2DKSDQ743DL6XJ75K58RACBRM/fulfillmentorderitems/3GDABNP0C7H17J7A8SL8RS3TXM/egifts?page=0"
 },
 "last": {
 "href": "https://apiqa.blackhawknetwork.com/orderservices/v1/fulfillmentorder/X2DKSDQ743DL6XJ75K58RACBRM/fulfillmentorderitems/3GDABNP0C7H17J7A8SL8RS3TXM/egifts?page=0"
 },
 "self": {
 "href": "https://apiqa.blackhawknetwork.com/orderservices/v1/fulfillmentorder/X2DKSDQ743DL6XJ75K58RACBRM/fulfillmentorderitems/3GDABNP0C7H17J7A8SL8RS3TXM/egifts?page=0"
 }
 }
}

Did this page help you?