Guides

3. Place order

Suggest Edits

Now you are ready to place your first order.

📘

From the previous 2 sections you should now have

  • Your access token from step 1
  • The product_id that you are ready to order from step 2

Here is a sample request for your first digital order.

TryNow!

Request

curl --request POST \
     --url https://api-sandbox.blackhawknetwork.com/v3/orders \
     --header 'accept: application/json' \
     --header 'authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICJFMWtoeW9Wb3dpVVhTbV9WRWtBYzNNWFlOUHN3dldOWEpLN0M1ZHlXTXVVIn0.eyJleHAiOjE3MTU0MDk2MTcsImlhdCI6MTcxNTQwNjAxNywianRpIjoiMWI0NzUxMzgtMWNlZC00ODIzLTg5MjQtNWE5YzVmZDc5MWRiIiwiaXNzIjoiaHR0cHM6Ly9pZGVudGl0eS1wcC5ibGFja2hhd2tuZXR3b3JrLmNvbS9yZWFsbXMvZGV2LWV4cGVyaWVuY2UiLCJhdWQiOlsiYmxvb20tYXBwbGljYXRpb24iLCJhY2NvdW50Il0sInN1YiI6ImUxNDYwNWUwLTQyNWYtNDQwOS05NWNhLTJhOGQ2NjFlMDg5YiIsInR5cCI6IkJlYXJlciIsImF6cCI6ImRldi1jbGllbnQiLCJhY3IiOiIxIiwiYWxsb3dlZC1vcmlnaW5zIjpbIi8qIl0sInJlYWxtX2FjY2VzcyI6eyJyb2xlcyI6WyJkZWZhdWx0LXJvbGVzLWRldi1leHBlcmllbmNlIiwib2ZmbGluZV9hY2Nlc3MiLCJ1bWFfYXV0aG9yaXphdGlvbiJdfSwicmVzb3VyY2VfYWNjZXNzIjp7ImJsb29tLWFwcGxpY2F0aW9uIjp7InJvbGVzIjpbInJlYWQiLCJjcmVhdGUiXX0sImFjY291bnQiOnsicm9sZXMiOlsibWFuYWdlLWFjY291bnQiLCJtYW5hZ2UtYWNjb3VudC1saW5rcyIsInZpZXctcHJvZmlsZSJdfX0sInNjb3BlIjoib3BlbmlkIHByb2ZpbGUgZW1haWwgY3VzdG9tLW1hcHBlciB0ZW5hbnRpZCIsImNsaWVudEhvc3QiOiIzNS4xNjUuMTcyLjE5NyIsImVtYWlsX3ZlcmlmaWVkIjpmYWxzZSwiY2F0YWxvZ2lkIjoiVFJBQ0NZN0tKUFFKNFdZMkEwR0tERllKV1IiLCJ0ZW5hbnRpZCI6IjNTNFFNTkREMktUTEZKQVNIWFFIQk1ISlBDIiwicHJlZmVycmVkX3VzZXJuYW1lIjoic2VydmljZS1hY2NvdW50LWRldi1jbGllbnQiLCJnaXZlbl9uYW1lIjoiIiwiY2xpZW50QWRkcmVzcyI6IjM1LjE2NS4xNzIuMTk3IiwiZmFtaWx5X25hbWUiOiIiLCJjbGllbnRfaWQiOiJkZXYtY2xpZW50In0.AIwqRxxr1N4oKbfwbtY4_zyTYKC_nHYTLVWXwUo_WEe5MBpEJrZmykWAQnNx24xz9jMhBY5KndC3Kha3BjAYFMIe6k4F1IZRxjN01Z9ps8IxIoRc0qj82IJ-8usazqs2NtzrA3bitU9XKpzYT1Vxus6vMTAd7fHRHpFtsnfEbnTG0CLH2UiSBv-1OhFHlQ3rT0QyIDy9Di3NdP14TI3_t8x_PpjWF9kCBM1EjXANvFmuHsdOn4JNBkBh99xN90mCmMvo3PCvojebsw33XwzrbMoMs5UB9o8SxrlkGdkmBin0648hCpqsGb38Ec7o3BQU59b3DW9ZdT4NEWCrz4pdpA' \
     --header 'content-type: application/json' \
     --header 'is_async: false' \
     --data '
{
  "locale": "en_US",
  "sender": {
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe"
  },
  "external_po_number": "test1714774665599",
  "external_id": "jr0510202412",
  "order_items": [
    {
      "product_id": "YnJuOmM6VFJBQ0NZN0tKUFFKNFdZMkEwR0tERllKV1I6aToxMDI3ODUw",
      "face_value": {
        "currency": "USD",
        "value": 10
      },
      "message": "Good vibes and wishes.",
      "quantity": 1,
      "receiver": {
        "email": "[email protected]",
        "first_name": "Tom",
        "last_name": "Doe"
      }
    }
  ]
}
'

Response

{
  "id": "01HXK2NXHH2ZWSRM20SBB3ZK9R",
  "order_number": "9790-35153817-4393",
  "device_info": {},
  "create_date": "2024-05-11T05:40:42.684Z",
  "updated_date": "2024-05-11T05:40:43.958Z",
  "external_id": "jr0510202412",
  "locale": "en_US",
  "status": {
    "current_status": {
      "status": "FULFILLMENT_COMPLETED",
      "description": "FULFILLMENT_COMPLETED",
      "created_date": "2024-05-11T05:40:43.95763905Z"
    }
  },
  "price_summary": {
    "quantity": 1,
    "grand_total": {
      "value": 10,
      "currency": "USD"
    },
    "merchandise_total": {
      "value": 10,
      "currency": "USD"
    },
    "tax_summary": {
      "value": 0
    },
    "shipping_fee_summary": {
      "value": 0,
      "currency": "USD"
    },
    "fee_summary": {
      "value": 0
    },
    "fees": [],
    "taxes": [],
    "discounts": []
  },
  "order_items": [
    {
      "id": "01HXK2NXHH9AC8J55KPZW4GQPE",
      "product_id": "YnJuOmM6VFJBQ0NZN0tKUFFKNFdZMkEwR0tERllKV1I6aToxMDI3ODUw",
      "type": "DIGITAL",
      "quantity": 1,
      "product_name": "FISERV 2 - US",
      "product_description": "Digital Product Testing 02.03.16",
      "status": {
        "current_status": {
          "status": "FULFILLMENT_COMPLETED",
          "description": "FULFILLMENT_COMPLETED",
          "created_date": "2024-05-11T05:40:43.948714715Z"
        }
      },
      "face_value": {
        "value": 10,
        "currency": "USD"
      },
      "price_summary": {
        "quantity": 1,
        "grand_total": {
          "value": 10,
          "currency": "USD"
        },
        "merchandise_total": {
          "value": 10,
          "currency": "USD"
        }
      },
      "receiver": {
        "first_name": "Tom",
        "last_name": "Doe",
        "email": "[email protected]"
      },
      "message": "Good vibes and wishes.",
      "delivery": {
        "email": true,
        "sms": false,
        "whatsapp": false
      },
      "order_line_details": [
        {
          "reference": "2SZXWWR7PVRB5KCFB0SFSLL3JH",
          "status": "FULFILLMENT_COMPLETED",
          "created_date": "2024-05-11T05:40:43.942Z",
          "links": {
            "egift_url": "https://egift.certification.blackhawknetwork.com/egift?eid=2SZXWWR7PVRB5KCFB0SFSLL3JH&tid=3S4QMNDD2KTLFJASHXQHBMHJPC"
          }
        }
      ],
      "meta_data": {},
      "links": {
        "self": "orders/01HXK2NXHH2ZWSRM20SBB3ZK9R/orderlines/01HXK2NXHH9AC8J55KPZW4GQPE/details"
      }
    }
  ],
  "sender": {
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]"
  },
  "meta_data": {}
}

👍

Yay!!. You have now successfully placed your first order.

The order number is the reference to the order you have placed.

📘

The egift_url in the response is your gift.

Please refer to the detailed order specs to understand more about ordering.

Updated 9 months ago

What’s Next