Lithic API Documentation | Card Bulk Orders

Card Bulk Orders

card_bulk_orders

Methods

List Bulk Orders -> CursorPage<

CardBulkOrder

get/v1/card_bulk_orders

List bulk orders for physical card shipments [BETA]

Create Bulk Order ->

CardBulkOrder

post/v1/card_bulk_orders

Create a new bulk order for physical card shipments [BETA]. Cards can be added to the order via the POST /v1/cards endpoint by specifying the bulk_order_token. Lock the order via PATCH /v1/card_bulk_orders/{bulk_order_token} to prepare for shipment. Please work with your Customer Success Manager and card personalization bureau to ensure bulk shipping is supported for your program.

Get Bulk Order ->

CardBulkOrder

get/v1/card_bulk_orders/{bulk_order_token}

Retrieve a specific bulk order by token [BETA]

Update Bulk Order ->

CardBulkOrder

patch/v1/card_bulk_orders/{bulk_order_token}

Update a bulk order [BETA]. Primarily used to lock the order, preventing additional cards from being added

path Parameters

bulk_order_token: string

(format: uuid)

Response fields

CardBulkOrder

Request example

curl https://api.lithic.com/v1/card_bulk_orders/$BULK_ORDER_TOKEN \
    -X PATCH \
    -H 'Content-Type: application/json' \
    -H "Authorization: $LITHIC_API_KEY" \
    -d '{
          "status": "LOCKED"
        }'

200Example

{
  "token": "7ef7d65c-9023-4da3-b113-3b8583fd7951",
  "card_tokens": [
    "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e"
  ],
  "created": "2021-06-28T22:53:15Z",
  "customer_product_id": "custom-card-design-123",
  "shipping_address": {},
  "shipping_method": "BULK_EXPEDITED",
  "status": "OPEN",
  "updated": "2021-06-28T22:53:15Z"
}

Domain types

CardBulkOrder = { token, card_tokens, created, 5 more... }

Represents a bulk order for physical card shipments