createOrder API

Overview

This service creates a fulfillment order with its order line items.

Method

Service Name

Service Type

PUT

fulfillmentorder

Asynchronous

End point: https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/

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 by the Tenant ID, the response for the previous requestId will be sent.

merchantId

String

Y

11

An identifier that was issued by BHN to each contractual legal entity for billing purposes.

Content-Type

String

N

50

If not passed, default value will be set to application/json.
To support International characters use charset=UTF-8 or appropriate content encoding type.
Example, application/json;charset=utf-8

Request Elements

Name

Type

Required

Max Length

Decription

bhnOrderType

String

N

Type of order to be placed. CUSTOMER, BULK_ISSUANCE (Used for bulk eGift with file output only), INV_REPLENISH (Used for Retail Inventory Replenishment) and REPRINT (Restricted-Do not use unless authorization provided by BHN)

CUSTOMER as default value if not passed

partnerOrderNumber

String

Y

30

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

In addition to partnerPONumber, combination of partnerOrderNumber & partnerPONumber is used to identify duplicate orders if partnerPONumber is provided

partnerOrderDate

DateTime

Y

The order date. ISO.DATE_TIME, representing when the order was submitted by purchaser.

partnerPONumber

String

N

50

The PO number.

In addition to partnerOrderNumber, combination of partnerOrderNumber & partnerPONumber is used to identify duplicate orders if partnerPONumber is provided

partnerCustomerIdentifier

String

N

100

The partner customer reference id

loadValuePhase

loadValuePhase

N

The activation phase. Indicates at what state of the order the card will get activated

activationDate

Date

C

The activation date in ISO date format. activationDateis mandatory if loadValuePhase is ONDATE

packagingType

packagingType

N

PackagingType for the order. Defines how to package the cards in the order. By default MULTICARDONCARRIER. Not required for eGift

totalOrderQuantity

Interger

Y

The total cards.

totalOrderValue

BigDecimal

Y

The total load value.

billingInfo

BillingInfo

Y

The billing info.

otherInfo

OtherInfo

N

Restricted. Please consult with your account manager.

orderLineItems

List

OrderLineItem

Y

10000

A collection of Line Items. An order can have a max of 10,000 line items

partnerPersonIdentifyingNumber

String

N

This is purchaser level information.

riskAttributes

riskAttributes

C

A collection of risk attributes which will be used to risk assess the order. Required for Compliance

partnerMemoNotes

String

N

255

Note or Memo that will be attached to the order. This is informational only and not passed to Fulfillment Providers

partnerCorrelationId

String

N

255

RESTRICTED-Do not use unless authorization provided by BHN

messageReasonCode

String

N

255

RESTRICTED-Do not use unless authorization provided by BHN

bhnOrderType

Value

Description

CUSTOMER

Regular physical card customer order

BULK_ISSUANCE

Bulk issuance Order; Used for bulk eGift with file output only

INV_REPLENISH (Available in March 2021)

Used for Retail Inventory Replenishment via Online Fulfillment, Card Only. Activation via POS or BLAST only.

BillingInfo

Name

Type

Required

Max Length

Description

billingAddress

Address

C - Required for Risk Check

Billing Address.

billingEmailAddress

String

C - Required for Risk Check

255

Billing Email Address.

billingPersonId

String

C - Required for Risk Check

100

Include the content in CDATA. This represents the billing account id

One (1) of the above element is required.

OrderItem

Name

Type

Required

Max Length

Description

partnerOrderLineItemIdentifier

String

N

100

This is the Partner reference for the order line item.

bhnProductIID

String

C

10

Unique product IID that identifies which card is ordered

Either bhnProductIID or bhnProductUPC or partnerSKU should be provided

bhnProductUPC

String

C

12

BHN product UPC. Default IID must be set up for UPC if bhnProductUPC will be used for product info in request.

Either bhnProductIID or bhnProductUPC or partnerSKU should be provided

partnerSKU

String

C

100

Partner generated SKU. Either bhnProductIID or bhnProductUPC or partnerSKU should be provided

bhnSkuId

String

N

26

BHN generated GUID.

totalItemQuantity

Integer

Y

Number of cards ordered in the order line item.

itemDenomination

BigDecimal

Y

This is the load value on card. ([0-9 .]+)? (Japanese no dot) Country currency

cardPersonalization

CardPersonalization

N

Name on card and message on card. Only specify for Open Loop Cards

carrierPersonalization

CarrierPersonalization

N

Name and Message on carrier.

returnInfo

returnInfo

N

shippingInfo

shippingInfo

Y

Where to ship, shipping method, shipping cost

registerInfo

registerInfo

N

For Incentive open-loop products, the DP may wish to register the card to the cardholder, whom may or may not be the shipping recipient.

A new “Registration Info” node has been introduced where the DP can specify a different Cardholder info (name, address, etc.), which can be used for

  •    Issuance of a card
    
  •    Registration of the card to card-holder (if different from Shipping Recipient)
    

fulfillmentInstructions

String

N

RESTRICTED and not commonly used.-Check with IM prior to use of this field

Base64 encoded FSP instructions.

This value is purely a passthru to certain FSP handling non-typical fulfillment order.

expediteFulfillment

Boolean

N

Values - true or false. Default to false.

imageurls

imageurl

N

URL of the Image used for card, carrier, packaging slip or marketing insert.

Predefined names (enums) for image url names.

cardImageUrlFront

String

N

URL of the front Image of the card

additionalinfos

additionalinfo

N

Special information sent to FSP to fulfill order request

The assigned name values will be agreed on with DDP and FSP then onboarded into Order Central prior to order placement

bomId

String

C

50

Bill of material. Either sent as part of the Order Request or Fulfillment Management Platform can house the mapping rules based on an order or line level item. Please work with Implementation Manager for further clarification.

digitalDistributionChannel

digitalDistributionChannel

N

The channel for eGift delivery

partnerTrackingNumber

String

N

RESTRICTED-Do not use unless authorization provided by BHN

partnerProxyCardnumber

String

N

RESTRICTED-Do not use unless authorization provided by BHN

partnerCampaignId

String

N

RESTRICTED-Do not use unless authorization provided by BHN

accountCreated

Boolean

N

RESTRICTED. Values - true or false. Default to false.-Do not use unless authorization provided by BHN

📘

orderable items

We use bhnProductIID (5-6 numeric product identifier) or bhnProductUPC to order an item using our product identifiers. Using bhnProductIID is the most typical and default options.

However, it is possible to create cross-reference between our product identifiers and you 'partner' identifer. Please consult your Business Partner if this option is off interest. Only if this setup is completed can you place an order using your product identifiers. This capability (a.k.a., 'Static IID') will allow you to place an order, e.g., 'Acme $25'. Internally, we will cross-reference this to IID 123456, and proceed with the order fulfillment.

RiskAttributes

Name

Type

Required

Max Length

Description

riskAsessmentOrderType

String

C

httpUserAgent

String

C

Http header identifying the application making the http request

daysSinceLastPurchase

Integer

C

Days since the last purchase on the platform was made by the user.

numberOfPastPurchases

Integer

C

Total number of purchases made by the user on the platform. Could be non gift card purchases

numberOfPastDisputes

Integer

C

Total number of disputes/chargebacks made by the user on the platform.

numberOfReturns

Integer

C

Total number of returns made by the user on the platform.

guestCheckout

Boolean

Y

Whether order was placed by a logged in user or guest

existingCustomer

Boolean

C

This flag indicates that whether the customer is existing customer or new customer

customerType

String

C

Values B2C, B2B or B2B2C

promoCode

String

C

Discount code that was successfully applied to the cart

member

member

C

List of attributes to provide more information on member

device

device

C

List of attributes to provide more information on device used

rewardpoints

rewardpoints

C

List of attributes to provide reward point details

login

login

C

List of attributes to provide details about member's login history

creditCard

creditCard

C

List of attributes to provide relevant credit card details

📘

Risk Attributes

These risk attributes will be available from march 2021.

CardPersonalization

Name

Type

Required

Max Length

Decription

nameOnCard

String

N

22

Name as it appears on the card including the space

Mandatory for Open Loop cards and Optional for Closed Loop Cards.

Pattern - ([a-zA-Z0-9 -.]+)?"

messageOnCard

String

N

22

The message on the card including the space

Pattern - ([a-zA-Z0-9 -.]+)?"

line5

String

N

26

Text on the side of the card

Pattern - ([a-zA-Z0-9 -.]+)?"

line6

String

N

26

Text on the back of the card

Pattern - ([a-zA-Z0-9 -.]+)?"

CarrierPersonalization

Only applicable for carrier designs supporting personalization

Name

Type

Required

Max Length

Description

personalMessage

String

N

180

fromName

String

N

100

toName

String

N

100

Reserved.

customcarriermessage1

String

N

180

Reserved.

customcarriermessage2

String

N

180

Reserved.

customcarriermessage3

String

N

180

Reserved.

customcarriermessage4

String

N

180

Reserved.

customcarriermessage5

String

N

180

Reserved.

customcarriermessage6

String

N

180

Reserved.

customcarriermessage7

String

N

180

Reserved.

customcarriermessage8

String

N

180

Reserved.

customcarriermessage9

String

N

180

Reserved.

customcarriermessage10

String

N

180

Reserved.

ReturnInfo

Name

Type

Required

Max Length

Description

returnAddress

Address

C

Return Address.

returnEmailAddress

String

C

255

Return Email Address.

returnPersonId

String

C

100

Return Person Id. his represents the return account id

ShippingInfo

Name

Type

Required

Max Length

Description

shippingAddress

Address

C - Required for Risk Check

Shipping Address. For Physical order, either shippingAddress or shippingPersonId should be provided

shippingPersonId

String

C

100

Shipping Person Id. his represents the shipping account id

shippingEmailAddress

String

C - Required for Risk Check

255

Shipping Email Address. shippingEmailAddress is mandatory for eGift order

courierShippingAccountNumber

String

N

50

Courier Shipping Account Number.

requestedShipMethod

String

Y

20

requested Ship Method. Please contact Account or Implementation manager for more detail.

RegisterInfo

Name

Type

Required

Max Length

Description

registerAddress

Address

C

Register Address.

registerEmailAddress

String

C

255

Register Email Address.

registerPersonId

String

C

100

Register Person Id. his represents the register account id

OtherInfo

Name

Type

Required

Max Length

Description

otherInfo01

String

N

1024

The Other Info 1

otherInfo02

String

N

1024

The Other Info 2

otherInfo03

String

N

1024

The Other Info 3

otherInfo04

String

N

1024

The Other Info 4

otherInfo05

String

N

1024

The Other Info 5

otherInfo06

String

N

1024

The Other Info 6

otherInfo07

String

N

1024

The Other Info 7

otherInfo08

String

N

1024

The Other Info 8

otherInfo09

String

N

1024

The Other Info 9

otherInfo010

String

N

1024

The Other Info 10

address

Name

Type

Required

Max Length

Description

attnTo

String

N

100

Attention To.

firstName

String

Y

30

The first name.

middleName

String

N

30

The middle name.

lastName

String

Y

30

The last name.

company

String

N

35

The company name.

addressOne

String

Y

35

The line address one.

addressTwo

String

N

35

The line address two.

addressThree

String

N

35

The line address three.

state

String

Y

30

If countryCode is USA, then state is mandatory and must be a valid US stateCode. Else, state is optional.

zipCode

String

Y

20

The zip code.

city

String

Y

50

The city name.

countryCode

String

Y

3

The country code. ISO 3166-1 alpha 3 country code

phoneNumber

String

C

30

The phone number.

No special characters or spaces. Mandatory, If the partner is configured to use last four digits of the phone number for activation

districtOrCounty

String

N

100

The district or country.

imageurl

Name

Type

Required

cardfront

String

N

cardback

String

N

carrier_p001

String

N

carrier_p002

String

N

carrier_p003

String

N

carrier_p004

String

N

carrier_p005

String

N

carrier_p006

String

N

carrier_p007

String

N

carrier_p008

String

N

packagingslip_p001

String

N

packagingslip_p002

String

N

packagingslip_p003

String

N

packagingslip_p004

String

N

marketinginsert_p001

String

N

marketinginsert_p002

String

N

marketinginsert_p003

String

N

marketinginsert_p004

String

N

LoadValuePhase

Value

Description

ON_DATE

This option allows DDP to auto activate cards at a future date

ON_ISSUANCE

Cards can be set to auto activate once the card number is assigned and sent for fulfillment to printer

ON_SHIPMENT

Cards can be set to auto activate upon shipment

PackagingType

Value

Description

PRODUCT_WITH_SLIP

A single non-card (e.g., product of type MERCHandise) shipped with a packing slip since non-card is not affixed to any carrier.

CARD_ON_CARRIER

A single card is affixed to a single carrier only

MULTI_CARD_ON_CARRIER

1 or more cards of the same order, destined to the same recipient may be affixed on a carrier to maximize shipping efficiencies supported at the FSP.

This is the default value for Direct 2 Consumer orders.

CARD_ON_CARRIER_WITH_SLIP

For order that contain multiple cards (1 or more) destined to the same recipient. Each card is affixed to a single carrier/envelope.

The individual envelopes are packaged together (in sequence) with a ‘bulk’ packing slip.

CARD_ONLY_WITH_SLIP

Similar to CARDONCARRIERWITHSLIP.

For order that contain multiple cards (1 or more) destined to the same recipient. Each card is NOT affixed to any carrier. Instead, the individual cards are packaged together (in sequence) with a ‘bulk’ packing slip.

MULTI_CARD_ON_CARRIER_WITH_SLIP

RESERVED FOR FUTURE.

digitalDistributionChannel

Value

Description

EMAIL

eGift will be delivered to the email provided in Order Request

NONE

The eGiftID will be created with no email delivery

Member

Name

Type

Required

Description

monthAccountAge

Integer

C

Time since the user created the account in months

NumOfCardholders

Integer

C

Number of additional cardholders

creditLimitUtilization

Decimal

C

Percentage of credit limit utilized

Device

Name

Type

Required

Description

identifier

String

C

In the case of Trustev as RiskProvider, device session ID would be String value and in the case of other providers, for example, Iovation, String value can be an encrypted payload

ipAddress

String

C

IP Address for the transaction

referringUrl

String

C

URL referred, wrapped in CDATA

browserLanguage

String

C

Browser Language

RewardPoints

Name

Type

Required

Description

totalPoints

Decimal

C

If reward points was used to make purchase, this indicates the total points redeemed for this purchase.

balance

Decimal

C

Current Rewards Points balance

totalAccumalated

Decimal

C

Max points ever accumulated by user

Login

Name

Type

Required

Description

hoursSincePreviousSuccessfulLogin

Integer

C

Number of hours since previous successful login

hoursSinceLastFailedLogin

Integer

C

Number of hours since last failed login

failedLoginsInLast30Days

Integer

C

Number of failed logins in last 30 days

hoursSinceLastPasswordReset

Integer

C

Number of hours since password was last reset

hoursSinceLastPhoneNumberUpdate

Integer

C

Number of hours since accountholder phone number was updated

hoursSinceLastEmailAddressUpdate

Integer

C

Number of hours since accountholder email address was updated

hoursSinceLastShippingAddressUpdate

Integer

C

Number of hours since accountholder address was changed

secondsCurrentSessionLength

Integer

C

Session length: seconds since customer logged in for present session

boolMFAEnabled

Boolean

C

MFA: whether the account login is protected by two factor authentication

CreditCard

Name

Type

Required

Description

lastfour

Integer

C

Last four digit of card number

bin

String

C

bin

Response Elements

Name

Type

Max Length

Description

Notes

orderId

String

26

For future, do not consume it

fulfillmentOrderId

String

26

The unique id generated by BHN for each submitted order

Please persisted it in your system for future queries

receivedTimeStamp

DateTime

The order received timestamp

orderUri

uri

Link to the fulfillment order

For future, do not consume it

fulfillmentOrderUri

uri

Link to the fulfillment order

HTTP Response Codes

Success

HTTP Status Code

Description

201

Request was processed successfully and the response is returned

Error Codes

HTTP Status Code

Error Code

Error Message

Notes

400

total.item.quantity.required

Total item quantity is required. Please provide Total item quantity in itemQuantity and place the order again

400

item.denomination.required

Item denomination is required. Please provide Item denomination in itemDenomination and place the order again

400

shipping.info.required

Requested Ship Method is required. Please provide Shipping Method in requestedShipMethod and place the order again

400

partner.order.number.required

Partner Order Number is required.Please provide Partner Order Number in partnerOrderNumber and place the order again

400

partner.order.date.required

Partner Order Date is required.Please provide Partner Order Date in partnerOrderDate and place the order again

400

total.cards.required

Total Cards is required. Please provide Total Cards in totalOrderQuantity and place the order again

400

total.order.value.required

Total Order Value is required. Please provide Total Order Value in totalOrderValue and place the order again

400

billing.info.required

Billing info is required. Please provide Billing info in billingInfo and place the order again

400

order.line.required

Order need at least an item. Please provide atleast one lineitem and place the order again

403

not.authorized.to.access.resource

The requestor is not authorized to access the requested resource

404

404

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

URL incorrect

Sample Response-

HTTP/1.1 404

Date: Wed, 13 Jun 2018 21:59:33 GMT

Server: Apache

X-Application-Context: application,mongoTemplate,*:8443

Content-Type: application/hal+json;charset=UTF-8

Vary: Accept-Encoding

X-Frame-Options: SAMEORIGIN

X-Content-Type-Options: nosniff

BHN-TRACE-ID: WyGTxQq07EQAAG-ktckAAABK

Keep-Alive: timeout=5, max=100

Connection: Keep-Alive

Transfer-Encoding: chunked
{

"timestamp" : "2018-06-13T21:59:33.701+0000",

"status" : 404,

"error" : "Not Found",

"message" : "No message available",

"path" : "/orderservices/v1/fulfillment/order/ "

}

409

duplicate.order

previously used requestId found in the request

For duplicate externalOrderId/PONumber the existing Order details with same externalOrderId/PONumber will be returned

Sample Response-

HTTP/1.1 409

X-Application-Context: application,mongoTemplate,*:8443

Content-Type: application/json;charset=UTF-8

Content-Length: 526

Date: Mon, 04 Jun 2018 20:38:48 GMT
{

"orderId" : "NVNJ82YAF4ST921WM3ZBXTB2AC",

"fulfillmentOrderId" : "NVNJ82YAF4ST921WM3ZBXTB2AC",

"receivedTimeStamp" : "2018-06-04T17:47:43.816Z",

"orderUri" : "https://localhost:8443/orderservices/v1/fulfillmentorder/NVNJ82YAF4ST921WM3ZBXTB2AC",

"fulfillmentOrderUri" : "https://localhost:8443/orderservices/v1/fulfillmentorder/NVNJ82YAF4ST921WM3ZBXTB2AC",

"errorDetails" : {

"errorCode" : "duplicate.request",

"message" : "previously used partnerOrderNumber or partnerPONumber found in the request"

}

}

422

duplicate.order

previously used partnerOrderNumber or partnerPONumber found in the request

If the same requestId is used within 24 hrs, the response for the previous requestId if previous request was successful will be sent regardless of new externalOrderId/PONumber

Sample Response-

HTTP/1.1 422

X-Application-Context: application,mongoTemplate,*:8443

Content-Type: application/json;charset=UTF-8

Content-Length: 498

Date: Mon, 04 Jun 2018 20:38:17 GMT

{

"orderId" : "NVNJ82YAF4ST921WM3ZBXTB2AC",

"fulfillmentOrderId" : "NVNJ82YAF4ST921WM3ZBXTB2AC",

"receivedTimeStamp" : "2018-06-04T17:47:43.816Z",

"orderUri" : "https://localhost:8443/orderservices/v1/fulfillmentorder/NVNJ82YAF4ST921WM3ZBXTB2AC",

"fulfillmentOrderUri" : "https://localhost:8443/orderservices/v1/fulfillmentorder/NVNJ82YAF4ST921WM3ZBXTB2AC",

"errorDetails" : {

"errorCode" : "duplicate.request",

"message" : "previously used requestId found in the request"

}

}

500

500

Internal server error

Sample Response

HTTP/1.1 500
Date: Tue, 10 Mar 2020 17:48:28 GMT
Server: Apache
Content-Length: 61
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: text/html; charset=iso-8859-1
{
"errors": [
{
"errorCode": "Internal server error.",
"message": "Internal server error."
}
]
}

502

502

com.bhn.general.service.error

Sample Response-

HTTP/1.1 502 Proxy Error
Date: Tue, 10 Mar 2020 17:48:28 GMT
Server: Apache
Content-Length: 61
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: text/html; charset=iso-8859-1

{"errorCode":"502","message":"com.bhn.general.service.error"}

503

503

com.bhn.general.service.unavailable

{"errorCode":"503","message":"com.bhn.general.service.unavailable"}

504

504

com.bhn.general.service.timeout

Timeout will be thrown after 30 sec
{"errorCode":"504","message":"com.bhn.general.service.timeout"}

Sample Request and Response

PUT https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/ HTTP/1.1
Accept-Encoding: gzip,deflate
merchantId: 70300004232
requestId: A54CMCZZHM14RSSXCNFBYWKT7H
tenantId: TPSPVTQZYH5D143RTS5JS22BKW
Content-Type: application/json
Content-Length: 4215
Host: apiqa.blackhawknetwork.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/1.8.0_102)
 
{
   "partnerOrderNumber":"9000876792",
   "partnerOrderDate":"2018-03-08T18:55:55Z",
   "partnerPersonIdentifyingNumber":"43534534",
   "partnerMemoNotes":"Some memo notes greater than 20 characters",
   "partnerOrderVersion":"V1.0",
   "partnerPONumber":"test1234",
   "partnerCustomerIdentifier":"9999881",
   "loadValuePhase":"ON_DATE",
   "activationDate":"2018-03-20T05:00:00Z",
   "packagingType":"MULTI_CARD_ON_CARRIER",
   "totalOrderQuantity":8,
   "totalOrderValue":200,
   "billingInfo":{
      "billingEmailAddress":"[email protected]",
      "billingPersonId":"test1324",
      "billingAddress":{
         "attnTo":"You",
         "firstName":"John",
         "middleName":"R",
         "lastName":"Donovan",
         "company":"BHNetwork",
         "addressOne":"6220 Stoneridge Mall Rd",
         "addressTwo":"FL3",
         "addressThree":"Suite 50",
         "state":"CA",
         "zipCode":"94588",
         "city":"Pleasanton",
         "countryCode":"USA",
         "districtOrCounty":"Alameda",
         "phoneNumber":"9254449999"
      }
   },
   "otherInfo":{
      "otherInfo01":"test1",
      "otherInfo02":"test2"
   },
   "orderLineItems":[
      {
         "partnerOrderLineItemIdentifier":"100001",
         "bhnProductIID":"61072",
         "partnerSKU":"24553",
         "bhnSkuId":"K2S6W37LV2MP24D8XZ5PGPAAH4",
         "itemDenomination":25,
         "totalItemQuantity":4,
         "bomId":"BOM0000123",
         "cardPersonalization":{
            "nameOnCard":"Joe R Swagger",
            "messageOnCard":"Thank You",
            "line5":"testline5",
            "line6":"testline6"
         },
         "carrierPersonalization":{
            "personalMessage":"Best Wishes",
            "fromName":"me",
            "toName":"you",
            "customcarriermessage1":"25 dollars",
            "customcarriermessage2":"thank you"
         },
         "returnInfo":{
            "returnEmailAddress":"[email protected]",
            "returnPersonId":"22553333",
            "returnAddress":{
               "attnTo":"Joe",
               "firstName":"Joe",
               "middleName":"R",
               "lastName":"Swagger",
               "company":"BHN",
               "addressOne":"1234 Stoneridge Mall Rd",
               "addressTwo":"4th floor",
               "addressThree":"333",
               "state":"CA",
               "zipCode":"94588",
               "city":"Pleasanton",
               "countryCode":"USA",
               "phoneNumber":"9252261234",
               "districtOrCounty":"Alameda"
            }
         },
         "shippingInfo":{
            "shippingEmailAddress":"[email protected]",
            "shippingPersonId":"22553333",
            "shippingAddress":{
               "attnTo":"Joe",
               "firstName":"Joe",
               "middleName":"R",
               "lastName":"Swagger",
               "company":"BHN",
               "addressOne":"1234 Stoneridge Mall Rd",
               "addressTwo":"4th floor",
               "addressThree":"333",
               "state":"CA",
               "zipCode":"94588",
               "city":"Pleasanton",
               "countryCode":"USA",
               "phoneNumber":"9252261234",
               "districtOrCounty":"Alameda"
            },
            "requestedShipMethod":"upsground",
            "courierShippingAccountNumber":"224233"
         },
         "registerInfo":{
            "registerEmailAddress":"[email protected]",
            "registerPersonId":"57744443",
            "registerAddress":{
               "attnTo":"You",
               "firstName":"Joe",
               "middleName":"R",
               "lastName":"Swagger",
               "company":"BHN",
               "addressOne":"1234 Stoneridge Mall Rd",
               "addressTwo":"4th floor",
               "addressThree":"333",
               "state":"CA",
               "zipCode":"94588",
               "city":"Pleasanton",
               "countryCode":"USA",
               "phoneNumber":"9252261234",
               "districtOrCounty":"Alameda"
            }
         },
         "fulfillmentInstructions":"test14324325",
         "expediteFulfillment":false,
         "partnerTrackingNumber":"325353463",
         "partnerProxyCardnumber":"4534643646464644",
         "partnerCampaignId":"testcampaign"
      },
      {
         "partnerOrderLineItemIdentifier":"100002",
         "bhnProductIID":"61072",
         "partnerSKU":"24553",
         "bhnSkuId":"K2S6W37LV2MP24D8XZ5PGPAAH4",
         "itemDenomination":25,
         "totalItemQuantity":4,
         "bomId":"BOM0000123",
         "cardPersonalization":{
            "nameOnCard":"Joe R Swagger",
            "messageOnCard":"Thank You",
            "line5":"testline5",
            "line6":"testline6"
         },
         "carrierPersonalization":{
            "personalMessage":"Best Wishes",
            "fromName":"me",
            "toName":"you",
            "customcarriermessage1":"25 dollars",
            "customcarriermessage2":"thank you"
         },
         "returnInfo":{
            "returnEmailAddress":"[email protected]",
            "returnPersonId":"22553333",
            "returnAddress":{
               "attnTo":"Joe",
               "firstName":"Joe",
               "middleName":"R",
               "lastName":"Swagger",
               "company":"BHN",
               "addressOne":"1234 Stoneridge Mall Rd",
               "addressTwo":"4th floor",
               "addressThree":"333",
               "state":"CA",
               "zipCode":"94588",
               "city":"Pleasanton",
               "countryCode":"USA",
               "phoneNumber":"9252261234",
               "districtOrCounty":"Alameda"
            }
         },
         "shippingInfo":{
            "shippingEmailAddress":"[email protected]",
            "shippingPersonId":"22553333",
            "shippingAddress":{
               "attnTo":"Joe",
               "firstName":"Joe",
               "middleName":"R",
               "lastName":"Swagger",
               "company":"BHN",
               "addressOne":"1234 Stoneridge Mall Rd",
               "addressTwo":"4th floor",
               "addressThree":"333",
               "state":"CA",
               "zipCode":"94588",
               "city":"Pleasanton",
               "countryCode":"USA",
               "phoneNumber":"9252261234",
               "districtOrCounty":"Alameda"
            },
            "requestedShipMethod":"upsground",
            "courierShippingAccountNumber":"224233"
         },
         "registerInfo":{
            "registerEmailAddress":"[email protected]",
            "registerPersonId":"57744443",
            "registerAddress":{
               "attnTo":"You",
               "firstName":"Joe",
               "middleName":"R",
               "lastName":"Swagger",
               "company":"BHN",
               "addressOne":"1234 Stoneridge Mall Rd",
               "addressTwo":"4th floor",
               "addressThree":"333",
               "state":"CA",
               "zipCode":"94588",
               "city":"Pleasanton",
               "countryCode":"USA",
               "phoneNumber":"9252261234",
               "districtOrCounty":"Alameda"
            }
         },
         "fulfillmentInstructions":"test14324325",
         "expediteFulfillment":false,
         "partnerTrackingNumber":"325353463",
         "partnerProxyCardnumber":"4534643646464644",
         "partnerCampaignId":"testcampaign"
      }
   ]
}
HTTP/1.1 201
Date: Wed, 28 Mar 2018 06:12:24 GMT
Server: Apache
X-Application-Context: application,mongoTemplate,*:8443
Content-Type: application/json;charset=UTF-8
Content-Length: 326
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
BHN-TRACE-ID: WrsySAq06-gAAFmQvEkAAABE
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
 
{
  "orderId" : "J4YGFZH40NQXNJRCWDAN27K7XC",
  "fulfillmentOrderId" : "J4YGFZH40NQXNJRCWDAN27K7XC",
  "receivedTimeStamp" : "2018-03-28T06:12:24.614Z",
  "orderUri" : "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/J4YGFZH40NQXNJRCWDAN27K7XC"
  "fulfillmentOrderUri" : "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/J4YGFZH40NQXNJRCWDAN27K7XC"
}
HTTP/1.1 422
Date: Wed, 28 Mar 2018 06:15:57 GMT
Server: Apache
X-Application-Context: application,mongoTemplate,*:8443
Content-Type: application/json;charset=UTF-8
Content-Length: 326
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
BHN-TRACE-ID: WrszHQq06-gAAF1iq8IAAABV
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
 
{
  "orderId" : "J4YGFZH40NQXNJRCWDAN27K7XC",
  "fulfillmentOrderId" : "J4YGFZH40NQXNJRCWDAN27K7XC",
  "receivedTimeStamp" : "2018-03-28T06:12:24.614Z",
  "orderUri" : "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/J4YGFZH40NQXNJRCWDAN27K7XC"
  "fulfillmentOrderUri" : "https://api.blackhawknetwork.com/orderservices/v1/fulfillmentorder/J4YGFZH40NQXNJRCWDAN27K7XC"
  "errorDetail" : [
    {
      "errorCode" : "duplicate.request",
      "message" : "previosuly used requestId found in the request"
    }
 
 }
 
  
HTTP/1.1 400
Date: Thu, 08 Mar 2018 00:21:42 GMT
Server: Apache
X-Application-Context: application,mongoTemplate,*:8443
Content-Type: application/json;charset=UTF-8
Content-Length: 195
X-Frame-Options: SAMEORIGIN
X-Content-Type-Options: nosniff
BHN-TRACE-ID: WqCCFgq06RgAAGHXuzoAAAAf
Connection: close
{
  "errors" : [
    {
      "errorCode" : "Internal.server.error.",
      "message" : "com.bhn.webservice.exceptions.InvalidRequestException: The request that was sent is not valid."
    }
  ]
}
{
   "partnerOrderNumber" : "234203797914149673759",
   "partnerOrderDate" : "2018-03-08T18:55:55Z",
   "partnerPONumber" : "PONumber1234",
   "partnerCustomerIdentifier" : "",
   "loadValuePhase" : "ON_DATE",
   "activationDate" : "2018-03-20T05:00:00Z",
   "packagingType" : "CARD_ON_CARRIER",
   "totalOrderQuantity" : "1",
   "totalOrderValue" : "25",
   "bhnOrderType":"CUSTOMER",
   "billingInfo" : {
      "billingEmailAddress" : "[email protected]",
      "billingPersonId" : "BillingPersonId",
      "billingAddress" : {
         "attnTo" : "You",
         "firstName" : "Joe",
         "middleName" : "M",
         "lastName" : "Smith",
         "company" : "BHN",
         "addressOne" : "6220 Stoneridge Mall Rd",
         "addressTwo" : "FL3",
         "addressThree" : "Suite 50",
         "state" : "CA",
         "zipCode" : "94566",
         "city" : "Pleasanton",
         "countryCode" : "USA",
         "districtOrCounty" : "Alameda",
         "phoneNumber" : "3589375"
      }
   },
   "otherInfo" : {
      "otherInfo01" : "test1",
      "otherInfo02" : "test2"
   },
   "orderLineItems" : [
      {
         "partnerOrderLineItemIdentifier" : "100001",
         "bhnProductIID" : "77007",
         "bhnProductUPC" : "88846255120",
         "bhnSkuId" : "",
         "partnerSKU" : "37284",
         "itemDenomination" : "25",
         "totalItemQuantity" : "1",
         "cardPersonalization" : {
            "nameOnCard" : "Mansha",
            "messageOnCard" : "Thank You",
            "line5" : "testline5",
           "line6" : "testline6"
         },
         "carrierPersonalization" : {
            "personalMessage" : "Best Wishes",
            "fromName" : "me",
            "toName" : "you",
            "customcarriermessage1" : "25 dollars",
            "customcarriermessage2" : "thank you"
         },
         "returnInfo" : {
            "returnEmailAddress" : "[email protected]",
            "returnPersonId" : "68356348",
            "returnAddress" : {
               "attnTo" : "Joe",
               "firstName" : "Joe",
               "middleName" : "N",
               "lastName" : "Black",
               "company" : "Blackhawk",
               "addressOne" : "1234 Stoneridge Mall Rd",
               "addressTwo" : "4th floor",
               "addressThree" : "333",
               "state" : "CA",
               "zipCode" : "94566",
               "city" : "Pleasanton",
               "countryCode" : "USA",
               "phoneNumber" : "4738653845",
               "districtOrCounty" : "Alameda"
            }
         },
         "shippingInfo" : {
            "shippingEmailAddress" : "[email protected]",
            "shippingPersonId" : "26387426",
            "shippingAddress" : {
               "attnTo" : "Joe",
               "firstName" : "Joe",
               "middleName" : "R",
               "lastName" : "Swagger",
               "company" : "BHn",
               "addressOne" : "1234 Stoneridge Mall Rd",
               "addressTwo" : "4th floor",
               "addressThree" : "333",
               "state" : "CA",
               "zipCode" : "94566",
               "city" : "Pleasanton",
               "countryCode" : "USA",
               "phoneNumber" : "262734",
               "districtOrCounty" : "Alameda"
            },
            "requestedShipMethod" : "upsground",
            "courierShippingAccountNumber" : "3849579384"
         },
         "registerInfo" : {
            "registerEmailAddress" : "[email protected]",
            "registerPersonId" : "57744443",
            "registerAddress" : {
               "attnTo" : "You",
               "firstName" : "Joe",
               "middleName" : "R",
               "lastName" : "Swagger",
               "company" : "BHN",
               "addressOne" : "1234 Stoneridge Mall Rd",
               "addressTwo" : "4th floor",
               "addressThree" : "333",
               "state" : "CA",
               "zipCode" : "94566",
               "city" : "Pleasanton",
               "countryCode" : "USA",
               "phoneNumber" : "236480000000",
               "districtOrCounty" : "Alameda"
            }
         },
         "fulfillmentInstructions" : "test14324325",
         "expediteFulfillment" : "false",
         "partnerTrackingNumber" : "23686345",
         "partnerProxyCardnumber" : "4534600000000000",
         "partnerCampaignId" : "testcampaign",
         "digitalDistributionChannel" : "NONE",
         "bomId":"BOM000016",
         "imageUrls":{
            "cardfront":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_13131_2017_10_05_12_10_24-jpg",
            "cardback":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_13131_2017_10_05_12_10_24-jpg",
            "carrier_p001":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39427_2016_09_28_08_37_27-jpg",
            "carrier_p002":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39430_2017_09_14_16_52_57-jpg",
            "carrier_p003":" https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39433_2016_09_28_08_37_30-jpg",
            "carrier_p004":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39436_2020_04_01_11_29_58-jpg",
            "packagingslip_p001":" https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39433_2016_09_28_08_37_30-jpg",
            "packagingslip_p002" :"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39436_2020_04_01_11_29_58-jpg",
            "marketinginsert_p001":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39430_2017_09_14_16_52_57-jpg",
            "marketinginsert_p002":"https~++6868b665d134d989a852%2D03d2f46595b2144e6b5a2cdc249f82e4-ssl-cf2-rackcdn-com+file_entry_id_39427_2016_09_28_08_37_27-jpg"
         },
         "additionalInfos":{
           "carrier_p001": "carrier_p001Value",
            "carrier_p002": "carrier_p002Value",
            "carrier_p003": "carrier_p003Value",
            "carrier_p004": "carrier_p004Value",
            "carrier_p005": "carrier_p005Value",
            "carrier_p006": "carrier_p006Value",
            "carrier_p007": "carrier_p007Value",
            "carrier_p008": "carrier_p008Value"
           
         }
      }
   ]
}
{
    "totalOrderQuantity": 1,
    "packagingType": "CARD_ON_CARRIER",
    "bhnOrderType": "CUSTOMER",
    "partnerPONumber" : "PONumber367281",
    "partnerCustomerIdentifier":"ORDERCENTRAL",
    "billingInfo": {
        "billingEmailAddress": "[email protected]",
        "billingAddress": {
            "firstName": "BHN",
            "lastName": "BHN",
            "company": "Reward and Rebate Center",
            "state": "CA",
            "city": "Crystal Lake",
            "countryCode": "USA"
        }
    },
    "partnerOrderNumber": "pad104S49601",
    "totalOrderValue": 25,
    "partnerOrderDate": "2018-10-01T17:14:57.000+0000",
     "riskAttributes":{
           "existingCustomer":true,
            "guestCheckout":true,
            "member":{
                   "monthAccountAge":123

                     },
            "rewardpoints":{
                   "balance":134
                     },
            "login":{
                   "hoursSincePreviousSuccessfulLogin":12,
                  "hoursSinceLastFailedLogin":11
                    },
          "device":{
              "browserLanguage":"English",
              "identifier":"qwer",
              "type":"IOVATION"
                  },
            "isSenior":34,
             "creditCard":{
                "lastfour":1234
                         }
                },
    "orderLineItems": [{
            "partnerOrderLineItemIdentifier": "139753996",
            "bhnProductIID":"74740",
            "itemDenomination": 25,
            "totalItemQuantity": 1,
            "bomId": "BOM000191",
            "returnInfo": null,
            "fulfillmentInstructions" :"To print the card;Follow the given instructions & proceed",
            "shippingInfo": {
               
                "requestedShipMethod": "usps1stclass",
                "shippingPersonId": null,
                "shippingEmailAddress" : "[email protected]",
                "shippingAddress": {
                    "firstName": "Jon",
                    "lastName": "Smith",
                    "addressOne": "addres6728341",
                    "company": "Blackhawk Network",
                    "phoneNumber":"5554127324",
                    "state": "CA",
                    "zipCode": "60039-0318",
                    "city": "Crystal Lake",
                    "countryCode": "USA"
                }
            },
             "carrierPersonalization" : {
                "personalMessage" : "Some personal Message",
                "fromName" : "Some From Name greator than 22 characters in length",
                "toName" : "Some To Name greator than 22 characters in length",
                "customcarriermessage1" : "Some custom carrier message1",
                "customcarriermessage2" : "Some custom carrier message2"
             },
            "imageUrls": {
                "cardfront": "https~++0b75ec214ae93c9cf0c4%2D29272cf50f31a51c962f720faccc5ec5-ssl-cf2-rackcdn-com/56777787",
                "cardback": "https~++0b75ec214ae93c9cf0c4%2D29272cf50f31a51c962f720faccc5ec5-ssl-cf2-rackcdn-com/56777787",
                "carrier_p001": "carrier_p001Value",
                "carrier_p002": "carrier_p002Value",
                "carrier_p003": "carrier_p003Value",
                "carrier_p004": "carrier_p004Value",
                "carrier_p005": "carrier_p005Value",
                "carrier_p006": "carrier_p006Value",
                "carrier_p007": "carrier_p007Value",
                "carrier_p008": "carrier_p008Value"
            },
            "additionalInfos": {
                "packagingslip_p001": "packagingslip_p001Value",
                "packagingslip_p002": "packagingslip_p002Value",
                "packagingslip_p003": "packagingslip_p003Value",
                "packagingslip_p004": "packagingslip_p004Value",
                "marketinginsert_p001": "marketinginsert_p001Value",
                "marketinginsert_p002": "marketinginsert_p002Value",
                "marketinginsert_p003": "marketinginsert_p003Value",
                "marketinginsert_p004": "marketinginsert_p004Value"
            },
            "registerInfo": {
                "registerPersonId": "637824235",
                "registerEmailAddress": "[email protected]",
                "registerAddress": {
                    "firstName": "Ma",
                    "lastName": "Saxen",
                    "addressOne": "Registered Address 1",
                    "company": "Registered Blackhawk Network",
                    "phoneNumber":"5554124724",
                    "state": "CA",
                    "zipCode": "236875",
                    "city": "Fremont",
                    "countryCode": "USA"
                }
            }
        }
       
    ]
}

Did this page help you?