Create ID Cards Beta

POST /id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards

Creates a specified number of ID cards for an existing ID card batch.

Path parameters

  • businessLocationId integer(int64) Required

    The unique identifier for the business location.

  • batchId integer(int64) Required

    The unique identifier for the ID card batch.

application/json

Body Required

  • cardCount integer(int32) Required

    The number of ID cards to create.

    Minimum value is 1, maximum value is 100.

Responses

  • 201 application/json

    Successfully created ID cards.

    Hide response attributes Show response attributes object
    • batchId integer(int64)

      The unique identifier for the batch the cards were added to.

    • cards array[object]
      Hide cards attributes Show cards attributes object
      • id integer(int64)

        The unique identifier for the ID card.

      • consumerRecordId integer(int64)

        The unique identifier for the associated consumer record.

      • consumerId integer(int64)

        The unique identifier for the associated consumer.

      • url string

        The URL for the QR code associated with the ID card.
POST /id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards 
curl \
 --request POST 'https://api.trial.lsk.lightspeed.app/id-cards/v1/business-locations/{businessLocationId}/batches/{batchId}/cards' \
 --header "Content-Type: application/json" \
 --data '{"cardCount":1}'
Request examples 
{
  "cardCount": 1
}
Response examples (201) 
{
  "batchId": 12345,
  "cards": [
    {
      "id": 98765,
      "consumerRecordId": 54321,
      "consumerId": 13579,
      "url": "https://example.com/id-cards/98765/qr-code"
    }
  ]
}