Card Bulk Orders

Update bulk order

Changed on

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

patch/v1/card_bulk_orders/{bulk_order_token}

Request

  • Base URL
    https://sandbox.lithic.com
  • URL
    https://sandbox.lithic.com/v1/card_bulk_orders/{bulk_order_token}
  • Auth
    API key in header Authorization

Path parameters

bulk_order_tokenstring uuid required

Globally unique identifier for the bulk order

Request body

status'LOCKED' required

Status to update the bulk order to. Use LOCKED to finalize the order

Response

OK

tokenstring uuid required

Globally unique identifier for the bulk order

status'OPEN' | 'LOCKED' 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_addressobject required

Shipping address for all cards in this bulk order

shipping_method'BULK_EXPEDITED' | 'BULK_PRIORITY' | 'BULK_2_DAY' | 'BULK_EXPRESS' 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_idstring nullable required

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

card_tokensstring[] required

List of card tokens associated with this bulk order

createdstring date-time required

An RFC 3339 timestamp for when the bulk order was created. UTC time zone

updatedstring date-time required

An RFC 3339 timestamp for when the bulk order was last updated. UTC time zone

Example response

{
  "token": "7ef7d65c-9023-4da3-b113-3b8583fd7951",
  "customer_product_id": "custom-card-design-123",
  "created": "2021-06-28T22:53:15Z",
  "updated": "2021-06-28T22:53:15Z"
}

Changes

  • eb2cf51467f5Revision changes
    • warning

      added the new BULK_2_DAY enum value to the response property for the response status

    • warning

      added the new BULK_EXPRESS enum value to the response property for the response status

    • warning

      added the new BULK_PRIORITY enum value to the response property for the response status