Create bulk order

Create a New Bulk Order for Physical Card Shipments

Request to create a new bulk order for physical card shipments. Please work with your Customer Success Manager and card personalization bureau to ensure bulk shipping is supported for your program.

Schema Definitions

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.
  • Valid options:
    BULK_EXPEDITED, BULK_PRIORITY, BULK_2_DAY, BULK_EXPRESS

customer_product_id

• string
  • required
  • Customer-specified product configuration for physical card manufacturing. This must be configured with Lithic before use.

Response Objects

201 Created

• 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. Valid options: OPEN, LOCKED

shipping_address

• object
  • required
  • Shipping address for all cards in this bulk order

shipping_method

• string
  • enum
  • required
  • Valid options: BULK_EXPEDITED, BULK_PRIORITY, BULK_2_DAY, BULK_EXPRESS

customer_product_id

• string | null
  • required
  • Customer-specified product configuration for physical card manufacturing.

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

Example Request

curl --request POST \
     --url https://sandbox.lithic.com/v1/card_bulk_orders \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
  "shipping_address": {
    "address1": "123 Main Street",
    "city": "NEW YORK",
    "country": "USA",
    "first_name": "Johnny",
    "last_name": "Appleseed",
    "postal_code": 10001,
    "state": "NY"
  },
  "shipping_method": "BULK_EXPEDITED",
  "customer_product_id": "custom-card-design-123"
}'

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"
}