Home / Issuing / Issue Cards
Print Cards in Bulk
- A Highnote account
- An API key or the API Explorer
- A virtual card
Group physical card orders are used to request an order for several physical cards at once. Group physical card orders are:
- Packaged individually in a card carrier and shipped together in a single shipment
- Shipped to one location
Some use cases for group orders include prepaid cards, preprinted physical cards, and fleet cards you want to distribute in bulk.
The order lifecycle for group physical card orders is as follows:
- Create a group order
- Add payment cards to the group order
- Complete the order and send it to the vendor for printing
To start a group order, you can use the following CreatePhysicalCardGroupOrder mutation. When a group order is first created, it will have a status of NEW:
Use the following mutation to create a group physical card order with a validated shipping address:
Note: The maximum number of cards you may add to a single group order is 500.
After creating a group order, you can add payment cards to it. Use the PhysicalCardGroupOrder.id field in the createPhysicalCardGroupOrder response payload to ensure you add payment cards to the correct group order.
Refer to the following guidelines when adding payment cards to a group order:
- You may specify card personalization values or leave the payment cards blank with no personalization
- If your card mailer includes address information for each card, you can specify addresses for each mailer when adding cards to the group order
You can complete the order after adding payment cards to your group order. Once a group order is completed, Highnote sends the group order to your chosen card printer and notifies you of the shipping status.
The cards will be packed in individual envelopes with card carriers and sent to the destination set on the group order in one shipment. At this point, the group order will have a SENT_TO_PRINTER status.
Use the following mutation to completed a group order:
You can cancel a payment card's fulfillment to remove the physical card from a group order if the order status is still in the NEW state. Once the order status has transitioned from a NEW state, you can't remove a card from a group order.
Use the following mutation to remove a payment card from a group order:
Note: If you need to edit group order attributes such as shipping address, you will need to create a new group order.
Canceling a group order cancels the entire group order, including the fulfillment of all payment cards associated with it. Group orders can only be canceled in the NEW state.
Use the following mutation to cancel a group order:
Use the following query to find individual payment cards in a group order:
You can use the Highnote API to search for group card orders for status tracking or display order history on your website or application. You can narrow search results using filters.
The following sections provide an overview of searching for group card orders. For information on individual card orders, see Print Physical Cards.
Group card order filters allow you to narrow search results based on information related to group card orders. These filters include the following:
| Filter | Description |
|---|---|
cardProductId | Input to filter by the ID of your card product |
groupOrderId | Input to filter by the ID of the group order |
groupOrderState | Input to filter by physical card group order status |
shippingMethod | Input to filter by the shipping method of the group order |
createdAt | Input to filter by the creation date of the group order |
actualShipDateLocal | Input to filter by the actual shipping date of the group order; in YYYY-MM-DD format |
The following query is an example search query that returns group card orders for an organization, filtered using group card order filters:
Warning: The Highnote test environment lets you freely explore the platform features and functionality. It is intended for experimenting, building integrations, and training your team.
To ensure the security of your real-world data, do not enter production data in the test environment. Production data includes sensitive information like customer details, financial data, or personally identifiable information (PII).
Use only dummy or test data explicitly created for testing purposes in the test environment.
You can simulate group order fulfillment in the test environment without actually shipping cards. This is useful for simulating group order statuses and notifications.
You can use the mutations provided in this guide to create and complete a group order. A completed order will have a status of PENDING.
Use the following mutation to transition the group order to SENT_TO_PRINTER status:
Once the group order has been SENT_TO_PRINTER, you can change the status to APPROVED using the following mutation:
Note: For an overview of group order shipping methods, see Shipping Methods.
After a group order is approved, you can use the following mutation to transition to the SHIPPED status. The shipping method and tracking number (if available) will be returned in the response payload:
To design your system to handle failed Group Order shipments, you can simulate a status of SHIP_FAILED.