Skip to main content

Bulk create transit passes

POST

https://api-v2.test.eldowallet.fr/transits/:transitId/passes/bulk

Processed asynchronously. Returns a bulk operation: track its status and results with GET /bulk-operations/{operationId}.

Good to know
  • The wallet must have the TRANSIT pass type enabled.

Request​

path parameters
  • transitId string required
    Transit template ID (`_id`).
header parameters
  • x-lang string
    Language for responses
    enum: en, frdefault: "en"
Body application/json required
  • webhookUrl string
    Optional webhook URL to receive notification when operation completes. Auth headers: append #headers=Authorization:Bearer%20token
    example: https://example.com/webhook#headers=Authorization:Bearer%20token
  • forceSync boolean
    Execute synchronously (max 1000 items). If true and items >= 1000, request is rejected.
    default: false
  • items object[] required
    Array of transit passes to create
    • departureDate string required
      ISO 8601 calendar date (YYYY-MM-DD)
      example: 2000-01-01
    • arrivalDate string required
      ISO 8601 calendar date (YYYY-MM-DD)
      example: 2000-01-01
    • departureTime string
      24-hour HH:mm
      pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$example: 00:00
    • arrivalTime string
      24-hour HH:mm
      pattern: ^([0-1][0-9]|2[0-3]):[0-5][0-9]$example: 01:00
    • originStationCode stringmaxLength: 3example: str
    • destinationStationCode stringmaxLength: 3example: str
    • expirationDate stringexample: 2000-01-01
    • flightNumber string
    • gate string
    • seat string
    • originName stringmaxLength: 13
    • destinationName stringmaxLength: 13
    • tripNumber string
    • tarif string
    • customBackFields object[]
      • key string
        Auto-generated server-side (slug derived from label + position index). Clients should NOT send this field — it is ignored and always regenerated.
      • label string required
      • value string required
      • type object required
    • enableSendEmailOrSms booleandefault: false
    • firstName string required
    • lastName string required
    • email string <email> required
    • phoneNumber string
    • barcode string
  • enableSendEmailOrSms boolean required
    Whether to send email or SMS notifications
    example: true

Responses​

Schema application/json
  • operationId string required
    Unique identifier for the bulk operation
    example: 507f1f77bcf86cd799439011
  • totalItems number required
    Total number of items in the operation
    example: 100
  • successCount number required
    Number of successfully processed items
    example: 95
  • failureCount number required
    Number of failed items
    example: 5
  • status string required
    Current status of the operation
    enum: pending, processing, completed, failedexample: pending
    • operationErrors object[]
      Array of errors for failed items
      • itemId string required
        ID of the item that failed
        example: 507f1f77bcf86cd799439011
      • message string required
        Error message
        example: Client not found
      • code string
        Error code if available
        example: 404:MODEL_NOT_FOUND
    • results object[]
      Array of results for successful items
      • itemId string required
        ID of the item
        example: 507f1f77bcf86cd799439011
      • result object
        Result data
    • createdAt string <date-time> required
      Timestamp when the operation was created
      example: 2024-01-01T00:00:00.000Z
    • completedAt string <date-time>
      Timestamp when the operation was completed
      example: 2024-01-01T00:05:00.000Z

    API news, once a month

    New endpoints, upcoming changes, guides and use cases. No spam, one-click unsubscribe.

    Report a technical problem

    An API error, a pass that does not update, an email that does not arrive? Describe the problem: our technical team will answer.

    For a fast answer, include:

    • The method and endpoint (e.g. POST /clients)
    • The error code returned (errorCode) and the body sent
    • The date and time of the call
    • The identifiers involved (customer, template, pass)

    Never include an API token or a password.

    AI assistant

    Beta

    Loading…

    AI-generated answers (Claude): double-check important details.

    Sign in to use the assistant