Bulk Order Token

Request to Update a Bulk Order

This request is primarily to lock the bulk order.

Parameters

• uuid (required)
  Globally unique identifier for the bulk order

• status (string, enum, required)
  Status to update the bulk order to. Use LOCKED to finalize the order.

  • Allowed values: LOCKED

Response Codes

• 200 OK
  Represents a bulk order for physical card shipments.

Fields

• 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. Has additional fields.

• shipping_method (string, enum, required)
  Shipping method for all cards in this bulk order.

  • Allowed 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

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

• 401
  User has not been authenticated:

  • Invalid or missing API key
  • API key is not active
  • Could not find API key
  • Insufficient privileges. Issuing API key required.

• 404
  The specified resource was not found.

• 429
  Client has exceeded the number of allowed requests in a given time period.

Example Request

curl --request PATCH \
     --url https://sandbox.lithic.com/v1/card_bulk_orders/bulk_order_token \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{"status":"LOCKED"}'

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