Get the status of a bulk operation

GET

https://api-v2.test.eldowallet.fr/bulk-operations/:operationId

Returns the progress and results of a bulk operation started by your wallet (bulk send, update or delete). Poll this route with the operationId returned at launch until status is completed or failed.

Good to know

• status goes from pending to processing, then completed or failed. completed does not mean every item succeeded: check failureCount and operationErrors. If you passed a webhookUrl at launch, it is called when the operation reaches completed.

Request

path parameters

• operationId string required
  Unique identifier for the bulk operation (MongoDB _id)
  example: 507f1f77bcf86cd799439011

header parameters

• x-lang string
  Language for responses
  enum: en, frdefault: "en"

Responses

200

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

401

UNAUTHORIZED

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

403

FORBIDDEN

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email

500

UNKNOWN_ERROR

Schema application/json

• message string requiredexample: Promo code already exists
• errorCode string requiredexample: 400:PROMO_CODE_ALREADY_EXISTS
• path string requiredexample: /coupons
• date string <date-time> required
• details object
• validationErrors object[]
  • field stringexample: email
  • message stringexample: email must be an email