Shipment Notification

Order Lineitem status update notification for SHIPPED Order Lineitems

ShipmentNotification Attributes

Physical Product

Name

Type

Description

Default Value

messageType

String

physicalItemShipmentNotification

shippedItem

shippedItem

ShippedItem

Name

Type

Description

uri

String

The HATEOAS link to get all shipped items by snEntityId

{
      "messageType" : "physicalItemShipmentNotification",
      "shippedItem" : {
        "uri" : "https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapipp.blackhawknetwork.com%2Forderservices%2Fv1%2Ffulfillmentorderitems%2Fshippeditems%3FsnId%3DRVR209NQB064F1PX0BZ7LZF3P0&data=04%7C01%7CGary.Prychoda%40bhnetwork.com%7Cc56f2f032bc74d1f08e808d8cf80625d%7C09f55992c50c45628657b1bd6acc36c5%7C0%7C0%7C637487497592179731%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=Vg6nbCo84wKBlQuEpIoj9Og11XGedn6IJTf4C4Ko%2BgQ%3D&reserved=0",
        "sourceName" : "BESGRP"
      }
    }

Digital Product

Name

Type

Description

Default Value

messageType

String

digitalItemShipmentNotification

shippedItem

DigitalShippedItem

DigitalShippedItem

Name

Type

Description

uri

Link

The HATEOS link to get item details

partnerOrderNumber

String

This is a human readable key specified by DDP that can easily be cross-reference to some unique identifier in the DDP OMS system.

partnerOrderNumber

String

The PO number

partnerOrderLineitemIdentifier

String

partnerSKU

String

fulfillmentOrderId

String

The unique id generated by BHN for each submitted order

bhnOrderNumber

String

BHN order number

bhnOrderItemId

String

The unique id generated by BHN for each submitted line item

bhnProductIID

String

Unique product IID that identifies which card is ordered

Either bhnProductIID or bhnProductUPC or bhnSkuId should be provided

itemDenomination

BigDecimal

This is the load value on card.

totalItemQuantity

Integer

shippedDate

Date

shippingEmailAddress

String

Shipping Email Address

{
      "messageType" : "digitalItemShipmentNotification",
      "shippedItem" : {
        "uri" : "https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapipp.blackhawknetwork.com%2Forderservices%2Fv1%2Ffulfillmentorderitems%2Fshippeditems%3FsnId%3D2XS0J0MKJW9GTTD65QP8P9V898&data=04%7C01%7CGary.Prychoda%40bhnetwork.com%7C67637e0abc6b402fb46c08d8cf82b218%7C09f55992c50c45628657b1bd6acc36c5%7C0%7C0%7C637487507528351290%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=lNtbFWVAz5MDyLSypJwCncWPMDY6t%2BsbVtlPnsyTMGs%3D&reserved=0",
        "partnerOrderNumber" : "test87276",
        "partnerPONumber" : "PONumber123",
        "partnerOrderLineItemIdentifier" : "12345678",
        "fulfillmentOrderId" : "9TK4A2JZ589NHHZ1VQMXG6RXZ4",
        "bhnOrderNumber" : "3090550",
        "bhnOrderItemId" : "854KLGQABJN0KGCPBPHM3LK19M",
        "bhnProductIID" : "61072",
        "itemDenomination" : 25.0,
        "totalItemQuantity" : 1,
        "egiftInfo" : "https://nam04.safelinks.protection.outlook.com/?url=https%3A%2F%2Fapipp.blackhawknetwork.com%2Forderservices%2Fv1%2Ffulfillmentorder%2F9TK4A2JZ589NHHZ1VQMXG6RXZ4%2Ffulfillmentorderitems%2F854KLGQABJN0KGCPBPHM3LK19M%2Fegifts%2F&data=04%7C01%7CGary.Prychoda%40bhnetwork.com%7C67637e0abc6b402fb46c08d8cf82b218%7C09f55992c50c45628657b1bd6acc36c5%7C0%7C0%7C637487507528351290%7CUnknown%7CTWFpbGZsb3d8eyJWIjoiMC4wLjAwMDAiLCJQIjoiV2luMzIiLCJBTiI6Ik1haWwiLCJXVCI6Mn0%3D%7C1000&sdata=irbErxvc4%2BOrsK3cNknv6bUsyfdS6kvm5KfcJJ%2BUwiM%3D&reserved=0",
        "bhnProductUPC" : "07675010473",
        "sourceName" : "ORDERCENTRAL10"
      }
    }

🚧

The Ship Notification (SN) is a collection of "order line items" shipped, not 'orders' shipped. There is no SN for orders.

Example, it is possible for you to receive a SN for 2 items from an order that has 3 items, i.e., 1 item has yet to ship. You have to keep track and roll-up/account for the order line items statuses in your system of record.

Alternatively, you can query BHN's order 'status' (vs. order line item status) and update your system of record.


Did this page help you?