GetItemShipmentNotifcationBySnId

GetItemShipmentNotifcationBySnId

Description

This API is for retrieving a Shipment Notification of Order Items shipped by SN ID (Shipment ID)

EndPoint

HTTP Method: GET

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

Resource: /orderservices/v1/fulfillmentorderitems/shippeditems

Sample URI: https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorderitems/shippeditems?page=0&size=2&sort=createdTimestamp%2Cdesc&snId=LR435LH2GC48R5KMYQGYA6XW7M

*Request Header Attributes

Name

Type

Required

Max Length

Description

requestId

String

Y

128

An unique identifier of the request.

If the same requestId is used within 24 hrs, the response for the previous requestId will be sent.

merchantid

String

Y

11

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

Request Parameter

Name

Type

Required

Max Length

Description

snId

String

Y

Inbound Shipment Notification Id extracted from the uri in the Shipment SNS Notification

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

sort

Attribute Name

N

The parameter by which to sort the results - ASC, DESC.

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.

The attributes are different based on the verboselevel.

_links

List

Represents Uri of the order

OrderItems

Name

Type

Description

partnerOrderNumber

String

Partner Order Number

partnerPONumber

String

Partner PO Number

bhnOrderNumber

Integer

BHN Order Number

fulfillmentOrderId

String

Fulfillment Order Id

partnerOrderLineItemIdentifier

String

Partner Order Line Item Identifier

partnerSKU

String

Partner Sku

bhnOrderItemId

String

BHN Order Item Id

bhnProductIID

Integer

BHN Order Item Id

bhnProductIID

String

Item Denomination

totalItemQuantity

Integer

Item Quantity

shippingMethodRequested

String

Shipping Method Requested

shippingMethodActual

String

Shipping Method Actual

shippedOnDate

String

Shipped On Date

shippingEmailAddress

String

Shipping Email Address

shipmentTrackingNumber

String

Shipment Tracking Number

shippingAddress

ShippingAddress

Shipping Address

shipmentCarrier

String

Shipment Carrier

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

400

400

requires valid shipment notification Id in the queryParams

400

400

page number entered is more than the number of page available

404

404

Attempt to retrieve a non existing resource.

404

404

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

403

403

com.bhn.general.service.call.unauthorized

500

500

Internal server error

502

502

com.bhn.general.service.error

503

503

com.bhn.general.service.unavailable

504

504

com.bhn.general.service.timeout

Samples

GET https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorderitems/shippeditems?page=0&sort=createdTimestamp%2Cdesc&size=2&snId=LR435LH2GC48R5KMYQGYA6XW7M HTTP/1.1
Accept-Encoding: gzip,deflate
merchantId: 70300004504
requestId: MXFHS2Z67W2G45S1M3XPBHD1HH
Host: api.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
{
   "sort": [   {
      "direction": "DESC",
      "property": "createdTimestamp",
      "nullHandling": "NATIVE",
      "descending": true
   }],
   "first": true,
   "totalPages": 3,
   "totalElements": 6,
   "numberOfElements": 2,
   "size": 2,
   "content":    [
            {
         "partnerOrderNumber": "648399508",
         "partnerPONumber": "FLYERSPTS000008045594888532429",
         "bhnOrderNumber": "2280115",
         "fulfillmentOrderId": "HF0J2GGA5G553ZLSGRP5J90JLW",
         "partnerOrderLineItemIdentifier": "648399508_07675013945B250001",
         "partnerSKU": "07675013945B2500",
         "bhnOrderItemId": "KGW1T4G6YKJ5JQG8BFXRKLF7SH",
         "bhnProductIID": "67763",
         "itemDenomination": 25.0,
         "totalItemQuantity": 1,
         "shippingMethodRequested": "ups2ndday",
         "shippingMethodActual": "UPS 2nd Day",
         "shippedOnDate": "2018-01-23T23:48:22.665Z",
         "shippingEmailAddress": "5DJDL9N96PRCXFRB3GVM9XB87062571MC2NPKLMG75SYV2J3YTZ0",
         "shipmentTrackingNumber": "Test53381",
         "shippingAddress":          {
            "firstName": "Jane N",
            "middleName": "R",
            "lastName": "AYYAPPAN doe",
            "addressOne": "4433 Test dr",
            "addressTwo": "suiteB",
            "state": "VA",
            "zipCode": "19801-2920",
            "city": "Pleasanton",
            "countryCode": "USA",
            "phoneNumber": "3021863429"
         },
         "shipmentCarrier": "UPS"
      },
            {
         "partnerOrderNumber": "648399508",
         "partnerPONumber": "FLYERSPTS000008045594888532429",
         "bhnOrderNumber": "2280115",
         "fulfillmentOrderId": "HF0J2GGA5G553ZLSGRP5J90JLW",
         "partnerOrderLineItemIdentifier": "648399508_07675013945B250002",
         "partnerSKU": "07675013945B2500",
         "bhnOrderItemId": "MZ6KHGLNDK0M4M667R0JASZ10M",
         "bhnProductIID": "67763",
         "itemDenomination": 25.0,
         "totalItemQuantity": 1,
         "shippingMethodRequested": "ups2ndday",
         "shippingMethodActual": "UPS 2nd Day",
         "shippedOnDate": "2018-01-23T23:48:22.665Z",
         "shippingEmailAddress": "5DJDL9N96PRCXFRB3GVM9XB87062571MC2NPKLMG75SYV2J3YTZ0",
         "shipmentTrackingNumber": "Test53381",
         "shippingAddress":          {
            "firstName": "Jane N",
            "middleName": "R",
            "lastName": "AYYAPPAN doe",
            "addressOne": "4433 Test dr",
            "addressTwo": "suiteB",
            "state": "VA",
            "zipCode": "19801-2920",
            "city": "Pleasanton",
            "countryCode": "USA",
            "phoneNumber": "3021863429"
         },
         "shipmentCarrier": "UPS"
      }
   ],
   "_links":    {
      "next": {"href": "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorderitems/shippeditems?size=2&sort=createdTimestamp%2Cdesc&snId=LR435LH2GC48R5KMYQGYA6XW7M&page=1"},
      "first": {"href": "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorderitems/shippeditems?size=2&sort=createdTimestamp%2Cdesc&snId=LR435LH2GC48R5KMYQGYA6XW7M&page=0"},
      "last": {"href": "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorderitems/shippeditems?size=2&sort=createdTimestamp%2Cdesc&snId=LR435LH2GC48R5KMYQGYA6XW7M&page=2"},
      "self": {"href": "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorderitems/shippeditems?size=2&sort=createdTimestamp%2Cdesc&snId=LR435LH2GC48R5KMYQGYA6XW7M&page=0"}
   }
}

Did this page help you?