LIlightspeed
ID Cards

Create an ID Card Batch

Changed on

Creates a new batch of ID cards for a specific business location.

post/id-cards/v1/business-locations/{businessLocationId}/batches

Request

  • Base URL
    https://api.trial.lsk.lightspeed.app
  • URL
    https://api.trial.lsk.lightspeed.app/id-cards/v1/business-locations/{businessLocationId}/batches
  • Auth
    OAuth 2
    Authorization code: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/auth
    Token URL: https://auth.lsk-prod.app/realms/k-series/protocol/openid-connect/token scopes: id-cards

Path parameters

businessLocationIdinteger required

The unique identifier for the business location.

Request body

namestring required

The name of the ID card batch.

Example request

{
  "name": "Sample Batch Name"
}

Response

Successfully created an ID card batch.

batchIdinteger

The unique identifier for the ID card batch.

namestring

The name of the ID card batch.

businessLocationIdinteger

The unique identifier for the business location this batch belongs to.

Example response

{
  "batchId": 12345,
  "businessLocationId": 67890
}

Changes