Get bulk order
Bulk Order Token
Overview
200 OK
- object
Represents a bulk order for physical card shipments
Fields
token
uuid(required)
Globally unique identifier for the bulk order
status
string(required)
Status of the bulk order.OPENindicates the order is accepting cards.LOCKEDindicates the order is finalized and no more cards can be added.
Possible values:OPEN,LOCKED
shipping_address
object(required)
Shipping address for all cards in this bulk order.
Has additional fields
shipping_method
string(required)
Shipping method for all cards in this bulk order.
Possible values:BULK_EXPEDITED,BULK_PRIORITY,BULK_2_DAY,BULK_EXPRESS
customer_product_id
string | null(required)
Customer-specified product configuration for physical card manufacturing. This must be configured with Lithic before use.
card_tokens
array of uuids(required)
List of card tokens associated with this bulk order.
created
date-time(required)
An RFC 3339 timestamp for when the bulk order was created. UTC time zone.
updated
date-time(required)
An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone.
Error Codes
401 Unauthorized
| Code | Message |
|---|---|
| User has not been authenticated | Invalid or missing API key |
| API key is not active | The API key used is no longer active |
| Could not find API key | The API key provided is not associated with any user |
| Please provide API key in Authorization header | The Authorization header is not in the request |
| Please provide API key in the form Authorization: [api-key] | The Authorization header is not formatted properly |
| Insufficient privileges. Issuing API key required | Write access requires an Issuing API key. Reach out at lithic.com/contact |
| Insufficient privileges to create virtual cards. | Creating virtual cards requires an additional privilege |
404 Not Found
- The specified resource was not found.
429 Too Many Requests
| Code | Message |
|---|---|
| Rate limited, too many requests per second | User has exceeded their per second rate limit |
| Rate limited, reached daily limit | User has exceeded their daily rate limit |
| Rate limited, too many keys tried | One IP has queried too many different API keys |
Example API Call
curl --request GET \
--url https://sandbox.lithic.com/v1/card_bulk_orders/bulk_order_token \
--header 'accept: application/json'
Example Response
{
"token": "7ef7d65c-9023-4da3-b113-3b8583fd7951",
"status": "OPEN",
"shipping_address": {},
"shipping_method": "BULK_EXPEDITED",
"customer_product_id": "custom-card-design-123",
"card_tokens": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
],
"created": "2021-06-28T22:53:15Z",
"updated": "2021-06-28T22:53:15Z"
}