List bulk orders

API Pagination Parameters

date-time

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

ending_before

string A cursor representing an item's token before which a page of results should end. Used to retrieve the previous page of results before this item.

page_size

integer 1 to 100 Defaults to 50

Page size (for pagination).

starting_after

string A cursor representing an item's token after which a page of results should begin. Used to retrieve the next page of results after this item.

Response Codes

200 OK

object

data

array of objects

Required

data*

object Represents a bulk order for physical card shipments

token: uuid (required) - Globally unique identifier for the bulk order.
status: string (enum) (required) - Status of the bulk order. OPEN indicates the order is accepting cards. LOCKED indicates the order is finalized and no more cards can be added.
shipping_address: object (required) - Shipping address for all cards in this bulk order.
shipping_method: string (enum) (required) - Shipping method for all cards in this bulk order. BULK_PRIORITY, BULK_2_DAY, and BULK_EXPRESS are only available with Perfect Plastic Printing.
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.
has_more: boolean (required) - More data exists.

400 BAD REQUEST

A parameter in the query given in the request does not match the valid queries for the endpoint.

401 UNAUTHORIZED

Reason	Description
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

429 TOO MANY REQUESTS

Client has exceeded the number of allowed requests in a given time period. | Reason | Description | | --- | --- | | 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 |

Sample Request

curl --request GET \
     --url 'https://sandbox.lithic.com/v1/card_bulk_orders?page_size=50' \
     --header 'accept: application/json'

Sample Response

{
  "data": [
    {
      "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"
    }
  ],
  "has_more": true
}